Run bounded target-wide duplicate detection for one entity definition.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/entity/example/record-matching/run"), Content = new StringContent("{ \"ProfileId\": \"example\", \"ArchiveMode\": 0, \"Limit\": 1 }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/entity/example/record-matching/run';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"ProfileId":"example","ArchiveMode":0,"Limit":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/entity/example/record-matching/run \ --header 'Content-Type: application/json' \ --data '{ "ProfileId": "example", "ArchiveMode": 0, "Limit": 1 }'Fuzzy execution, comparison, readable-value, and 2,000-group response bounds fail without returning partial groups. Budget expiry returns HTTP 503; deterministic fuzzy bounds return HTTP 409.
Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Target entity definition identifier or key.
Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Profile, archive scope, and compatibility scan limit.
Request payload for a transient record-matching run. Limit bounds only target-wide and constructor scans; Details Page anchored matching ignores it and either returns the complete actor-visible exact/fuzzy result or a bounded error.
object
Optional matching profile identifier.
Target-wide scan limit. Ignored by Details Page anchored matching.
Request payload for a transient record-matching run. Limit bounds only target-wide and constructor scans; Details Page anchored matching ignores it and either returns the complete actor-visible exact/fuzzy result or a bounded error.
object
Optional matching profile identifier.
Target-wide scan limit. Ignored by Details Page anchored matching.
Request payload for a transient record-matching run. Limit bounds only target-wide and constructor scans; Details Page anchored matching ignores it and either returns the complete actor-visible exact/fuzzy result or a bounded error.
object
Optional matching profile identifier.
Target-wide scan limit. Ignored by Details Page anchored matching.
Responses
Section titled “Responses”OK
object
Transient result of a record-matching run. For Details Page anchored matching, TotalScannedRecords equals TotalVisibleRecords and ScanLimitReached is false; target-wide scans remain bounded and may be partial.
object
Compact record-matching profile used by lists and launch options.
object
Visible record candidate returned by the matching engine.
object
object
object
Complete actor-visible record count in the selected archive scope.
Records covered by the matching run.
Whether a target-wide scan stopped at its request limit.
Complete groups for anchored runs, or groups from the bounded target-wide scan.
One exact set or honest fuzzy pair produced by matching rules.
object
Stable group identifier derived from its canonical candidate set.
Highest effective exact or fuzzy rule score contributing to the group.
Rules that produced the exact set or canonical fuzzy pair.
Configured rule that contributed to a candidate group. Score is the effective score; ConfiguredScore preserves the profile score before fuzzy similarity.
object
Stable matching-rule identifier.
Portable technical rule key.
Current rule label.
Effective score after fuzzy similarity is applied.
Configured rule score before fuzzy similarity; null for legacy exact results.
Weighted similarity from zero through ten thousand basis points.
Readable matching-field reasons for the group.
Actor-safe field evidence for an exact-normalized match or fuzzy comparison. Fuzzy evidence exposes distance and settings but never raw or normalized matching values.
object
Stable matching-rule identifier.
Portable technical rule key.
Current rule label.
Stable matching field identifier.
Portable technical entity-field key.
Current actor-readable field label.
Actor-safe exact diagnostic; empty for fuzzy evidence.
Unicode-rune edit distance, or null for exact evidence.
Configured inclusive fuzzy threshold, or null for exact evidence.
Field similarity from zero through ten thousand basis points.
Configured fuzzy field weight, or null for exact evidence.
Candidates materialized in the current bounded response page.
Visible record candidate returned by the matching engine.
object
object
object
Complete candidate count when candidates are paged; otherwise null.
object
object
object
object
Example
{ "Data": { "Surface": 0, "Profile": { "TargetKind": 0, "ActionMode": 0 }, "Groups": [ { "ConfidenceBand": 0, "Reasons": [ { "Normalizer": 0, "ComparisonMode": 0, "FuzzyAlgorithm": 0, "DiacriticMode": 0, "TokenOrderMode": 0 } ], "GroupKind": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Transient result of a record-matching run. For Details Page anchored matching, TotalScannedRecords equals TotalVisibleRecords and ScanLimitReached is false; target-wide scans remain bounded and may be partial.
object
Compact record-matching profile used by lists and launch options.
object
Visible record candidate returned by the matching engine.
object
object
object
Complete actor-visible record count in the selected archive scope.
Records covered by the matching run.
Whether a target-wide scan stopped at its request limit.
Complete groups for anchored runs, or groups from the bounded target-wide scan.
One exact set or honest fuzzy pair produced by matching rules.
object
Stable group identifier derived from its canonical candidate set.
Highest effective exact or fuzzy rule score contributing to the group.
Rules that produced the exact set or canonical fuzzy pair.
Configured rule that contributed to a candidate group. Score is the effective score; ConfiguredScore preserves the profile score before fuzzy similarity.
object
Stable matching-rule identifier.
Portable technical rule key.
Current rule label.
Effective score after fuzzy similarity is applied.
Configured rule score before fuzzy similarity; null for legacy exact results.
Weighted similarity from zero through ten thousand basis points.
Readable matching-field reasons for the group.
Actor-safe field evidence for an exact-normalized match or fuzzy comparison. Fuzzy evidence exposes distance and settings but never raw or normalized matching values.
object
Stable matching-rule identifier.
Portable technical rule key.
Current rule label.
Stable matching field identifier.
Portable technical entity-field key.
Current actor-readable field label.
Actor-safe exact diagnostic; empty for fuzzy evidence.
Unicode-rune edit distance, or null for exact evidence.
Configured inclusive fuzzy threshold, or null for exact evidence.
Field similarity from zero through ten thousand basis points.
Configured fuzzy field weight, or null for exact evidence.
Candidates materialized in the current bounded response page.
Visible record candidate returned by the matching engine.
object
object
object
Complete candidate count when candidates are paged; otherwise null.
object
object
object
object
Example
{ "Data": { "Surface": 0, "Profile": { "TargetKind": 0, "ActionMode": 0 }, "Groups": [ { "ConfidenceBand": 0, "Reasons": [ { "Normalizer": 0, "ComparisonMode": 0, "FuzzyAlgorithm": 0, "DiacriticMode": 0, "TokenOrderMode": 0 } ], "GroupKind": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Transient result of a record-matching run. For Details Page anchored matching, TotalScannedRecords equals TotalVisibleRecords and ScanLimitReached is false; target-wide scans remain bounded and may be partial.
object
Compact record-matching profile used by lists and launch options.
object
Visible record candidate returned by the matching engine.
object
object
object
Complete actor-visible record count in the selected archive scope.
Records covered by the matching run.
Whether a target-wide scan stopped at its request limit.
Complete groups for anchored runs, or groups from the bounded target-wide scan.
One exact set or honest fuzzy pair produced by matching rules.
object
Stable group identifier derived from its canonical candidate set.
Highest effective exact or fuzzy rule score contributing to the group.
Rules that produced the exact set or canonical fuzzy pair.
Configured rule that contributed to a candidate group. Score is the effective score; ConfiguredScore preserves the profile score before fuzzy similarity.
object
Stable matching-rule identifier.
Portable technical rule key.
Current rule label.
Effective score after fuzzy similarity is applied.
Configured rule score before fuzzy similarity; null for legacy exact results.
Weighted similarity from zero through ten thousand basis points.
Readable matching-field reasons for the group.
Actor-safe field evidence for an exact-normalized match or fuzzy comparison. Fuzzy evidence exposes distance and settings but never raw or normalized matching values.
object
Stable matching-rule identifier.
Portable technical rule key.
Current rule label.
Stable matching field identifier.
Portable technical entity-field key.
Current actor-readable field label.
Actor-safe exact diagnostic; empty for fuzzy evidence.
Unicode-rune edit distance, or null for exact evidence.
Configured inclusive fuzzy threshold, or null for exact evidence.
Field similarity from zero through ten thousand basis points.
Configured fuzzy field weight, or null for exact evidence.
Candidates materialized in the current bounded response page.
Visible record candidate returned by the matching engine.
object
object
object
Complete candidate count when candidates are paged; otherwise null.
object
object
object
object
Example
{ "Data": { "Surface": 0, "Profile": { "TargetKind": 0, "ActionMode": 0 }, "Groups": [ { "ConfidenceBand": 0, "Reasons": [ { "Normalizer": 0, "ComparisonMode": 0, "FuzzyAlgorithm": 0, "DiacriticMode": 0, "TokenOrderMode": 0 } ], "GroupKind": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Transient result of a record-matching run. For Details Page anchored matching, TotalScannedRecords equals TotalVisibleRecords and ScanLimitReached is false; target-wide scans remain bounded and may be partial.
object
Compact record-matching profile used by lists and launch options.
object
Visible record candidate returned by the matching engine.
object
object
object
Complete actor-visible record count in the selected archive scope.
Records covered by the matching run.
Whether a target-wide scan stopped at its request limit.
Complete groups for anchored runs, or groups from the bounded target-wide scan.
One exact set or honest fuzzy pair produced by matching rules.
object
Stable group identifier derived from its canonical candidate set.
Highest effective exact or fuzzy rule score contributing to the group.
Rules that produced the exact set or canonical fuzzy pair.
Configured rule that contributed to a candidate group. Score is the effective score; ConfiguredScore preserves the profile score before fuzzy similarity.
object
Stable matching-rule identifier.
Portable technical rule key.
Current rule label.
Effective score after fuzzy similarity is applied.
Configured rule score before fuzzy similarity; null for legacy exact results.
Weighted similarity from zero through ten thousand basis points.
Readable matching-field reasons for the group.
Actor-safe field evidence for an exact-normalized match or fuzzy comparison. Fuzzy evidence exposes distance and settings but never raw or normalized matching values.
object
Stable matching-rule identifier.
Portable technical rule key.
Current rule label.
Stable matching field identifier.
Portable technical entity-field key.
Current actor-readable field label.
Actor-safe exact diagnostic; empty for fuzzy evidence.
Unicode-rune edit distance, or null for exact evidence.
Configured inclusive fuzzy threshold, or null for exact evidence.
Field similarity from zero through ten thousand basis points.
Configured fuzzy field weight, or null for exact evidence.
Candidates materialized in the current bounded response page.
Visible record candidate returned by the matching engine.
object
object
object
Complete candidate count when candidates are paged; otherwise null.
object
object
object
object
Example
{ "Data": { "Surface": 0, "Profile": { "TargetKind": 0, "ActionMode": 0 }, "Groups": [ { "ConfidenceBand": 0, "Reasons": [ { "Normalizer": 0, "ComparisonMode": 0, "FuzzyAlgorithm": 0, "DiacriticMode": 0, "TokenOrderMode": 0 } ], "GroupKind": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Service Unavailable
object
Transient result of a record-matching run. For Details Page anchored matching, TotalScannedRecords equals TotalVisibleRecords and ScanLimitReached is false; target-wide scans remain bounded and may be partial.
object
Compact record-matching profile used by lists and launch options.
object
Visible record candidate returned by the matching engine.
object
object
object
Complete actor-visible record count in the selected archive scope.
Records covered by the matching run.
Whether a target-wide scan stopped at its request limit.
Complete groups for anchored runs, or groups from the bounded target-wide scan.
One exact set or honest fuzzy pair produced by matching rules.
object
Stable group identifier derived from its canonical candidate set.
Highest effective exact or fuzzy rule score contributing to the group.
Rules that produced the exact set or canonical fuzzy pair.
Configured rule that contributed to a candidate group. Score is the effective score; ConfiguredScore preserves the profile score before fuzzy similarity.
object
Stable matching-rule identifier.
Portable technical rule key.
Current rule label.
Effective score after fuzzy similarity is applied.
Configured rule score before fuzzy similarity; null for legacy exact results.
Weighted similarity from zero through ten thousand basis points.
Readable matching-field reasons for the group.
Actor-safe field evidence for an exact-normalized match or fuzzy comparison. Fuzzy evidence exposes distance and settings but never raw or normalized matching values.
object
Stable matching-rule identifier.
Portable technical rule key.
Current rule label.
Stable matching field identifier.
Portable technical entity-field key.
Current actor-readable field label.
Actor-safe exact diagnostic; empty for fuzzy evidence.
Unicode-rune edit distance, or null for exact evidence.
Configured inclusive fuzzy threshold, or null for exact evidence.
Field similarity from zero through ten thousand basis points.
Configured fuzzy field weight, or null for exact evidence.
Candidates materialized in the current bounded response page.
Visible record candidate returned by the matching engine.
object
object
object
Complete candidate count when candidates are paged; otherwise null.
object
object
object
object
Example
{ "Data": { "Surface": 0, "Profile": { "TargetKind": 0, "ActionMode": 0 }, "Groups": [ { "ConfidenceBand": 0, "Reasons": [ { "Normalizer": 0, "ComparisonMode": 0, "FuzzyAlgorithm": 0, "DiacriticMode": 0, "TokenOrderMode": 0 } ], "GroupKind": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}