Skip to content

Retry one actor-owned failed or cancelled full scan as a new durable job.

POST
/api/workspace/entity/{entityIdOrKey}/record-matching/full-scans/{jobId}/retry
curl --request POST \
--url https://example.com/api/workspace/entity/example/record-matching/full-scans/example/retry

Retry captures a new authoritative actor/profile/definition proof and creates a new job; the previous terminal job remains immutable until retention cleanup.

  • None
entityIdOrKey
required
string

Target entity definition identifier or key.

jobId
required
string

Persisted failed or cancelled job identifier.

access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Accepted

Media typeapplication/json
object
Data

Status and actor-owned progress of one durable full target-wide matching scan.

object
Id

Stable persisted job identifier.

string
nullable
Status
integer format: int32
Allowed values: 0 1 2 3 4
Phase
integer format: int32
Allowed values: 0 1 2 3 4
Profile

Compact record-matching profile used by lists and launch options.

object
Id
string
nullable
Name
string
nullable
Key
string
nullable
Enabled
boolean
TargetKind
integer format: int32
Allowed values: 0
TargetEntityDefinitionId
string
nullable
TargetEntityName
string
nullable
TargetEntityDisplayName
string
nullable
ShowOnTablePage
boolean
ShowOnDetailsPage
boolean
ActionMode
integer format: int32
Allowed values: 0
MinimumScore
integer format: int32
MediumConfidenceThreshold
integer format: int32
HighConfidenceThreshold
integer format: int32
RuleCount
integer format: int32
RowVersion
string format: uuid
ArchiveMode
integer format: int32
Allowed values: 0 1 2
TotalVisibleRecords

Complete actor-visible count after the Worker has counted the scope.

integer format: int32
nullable
ScannedRecords

Records streamed through the complete scan.

integer format: int32
GroupCount

Complete persisted group count after success.

integer format: int32
ResultCandidateCount

Distinct persisted candidate count after success.

integer format: int32
AttemptCount

Number of fenced Worker attempts.

integer format: int32
CanCancel

Whether the current actor may request cancellation.

boolean
CanRetry

Whether the current actor may enqueue a retry.

boolean
ErrorCode

Stable localized error code for a terminal failure.

string
nullable
ErrorMessage

Localized terminal failure message.

string
nullable
CreatedAtUtc

Job creation time.

string format: date-time
StartedAtUtc

First processing time, when claimed.

string format: date-time
nullable
FinishedAtUtc

Terminal completion time.

string format: date-time
nullable
CapturedAtUtc

Time at which the currently published result snapshot was captured.

string format: date-time
nullable
FailureRetryable

Whether the terminal failure was classified as transient for automatic retry diagnostics.

boolean
Result

One bounded page over the complete persisted groups of a successful full scan.

object
Run

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
Surface
integer format: int32
Allowed values: 0 1 2
Profile

Compact record-matching profile used by lists and launch options.

object
Id
string
nullable
Name
string
nullable
Key
string
nullable
Enabled
boolean
TargetKind
integer format: int32
Allowed values: 0
TargetEntityDefinitionId
string
nullable
TargetEntityName
string
nullable
TargetEntityDisplayName
string
nullable
ShowOnTablePage
boolean
ShowOnDetailsPage
boolean
ActionMode
integer format: int32
Allowed values: 0
MinimumScore
integer format: int32
MediumConfidenceThreshold
integer format: int32
HighConfidenceThreshold
integer format: int32
RuleCount
integer format: int32
RowVersion
string format: uuid
Anchor

Visible record candidate returned by the matching engine.

object
Id
string
nullable
DisplayName
string
nullable
Subtitle
string
nullable
IsArchived
boolean
OpenTarget
object
TargetCode
string
nullable
Parameters
object
key
additional properties
string
TotalVisibleRecords

Complete actor-visible record count in the selected archive scope.

integer format: int32
TotalScannedRecords

