Skip to content

Return one record-matching profile.

GET
/api/workspace/admin/record-matching/{profileId}
curl --request GET \
--url https://example.com/api/workspace/admin/record-matching/example
  • None
profileId
required
string

Record-matching profile identifier.

access_token
string

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

OK

Media typeapplication/json
object
Data

Full record-matching profile configuration.

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
Rules
Array<object>
nullable

Configured exact-normalized or fuzzy matching rule.

object
Id
string
nullable
Name
string
nullable
Key
string
nullable
Enabled
boolean
MatchMode
integer format: int32
Allowed values: 0 1
Score
integer format: int32
SortOrder
integer format: int32
Fields
Array<object>
nullable

Configured field binding for one matching rule.

object
Id

Stable rule-field identifier.

string
nullable
EntityFieldDefinitionId

Bound entity-field definition identifier.

string
nullable
FieldKey

Portable technical field key.

string
nullable
FieldDisplayName

Current actor-readable field label.

string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
Normalizer
integer format: int32
Allowed values: 0 1 2 3
SortOrder

Deterministic field order within the rule.

integer format: int32
RowVersion

Optimistic-concurrency version.

string format: uuid
ComparisonMode
integer format: int32
Allowed values: 0 1
FuzzySettings

Configured fuzzy TextKey field settings.

object
Algorithm
integer format: int32
Allowed values: 0
MaxDistance

Inclusive distance threshold from one through three.

integer format: int32
MinimumLength

Minimum normalized rune length required for both values.

integer format: int32
Weight

Field contribution to the fuzzy rule similarity, from one through one hundred.

integer format: int32
DiacriticMode
integer format: int32
Allowed values: 0 1
TokenOrderMode
integer format: int32
Allowed values: 0 1
RowVersion
string format: uuid
RowVersion
string format: uuid
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": {
"TargetKind": 0,
"ActionMode": 0,
"Rules": [
{
"MatchMode": 0,
"Fields": [
{
"FieldType": 0,
"Normalizer": 0,
"ComparisonMode": 0,
"FuzzySettings": {
"Algorithm": 0,
"DiacriticMode": 0,
"TokenOrderMode": 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

Full record-matching profile configuration.

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
Rules
Array<object>
nullable

Configured exact-normalized or fuzzy matching rule.

object
Id
string
nullable
Name
string
nullable
Key
string
nullable
Enabled
boolean
MatchMode
integer format: int32
Allowed values: 0 1
Score
integer format: int32
SortOrder
integer format: int32
Fields
Array<object>
nullable

Configured field binding for one matching rule.

object
Id

Stable rule-field identifier.

string
nullable
EntityFieldDefinitionId

Bound entity-field definition identifier.

string
nullable
FieldKey

Portable technical field key.

string
nullable
FieldDisplayName

Current actor-readable field label.

string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
Normalizer
integer format: int32
Allowed values: 0 1 2 3
SortOrder

Deterministic field order within the rule.

integer format: int32
RowVersion

Optimistic-concurrency version.

string format: uuid
ComparisonMode
integer format: int32
Allowed values: 0 1
FuzzySettings

Configured fuzzy TextKey field settings.

object
Algorithm
integer format: int32
Allowed values: 0
MaxDistance

Inclusive distance threshold from one through three.

integer format: int32
MinimumLength

Minimum normalized rune length required for both values.

integer format: int32
Weight

Field contribution to the fuzzy rule similarity, from one through one hundred.

integer format: int32
DiacriticMode
integer format: int32
Allowed values: 0 1
TokenOrderMode
integer format: int32
Allowed values: 0 1
RowVersion
string format: uuid
RowVersion
string format: uuid
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": {
"TargetKind": 0,
"ActionMode": 0,
"Rules": [
{
"MatchMode": 0,
"Fields": [
{
"FieldType": 0,
"Normalizer": 0,
"ComparisonMode": 0,
"FuzzySettings": {
"Algorithm": 0,
"DiacriticMode": 0,
"TokenOrderMode": 0
}
}
]
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}