Create one record-matching profile.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/admin/record-matching"), Content = new StringContent("{ \"Name\": \"example\", \"Key\": \"example\", \"Enabled\": true, \"TargetKind\": 0, \"TargetEntityDefinitionId\": \"example\", \"ShowOnTablePage\": true, \"ShowOnDetailsPage\": true, \"ActionMode\": 0, \"MinimumScore\": 1, \"MediumConfidenceThreshold\": 1, \"HighConfidenceThreshold\": 1, \"Rules\": [ { \"Name\": \"example\", \"Key\": \"example\", \"Enabled\": true, \"MatchMode\": 0, \"Score\": 1, \"SortOrder\": 1, \"Fields\": [ { \"EntityFieldDefinitionId\": \"example\", \"Normalizer\": 0, \"SortOrder\": 1, \"ComparisonMode\": 0, \"FuzzySettings\": { \"Algorithm\": 0, \"MaxDistance\": 1, \"MinimumLength\": 1, \"Weight\": 1, \"DiacriticMode\": 0, \"TokenOrderMode\": 0 } } ] } ] }") { 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/admin/record-matching';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"Name":"example","Key":"example","Enabled":true,"TargetKind":0,"TargetEntityDefinitionId":"example","ShowOnTablePage":true,"ShowOnDetailsPage":true,"ActionMode":0,"MinimumScore":1,"MediumConfidenceThreshold":1,"HighConfidenceThreshold":1,"Rules":[{"Name":"example","Key":"example","Enabled":true,"MatchMode":0,"Score":1,"SortOrder":1,"Fields":[{"EntityFieldDefinitionId":"example","Normalizer":0,"SortOrder":1,"ComparisonMode":0,"FuzzySettings":{"Algorithm":0,"MaxDistance":1,"MinimumLength":1,"Weight":1,"DiacriticMode":0,"TokenOrderMode":0}}]}]}'};
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/admin/record-matching \ --header 'Content-Type: application/json' \ --data '{ "Name": "example", "Key": "example", "Enabled": true, "TargetKind": 0, "TargetEntityDefinitionId": "example", "ShowOnTablePage": true, "ShowOnDetailsPage": true, "ActionMode": 0, "MinimumScore": 1, "MediumConfidenceThreshold": 1, "HighConfidenceThreshold": 1, "Rules": [ { "Name": "example", "Key": "example", "Enabled": true, "MatchMode": 0, "Score": 1, "SortOrder": 1, "Fields": [ { "EntityFieldDefinitionId": "example", "Normalizer": 0, "SortOrder": 1, "ComparisonMode": 0, "FuzzySettings": { "Algorithm": 0, "MaxDistance": 1, "MinimumLength": 1, "Weight": 1, "DiacriticMode": 0, "TokenOrderMode": 0 } } ] } ] }'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”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”Request payload for creating a record-matching profile.
object
Request payload for one exact-normalized or fuzzy matching rule.
object
Request payload for one field binding inside a matching rule. Omitted trailing comparison properties preserve the additive exact-field behavior used by earlier clients.
object
Bound entity-field definition identifier.
Deterministic field order within the rule.
Configuration for one fuzzy TextKey field binding.
object
Inclusive distance threshold from one through three.
Minimum normalized rune length; at least twice the threshold plus one.
Field contribution to rule similarity, from one through one hundred.
Request payload for creating a record-matching profile.
object
Request payload for one exact-normalized or fuzzy matching rule.
object
Request payload for one field binding inside a matching rule. Omitted trailing comparison properties preserve the additive exact-field behavior used by earlier clients.
object
Bound entity-field definition identifier.
Deterministic field order within the rule.
Configuration for one fuzzy TextKey field binding.
object
Inclusive distance threshold from one through three.
Minimum normalized rune length; at least twice the threshold plus one.
Field contribution to rule similarity, from one through one hundred.
Request payload for creating a record-matching profile.
object
Request payload for one exact-normalized or fuzzy matching rule.
object
Request payload for one field binding inside a matching rule. Omitted trailing comparison properties preserve the additive exact-field behavior used by earlier clients.
object
Bound entity-field definition identifier.
Deterministic field order within the rule.
Configuration for one fuzzy TextKey field binding.
object
Inclusive distance threshold from one through three.
Minimum normalized rune length; at least twice the threshold plus one.
Field contribution to rule similarity, from one through one hundred.
Responses
Section titled “Responses”OK
object
Full record-matching profile configuration.
object
Configured exact-normalized or fuzzy matching rule.
object
Configured field binding for one matching rule.
object
Stable rule-field identifier.
Bound entity-field definition identifier.
Portable technical field key.
Current actor-readable field label.
Deterministic field order within the rule.
Optimistic-concurrency version.
Configured fuzzy TextKey field settings.
object
Inclusive distance threshold from one through three.
Minimum normalized rune length required for both values.
Field contribution to the fuzzy rule similarity, from one through one hundred.
object
object
object
object
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 } ]}Bad Request
object
Full record-matching profile configuration.
object
Configured exact-normalized or fuzzy matching rule.
object
Configured field binding for one matching rule.
object
Stable rule-field identifier.
Bound entity-field definition identifier.
Portable technical field key.
Current actor-readable field label.
Deterministic field order within the rule.
Optimistic-concurrency version.
Configured fuzzy TextKey field settings.
object
Inclusive distance threshold from one through three.
Minimum normalized rune length required for both values.
Field contribution to the fuzzy rule similarity, from one through one hundred.
object
object
object
object
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
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Conflict
object
Full record-matching profile configuration.
object
Configured exact-normalized or fuzzy matching rule.
object
Configured field binding for one matching rule.
object
Stable rule-field identifier.
Bound entity-field definition identifier.
Portable technical field key.
Current actor-readable field label.
Deterministic field order within the rule.
Optimistic-concurrency version.
Configured fuzzy TextKey field settings.
object
Inclusive distance threshold from one through three.
Minimum normalized rune length required for both values.
Field contribution to the fuzzy rule similarity, from one through one hundred.
object
object
object
object
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 } ]}