Records covered by the matching run.

integer format: int32
ScanLimitReached

Whether a target-wide scan stopped at its request limit.

boolean
Groups

Complete groups for anchored runs, or groups from the bounded target-wide scan.

Array<object>
nullable

One exact set or honest fuzzy pair produced by matching rules.

object
Id

Stable group identifier derived from its canonical candidate set.

string
nullable
Score

Highest effective exact or fuzzy rule score contributing to the group.

integer format: int32
ConfidenceBand
integer format: int32
Allowed values: 0 1 2
MatchedRules

Rules that produced the exact set or canonical fuzzy pair.

Array<object>
nullable

Configured rule that contributed to a candidate group. Score is the effective score; ConfiguredScore preserves the profile score before fuzzy similarity.

object
RuleId

Stable matching-rule identifier.

string
nullable
RuleKey

Portable technical rule key.

string
nullable
RuleName

Current rule label.

string
nullable
Score

Effective score after fuzzy similarity is applied.

integer format: int32
ConfiguredScore

Configured rule score before fuzzy similarity; null for legacy exact results.

integer format: int32
nullable
SimilarityBasisPoints

Weighted similarity from zero through ten thousand basis points.

integer format: int32
Reasons

Readable matching-field reasons for the group.

Array<object>
nullable

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
RuleId

Stable matching-rule identifier.

string
nullable
RuleKey

Portable technical rule key.

string
nullable
RuleName

Current rule label.

string
nullable
FieldId

Stable matching field identifier.

string
nullable
FieldKey

Portable technical entity-field key.

string
nullable
FieldDisplayName

Current actor-readable field label.

string
nullable
Normalizer
integer format: int32
Allowed values: 0 1 2 3
DiagnosticValue

Actor-safe exact diagnostic; empty for fuzzy evidence.

string
nullable
ComparisonMode
integer format: int32
Allowed values: 0 1
FuzzyAlgorithm
integer format: int32
Allowed values: 0
Distance

Unicode-rune edit distance, or null for exact evidence.

integer format: int32
nullable
MaxDistance

Configured inclusive fuzzy threshold, or null for exact evidence.

integer format: int32
nullable
SimilarityBasisPoints

Field similarity from zero through ten thousand basis points.

integer format: int32
nullable
Weight

Configured fuzzy field weight, or null for exact evidence.

integer format: int32
nullable
DiacriticMode
integer format: int32
Allowed values: 0 1
TokenOrderMode
integer format: int32
Allowed values: 0 1
Candidates

Candidates materialized in the current bounded response page.

Array<object>
nullable

Visible record candidate returned by the matching engine.

object
Id
string
nullable
DisplayName
string
nullable
Subtitle
string
nullable
IsArchived
boolean
OpenTarget
object
TargetCode
string
nullable
Parameters
object
key
additional properties
string
TotalCandidateCount

Complete candidate count when candidates are paged; otherwise null.

integer format: int32
nullable
GroupKind
integer format: int32
Allowed values: 0 1
Page

One-based group page.

integer format: int32
PageSize

Applied bounded group page size.

integer format: int32
TotalGroupCount

Complete group count in the saved result.

integer format: int32
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Status": 0,
"Phase": 0,
"Profile": {
"TargetKind": 0,
"ActionMode": 0
},
"ArchiveMode": 0,
"Result": {
"Run": {
"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

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
Data

Status and actor-owned progress of one durable full target-wide matching scan.

object
Id

Stable persisted job identifier.

string
nullable
Status
integer format: int32
Allowed values: 0 1 2 3 4
Phase
integer format: int32
Allowed values: 0 1 2 3 4
Profile

Compact record-matching profile used by lists and launch options.

object
Id
string
nullable
Name
string
nullable
Key
string
nullable
Enabled
boolean
TargetKind
integer format: int32
Allowed values: 0
TargetEntityDefinitionId
string
nullable
TargetEntityName
string
nullable
TargetEntityDisplayName
string
nullable
ShowOnTablePage
boolean
ShowOnDetailsPage
boolean
ActionMode
integer format: int32
Allowed values: 0
MinimumScore
integer format: int32
MediumConfidenceThreshold
integer format: int32
HighConfidenceThreshold
integer format: int32
RuleCount
integer format: int32
RowVersion
string format: uuid
ArchiveMode
integer format: int32
Allowed values: 0 1 2
TotalVisibleRecords

Complete actor-visible count after the Worker has counted the scope.

integer format: int32
nullable
ScannedRecords

Records streamed through the complete scan.

integer format: int32
GroupCount

Complete persisted group count after success.

integer format: int32
ResultCandidateCount

Distinct persisted candidate count after success.

integer format: int32
AttemptCount

Number of fenced Worker attempts.

integer format: int32
CanCancel

Whether the current actor may request cancellation.

boolean
CanRetry

Whether the current actor may enqueue a retry.

boolean
ErrorCode

Stable localized error code for a terminal failure.

string
nullable
ErrorMessage

Localized terminal failure message.

string
nullable
CreatedAtUtc

Job creation time.

string format: date-time
StartedAtUtc

First processing time, when claimed.

string format: date-time
nullable
FinishedAtUtc

Terminal completion time.

string format: date-time
nullable
CapturedAtUtc

Time at which the currently published result snapshot was captured.

string format: date-time
nullable
FailureRetryable

Whether the terminal failure was classified as transient for automatic retry diagnostics.

boolean
Result

One bounded page over the complete persisted groups of a successful full scan.

object
Run

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
Surface
integer format: int32
Allowed values: 0 1 2
Profile

Compact record-matching profile used by lists and launch options.

object
Id
string
nullable
Name
string
nullable
Key
string
nullable
Enabled
boolean
TargetKind
integer format: int32
Allowed values: 0
TargetEntityDefinitionId
string
nullable
TargetEntityName
string
nullable
TargetEntityDisplayName
string
nullable
ShowOnTablePage
boolean
ShowOnDetailsPage
boolean
ActionMode
integer format: int32
Allowed values: 0
MinimumScore
integer format: int32
MediumConfidenceThreshold
integer format: int32
HighConfidenceThreshold
integer format: int32
RuleCount
integer format: int32
RowVersion
string format: uuid
Anchor

Visible record candidate returned by the matching engine.

object
Id
string
nullable
DisplayName
string
nullable
Subtitle
string
nullable
IsArchived
boolean
OpenTarget
object
TargetCode
string
nullable
Parameters
object
key
additional properties
string
TotalVisibleRecords

Complete actor-visible record count in the selected archive scope.

integer format: int32
TotalScannedRecords

Records covered by the matching run.

integer format: int32
ScanLimitReached

Whether a target-wide scan stopped at its request limit.

boolean
Groups

Complete groups for anchored runs, or groups from the bounded target-wide scan.

Array<object>
nullable

One exact set or honest fuzzy pair produced by matching rules.

object
Id

Stable group identifier derived from its canonical candidate set.

string
nullable
Score

Highest effective exact or fuzzy rule score contributing to the group.

integer format: int32
ConfidenceBand
integer format: int32
Allowed values: 0 1 2
MatchedRules

Rules that produced the exact set or canonical fuzzy pair.

Array<object>
nullable

Configured rule that contributed to a candidate group. Score is the effective score; ConfiguredScore preserves the profile score before fuzzy similarity.

object
RuleId

Stable matching-rule identifier.

string
nullable
RuleKey

Portable technical rule key.

string
nullable
RuleName

Current rule label.

string
nullable
Score

Effective score after fuzzy similarity is applied.

integer format: int32
ConfiguredScore

Configured rule score before fuzzy similarity; null for legacy exact results.

integer format: int32
nullable
SimilarityBasisPoints

Weighted similarity from zero through ten thousand basis points.

integer format: int32
Reasons

Readable matching-field reasons for the group.

Array<object>
nullable

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
RuleId

Stable matching-rule identifier.

string
nullable
RuleKey

Portable technical rule key.

string
nullable
RuleName

Current rule label.

string
nullable
FieldId

Stable matching field identifier.

string
nullable
FieldKey

Portable technical entity-field key.

string
nullable
FieldDisplayName

Current actor-readable field label.

string
nullable
Normalizer
integer format: int32
Allowed values: 0 1 2 3
DiagnosticValue

Actor-safe exact diagnostic; empty for fuzzy evidence.

string
nullable
ComparisonMode
integer format: int32
Allowed values: 0 1
FuzzyAlgorithm
integer format: int32
Allowed values: 0
Distance

Unicode-rune edit distance, or null for exact evidence.

integer format: int32
nullable
MaxDistance

Configured inclusive fuzzy threshold, or null for exact evidence.

integer format: int32
nullable
SimilarityBasisPoints

Field similarity from zero through ten thousand basis points.

integer format: int32
nullable
Weight

Configured fuzzy field weight, or null for exact evidence.

integer format: int32
nullable
DiacriticMode
integer format: int32
Allowed values: 0 1
TokenOrderMode
integer format: int32
Allowed values: 0 1
Candidates

Candidates materialized in the current bounded response page.

Array<object>
nullable

Visible record candidate returned by the matching engine.

object
Id
string
nullable
DisplayName
string
nullable
Subtitle
string
nullable
IsArchived
boolean
OpenTarget
object
TargetCode
string
nullable
Parameters
object
key
additional properties
string
TotalCandidateCount

Complete candidate count when candidates are paged; otherwise null.

integer format: int32
nullable
GroupKind
integer format: int32
Allowed values: 0 1
Page

One-based group page.

integer format: int32
PageSize

Applied bounded group page size.

integer format: int32
TotalGroupCount

Complete group count in the saved result.

integer format: int32
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Status": 0,
"Phase": 0,
"Profile": {
"TargetKind": 0,
"ActionMode": 0
},
"ArchiveMode": 0,
"Result": {
"Run": {
"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

Media typeapplication/json
object
Data

Status and actor-owned progress of one durable full target-wide matching scan.

object
Id

Stable persisted job identifier.

string
nullable
Status
integer format: int32
Allowed values: 0 1 2 3 4
Phase
integer format: int32
Allowed values: 0 1 2 3 4
Profile

Compact record-matching profile used by lists and launch options.

object
Id
string
nullable
Name
string
nullable
Key
string
nullable
Enabled
boolean
TargetKind
integer format: int32
Allowed values: 0
TargetEntityDefinitionId
string
nullable
TargetEntityName
string
nullable
TargetEntityDisplayName
string
nullable
ShowOnTablePage
boolean
ShowOnDetailsPage
boolean
ActionMode
integer format: int32
Allowed values: 0
MinimumScore
integer format: int32
MediumConfidenceThreshold
integer format: int32
HighConfidenceThreshold
integer format: int32
RuleCount
integer format: int32
RowVersion
string format: uuid
ArchiveMode
integer format: int32
Allowed values: 0 1 2
TotalVisibleRecords

Complete actor-visible count after the Worker has counted the scope.

integer format: int32
nullable
ScannedRecords

Records streamed through the complete scan.

integer format: int32
GroupCount

Complete persisted group count after success.

integer format: int32
ResultCandidateCount

Distinct persisted candidate count after success.

integer format: int32
AttemptCount

Number of fenced Worker attempts.

integer format: int32
CanCancel

Whether the current actor may request cancellation.

boolean
CanRetry

Whether the current actor may enqueue a retry.

boolean
ErrorCode

Stable localized error code for a terminal failure.

string
nullable
ErrorMessage

Localized terminal failure message.

string
nullable
CreatedAtUtc

Job creation time.

string format: date-time
StartedAtUtc

First processing time, when claimed.

string format: date-time
nullable
FinishedAtUtc

Terminal completion time.

string format: date-time
nullable
CapturedAtUtc

Time at which the currently published result snapshot was captured.

string format: date-time
nullable
FailureRetryable

Whether the terminal failure was classified as transient for automatic retry diagnostics.

boolean
Result

One bounded page over the complete persisted groups of a successful full scan.

object
Run

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
Surface
integer format: int32
Allowed values: 0 1 2
Profile

Compact record-matching profile used by lists and launch options.

object
Id
string
nullable
Name
string
nullable
Key
string
nullable
Enabled
boolean
TargetKind
integer format: int32
Allowed values: 0
TargetEntityDefinitionId
string
nullable
TargetEntityName
string
nullable
TargetEntityDisplayName
string
nullable
ShowOnTablePage
boolean
ShowOnDetailsPage
boolean
ActionMode
integer format: int32
Allowed values: 0
MinimumScore
integer format: int32
MediumConfidenceThreshold
integer format: int32
HighConfidenceThreshold
integer format: int32
RuleCount
integer format: int32
RowVersion
string format: uuid
Anchor

Visible record candidate returned by the matching engine.

object
Id
string
nullable
DisplayName
string
nullable
Subtitle
string
nullable
IsArchived
boolean
OpenTarget
object
TargetCode
string
nullable
Parameters
object
key
additional properties
string
TotalVisibleRecords

Complete actor-visible record count in the selected archive scope.

integer format: int32
TotalScannedRecords

Records covered by the matching run.

integer format: int32
ScanLimitReached

Whether a target-wide scan stopped at its request limit.

boolean
Groups

Complete groups for anchored runs, or groups from the bounded target-wide scan.

Array<object>
nullable

One exact set or honest fuzzy pair produced by matching rules.

object
Id

Stable group identifier derived from its canonical candidate set.

string
nullable
Score

Highest effective exact or fuzzy rule score contributing to the group.

integer format: int32
ConfidenceBand
integer format: int32
Allowed values: 0 1 2
MatchedRules

Rules that produced the exact set or canonical fuzzy pair.

Array<object>
nullable

Configured rule that contributed to a candidate group. Score is the effective score; ConfiguredScore preserves the profile score before fuzzy similarity.

object
RuleId

Stable matching-rule identifier.

string
nullable
RuleKey

Portable technical rule key.

string
nullable
RuleName

Current rule label.

string
nullable
Score

Effective score after fuzzy similarity is applied.

integer format: int32
ConfiguredScore

Configured rule score before fuzzy similarity; null for legacy exact results.

integer format: int32
nullable
SimilarityBasisPoints

Weighted similarity from zero through ten thousand basis points.

integer format: int32
Reasons

Readable matching-field reasons for the group.

Array<object>
nullable

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
RuleId

Stable matching-rule identifier.

string
nullable
RuleKey

Portable technical rule key.

string
nullable
RuleName

Current rule label.

string
nullable
FieldId

Stable matching field identifier.

string
nullable
FieldKey

Portable technical entity-field key.

string
nullable
FieldDisplayName

Current actor-readable field label.

string
nullable
Normalizer
integer format: int32
Allowed values: 0 1 2 3
DiagnosticValue

Actor-safe exact diagnostic; empty for fuzzy evidence.

string
nullable
ComparisonMode
integer format: int32
Allowed values: 0 1
FuzzyAlgorithm
integer format: int32
Allowed values: 0
Distance

Unicode-rune edit distance, or null for exact evidence.

integer format: int32
nullable
MaxDistance

Configured inclusive fuzzy threshold, or null for exact evidence.

integer format: int32
nullable
SimilarityBasisPoints

Field similarity from zero through ten thousand basis points.

integer format: int32
nullable
Weight

Configured fuzzy field weight, or null for exact evidence.

integer format: int32
nullable
DiacriticMode
integer format: int32
Allowed values: 0 1
TokenOrderMode
integer format: int32
Allowed values: 0 1
Candidates

Candidates materialized in the current bounded response page.

Array<object>
nullable

Visible record candidate returned by the matching engine.

object
Id
string
nullable
DisplayName
string
nullable
Subtitle
string
nullable
IsArchived
boolean
OpenTarget
object
TargetCode
string
nullable
Parameters
object
key
additional properties
string
TotalCandidateCount

Complete candidate count when candidates are paged; otherwise null.

integer format: int32
nullable
GroupKind
integer format: int32
Allowed values: 0 1
Page

One-based group page.

integer format: int32
PageSize

Applied bounded group page size.

integer format: int32
TotalGroupCount

Complete group count in the saved result.

integer format: int32
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Status": 0,
"Phase": 0,
"Profile": {
"TargetKind": 0,
"ActionMode": 0
},
"ArchiveMode": 0,
"Result": {
"Run": {
"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

Media typeapplication/json
object
Data

Status and actor-owned progress of one durable full target-wide matching scan.

object
Id

Stable persisted job identifier.

string
nullable
Status
integer format: int32
Allowed values: 0 1 2 3 4
Phase
integer format: int32
Allowed values: 0 1 2 3 4
Profile

Compact record-matching profile used by lists and launch options.

object
Id
string
nullable
Name
string
nullable
Key
string
nullable
Enabled
boolean
TargetKind
integer format: int32
Allowed values: 0
TargetEntityDefinitionId
string
nullable
TargetEntityName
string
nullable
TargetEntityDisplayName
string
nullable
ShowOnTablePage
boolean
ShowOnDetailsPage
boolean
ActionMode
integer format: int32
Allowed values: 0
MinimumScore
integer format: int32
MediumConfidenceThreshold
integer format: int32
HighConfidenceThreshold
integer format: int32
RuleCount
integer format: int32
RowVersion
string format: uuid
ArchiveMode
integer format: int32
Allowed values: 0 1 2
TotalVisibleRecords

Complete actor-visible count after the Worker has counted the scope.

integer format: int32
nullable
ScannedRecords

Records streamed through the complete scan.

integer format: int32
GroupCount

Complete persisted group count after success.

integer format: int32
ResultCandidateCount

Distinct persisted candidate count after success.

integer format: int32
AttemptCount

Number of fenced Worker attempts.

integer format: int32
CanCancel

Whether the current actor may request cancellation.

boolean
CanRetry

Whether the current actor may enqueue a retry.

boolean
ErrorCode

Stable localized error code for a terminal failure.

string
nullable
ErrorMessage

Localized terminal failure message.

string
nullable
CreatedAtUtc

Job creation time.

string format: date-time
StartedAtUtc

First processing time, when claimed.

string format: date-time
nullable
FinishedAtUtc

Terminal completion time.

string format: date-time
nullable
CapturedAtUtc

Time at which the currently published result snapshot was captured.

string format: date-time
nullable
FailureRetryable

Whether the terminal failure was classified as transient for automatic retry diagnostics.

boolean
Result

One bounded page over the complete persisted groups of a successful full scan.

object
Run

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
Surface
integer format: int32
Allowed values: 0 1 2
Profile

Compact record-matching profile used by lists and launch options.

object
Id
string
nullable
Name
string
nullable
Key
string
nullable
Enabled
boolean
TargetKind
integer format: int32
Allowed values: 0
TargetEntityDefinitionId
string
nullable
TargetEntityName
string
nullable
TargetEntityDisplayName
string
nullable
ShowOnTablePage
boolean
ShowOnDetailsPage
boolean
ActionMode
integer format: int32
Allowed values: 0
MinimumScore
integer format: int32
MediumConfidenceThreshold
integer format: int32
HighConfidenceThreshold
integer format: int32
RuleCount
integer format: int32
RowVersion
string format: uuid
Anchor

Visible record candidate returned by the matching engine.

object
Id
string
nullable
DisplayName
string
nullable
Subtitle
string
nullable
IsArchived
boolean
OpenTarget
object
TargetCode
string
nullable
Parameters
object
key
additional properties
string
TotalVisibleRecords

Complete actor-visible record count in the selected archive scope.

integer format: int32
TotalScannedRecords

Records covered by the matching run.

integer format: int32
ScanLimitReached

Whether a target-wide scan stopped at its request limit.

boolean
Groups

Complete groups for anchored runs, or groups from the bounded target-wide scan.

Array<object>
nullable

One exact set or honest fuzzy pair produced by matching rules.

object
Id

Stable group identifier derived from its canonical candidate set.

string
nullable
Score

Highest effective exact or fuzzy rule score contributing to the group.

integer format: int32
ConfidenceBand
integer format: int32
Allowed values: 0 1 2
MatchedRules

Rules that produced the exact set or canonical fuzzy pair.

Array<object>
nullable

Configured rule that contributed to a candidate group. Score is the effective score; ConfiguredScore preserves the profile score before fuzzy similarity.

object
RuleId

Stable matching-rule identifier.

string
nullable
RuleKey

Portable technical rule key.

string
nullable
RuleName

Current rule label.

string
nullable
Score

Effective score after fuzzy similarity is applied.

integer format: int32
ConfiguredScore

Configured rule score before fuzzy similarity; null for legacy exact results.

integer format: int32
nullable
SimilarityBasisPoints

Weighted similarity from zero through ten thousand basis points.

integer format: int32
Reasons

Readable matching-field reasons for the group.

Array<object>
nullable

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
RuleId

Stable matching-rule identifier.

string
nullable
RuleKey

Portable technical rule key.

string
nullable
RuleName

Current rule label.

string
nullable
FieldId

Stable matching field identifier.

string
nullable
FieldKey

Portable technical entity-field key.

string
nullable
FieldDisplayName

Current actor-readable field label.

string
nullable
Normalizer
integer format: int32
Allowed values: 0 1 2 3
DiagnosticValue

Actor-safe exact diagnostic; empty for fuzzy evidence.

string
nullable
ComparisonMode
integer format: int32
Allowed values: 0 1
FuzzyAlgorithm
integer format: int32
Allowed values: 0
Distance

Unicode-rune edit distance, or null for exact evidence.

integer format: int32
nullable
MaxDistance

Configured inclusive fuzzy threshold, or null for exact evidence.

integer format: int32
nullable
SimilarityBasisPoints

Field similarity from zero through ten thousand basis points.

integer format: int32
nullable
Weight

Configured fuzzy field weight, or null for exact evidence.

integer format: int32
nullable
DiacriticMode
integer format: int32
Allowed values: 0 1
TokenOrderMode
integer format: int32
Allowed values: 0 1
Candidates

Candidates materialized in the current bounded response page.

Array<object>
nullable

Visible record candidate returned by the matching engine.

object
Id
string
nullable
DisplayName
string
nullable
Subtitle
string
nullable
IsArchived
boolean
OpenTarget
object
TargetCode
string
nullable
Parameters
object
key
additional properties
string
TotalCandidateCount

Complete candidate count when candidates are paged; otherwise null.

integer format: int32
nullable
GroupKind
integer format: int32
Allowed values: 0 1
Page

One-based group page.

integer format: int32
PageSize

Applied bounded group page size.

integer format: int32
TotalGroupCount

Complete group count in the saved result.

integer format: int32
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Status": 0,
"Phase": 0,
"Profile": {
"TargetKind": 0,
"ActionMode": 0
},
"ArchiveMode": 0,
"Result": {
"Run": {
"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
}
]
}