{"items":[{"type":"link","label":"Data Matching API","link":"/apis/data-matching-api/api-v2","routeSlug":"/apis/data-matching-api/api-v2","content":{"contentType":"overview","meta":{"name":"Data Matching API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api-v2.json","url":"/_bundle/apis/data-matching-api/@data-matching-api-v2/api-v2.json?download"},{"kind":"download","label":"api-v2.yaml","url":"/_bundle/apis/data-matching-api/@data-matching-api-v2/api-v2.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"java","title":"Java","lang":"Java"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"python","title":"Python","lang":"Python"},{"key":"node","title":"Node.js","lang":"Node.js"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"description":"Production","url":"https://api.cdq.com/data-matching/rest","x-cdq-soap-url":"https://api.corporate-data-league.ch/data-matching/soap/v2"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Data Matching API (2)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This API provides services for maintaining matching definitions used as configuration\nfor matching jobs, as well as services for matching data with a job."}],"sectionId":"/apis/data-matching-api/api-v2"}],"sectionId":"/apis/data-matching-api/api-v2"}]}]}},{"type":"group","label":"Analytics","link":"/apis/data-matching-api/api-v2/analytics","routeSlug":"/apis/data-matching-api/api-v2/analytics","items":[{"label":"Build Matching Reports","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/analytics/paths/~1matchingreports/post","routeSlug":"/apis/data-matching-api/api-v2/analytics/paths/~1matchingreports/post","metadata":{"seo":{"title":"Build Matching Reports","description":"Requests the building of data matching reports."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Build Matching Reports","isWebhook":false,"pointer":"/paths/~1matchingreports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Build Matching Reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Requests the building of data matching reports."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MatchingReportsRequest"}},"schemaId":"components/schemas/MatchingReportsRequest","pointer":"/paths/~1matchingreports/post/requestBody","description":"cmd"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/matchingreports","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MatchingReportsRequest"}},"responseCodes":["200","201","401","403","404"],"pointer":"/matchingreports","href":"analytics/paths/~1matchingreports/post","summary":"Build Matching Reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"schemaId":"components/schemas/MatchingReportsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MatchingReportsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingReports"}},"schemaId":"components/schemas/MatchingReports"},{"code":"201","description":"Created"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1matchingreports/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MatchingReports","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingReports"}}},{"code":"201"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/analytics/paths/~1matchingreports/post"}],"panels":[]}]},"httpPath":"/matchingreports"},{"label":"Poll Matching Reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/analytics/paths/~1matchingreports~1{id}/get","routeSlug":"/apis/data-matching-api/api-v2/analytics/paths/~1matchingreports~1{id}/get","metadata":{"seo":{"title":"Poll Matching Reports","description":"Polls the status of the matching reports."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Poll Matching Reports","isWebhook":false,"pointer":"/paths/~1matchingreports~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll Matching Reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Polls the status of the matching reports."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"ID of the matching report.","required":true,"example":"65dcc3c60cecd503bcc88c92"}],"pointer":"/paths/~1matchingreports~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/matchingreports/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"65dcc3c60cecd503bcc88c92","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/matchingreports/{id}","href":"analytics/paths/~1matchingreports~1{id}/get","summary":"Poll Matching Reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingReports"}},"schemaId":"components/schemas/MatchingReports"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1matchingreports~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MatchingReports","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingReports"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/analytics/paths/~1matchingreports~1{id}/get"}],"panels":[]}]},"httpPath":"/matchingreports/{id}"}],"content":{"contentType":"group","meta":{"name":"Analytics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Analytics","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for generating and polling data matching reports. These endpoints support creating reports \nand checking their status, ensuring comprehensive analytics for data matching activities."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/matchingreports","summary":"Build Matching Reports","prefix":{"name":"post","color":"post"},"badges":[],"link":"/analytics/paths/~1matchingreports/post","deprecated":false},{"title":"/matchingreports/{id}","summary":"Poll Matching Reports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics/paths/~1matchingreports~1{id}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Matching","link":"/apis/data-matching-api/api-v2/data-matching","routeSlug":"/apis/data-matching-api/api-v2/data-matching","items":[{"label":"Create Data Matching Definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/data-matching/paths/~1datamatchingdefinitions/post","routeSlug":"/apis/data-matching-api/api-v2/data-matching/paths/~1datamatchingdefinitions/post","metadata":{"seo":{"title":"Create Data Matching Definition","description":"Create a new Data Matching Definition with the given configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create Data Matching Definition","isWebhook":false,"pointer":"/paths/~1datamatchingdefinitions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Data Matching Definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new Data Matching Definition with the given configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  <?xml version=\"1.0\" standalone=\"no\" ?>\n  <duke>\n      <object class=\"no.priv.garshol.duke.comparators.QGramComparator\" name=\"NameComparator\">\n          <param name=\"formula\" value=\"DICE\"/>\n          <param name=\"q\" value=\"3\"/>\n      </object>\n      <schema>\n          <threshold>0.7</threshold>\n          <property type=\"ignore\">\n              <name>STORAGE_ID</name>\n          </property>\n          <property type=\"ignore\">\n              <name>DATA_SOURCE_ID</name>\n          </property>\n          <property type=\"id\">\n              <name>BUSINESS_PARTNER_ID</name>\n          </property>\n          <property lookup=\"required\">\n              <name>COUNTRY_SHORTNAME</name>\n              <comparator>no.priv.garshol.duke.comparators.ExactComparator</comparator>\n              <low>0.0</low>\n              <high>0.5</high>\n          </property>\n          <property lookup=\"true\">\n              <name>NAME</name>\n              <comparator>NameComparator</comparator>\n              <low>0.1</low>\n              <high>0.9</high>\n          </property>\n      </schema>\n      <database class=\"no.priv.garshol.duke.databases.LuceneDatabase\">\n          <param name=\"max-search-hits\" value=\"100\"/>\n          <param name=\"min-relevance\" value=\"0.9\"/>\n          <param name=\"fuzzy-search\" value=\"true\"/>\n          <param name=\"boost-mode\" value=\"INDEX\"/>\n      </database>\n\n      <data-source class=\"cdq.cdl.matching.datasource.MatchingDataSource\">\n          <column\n                  cleaner=\"no.priv.garshol.duke.cleaners.LowerCaseNormalizeCleaner\" name=\"businessPartner.address.country.shortName\" property=\"COUNTRY_SHORTNAME\"/>\n          <column\n                  cleaner=\"no.priv.garshol.duke.cleaners.LowerCaseNormalizeCleaner\"\n                  configProperty=\"COUNTRY_SHORTNAME\" name=\"businessPartner.names[0].value\" property=\"NAME\"/>\n      </data-source>\n  </duke>\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  <?xml version=\"1.0\" standalone=\"no\" ?>\n  <duke>\n      <object class=\"no.priv.garshol.duke.comparators.QGramComparator\" name=\"NameComparator\">\n          <param name=\"formula\" value=\"DICE\"/>\n          <param name=\"q\" value=\"3\"/>\n      </object>\n      <schema>\n          <threshold>0.7</threshold>\n          <property type=\"ignore\">\n              <name>STORAGE_ID</name>\n          </property>\n          <property type=\"ignore\">\n              <name>DATA_SOURCE_ID</name>\n          </property>\n          <property type=\"id\">\n              <name>BUSINESS_PARTNER_ID</name>\n          </property>\n          <property lookup=\"required\">\n              <name>COUNTRY_SHORTNAME</name>\n              <comparator>no.priv.garshol.duke.comparators.ExactComparator</comparator>\n              <low>0.0</low>\n              <high>0.5</high>\n          </property>\n          <property lookup=\"true\">\n              <name>NAME</name>\n              <comparator>NameComparator</comparator>\n              <low>0.1</low>\n              <high>0.9</high>\n          </property>\n      </schema>\n      <database class=\"no.priv.garshol.duke.databases.LuceneDatabase\">\n          <param name=\"max-search-hits\" value=\"100\"/>\n          <param name=\"min-relevance\" value=\"0.9\"/>\n          <param name=\"fuzzy-search\" value=\"true\"/>\n          <param name=\"boost-mode\" value=\"INDEX\"/>\n      </database>\n\n      <data-source class=\"cdq.cdl.matching.datasource.MatchingDataSource\">\n          <column\n                  cleaner=\"no.priv.garshol.duke.cleaners.LowerCaseNormalizeCleaner\" name=\"businessPartner.address.country.shortName\" property=\"COUNTRY_SHORTNAME\"/>\n          <column\n                  cleaner=\"no.priv.garshol.duke.cleaners.LowerCaseNormalizeCleaner\"\n                  configProperty=\"COUNTRY_SHORTNAME\" name=\"businessPartner.names[0].value\" property=\"NAME\"/>\n      </data-source>\n  </duke>\n\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinitionCreate"}},"schemaId":"components/schemas/DataMatchingDefinitionCreate","pointer":"/paths/~1datamatchingdefinitions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/datamatchingdefinitions","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinitionCreate"}},"responseCodes":["200","400"],"pointer":"/datamatchingdefinitions","href":"data-matching/paths/~1datamatchingdefinitions/post","summary":"Create Data Matching Definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"schemaId":"components/schemas/DataMatchingDefinitionCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinitionCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinition"}},"schemaId":"components/schemas/DataMatchingDefinition"},{"code":"400","description":"The sent request is malformed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1datamatchingdefinitions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMatchingDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinition"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-matching/paths/~1datamatchingdefinitions/post"}],"panels":[]}]},"httpPath":"/datamatchingdefinitions"},{"label":"List Data Matching Definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/data-matching/paths/~1datamatchingdefinitions/get","routeSlug":"/apis/data-matching-api/api-v2/data-matching/paths/~1datamatchingdefinitions/get","metadata":{"seo":{"title":"List Data Matching Definitions","description":"Read a page of existing Data Matching Definitions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Data Matching Definitions","isWebhook":false,"pointer":"/paths/~1datamatchingdefinitions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Data Matching Definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read a page of existing Data Matching Definitions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1","description":"Number of the retrieved result page."},{"name":"pageSize","in":"query","schemaId":"schema_2","description":"Maximum number of items to be returned in the result page."},{"name":"matchingType","in":"query","schemaId":"schema_3","description":"Type of the matching configuration."},{"name":"workspaceId","in":"query","schemaId":"schema_4","description":"ID of the workspace."}],"pointer":"/paths/~1datamatchingdefinitions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/datamatchingdefinitions","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":"1","schemaId":"schema_1"},{"name":"pageSize","in":"query","required":false,"example":"20","schemaId":"schema_2"},{"name":"matchingType","in":"query","required":false,"example":"DEDUPLICATION","schemaId":"components/schemas/MatchingTypeParam"},{"name":"workspaceId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/WorkspaceId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","403"],"pointer":"/datamatchingdefinitions","href":"data-matching/paths/~1datamatchingdefinitions/get","summary":"List Data Matching Definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinitionPage"}},"schemaId":"components/schemas/DataMatchingDefinitionPage"},{"code":"400","description":"The sent request is malformed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"},{"code":"403","description":"Permission denied.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1datamatchingdefinitions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMatchingDefinitionPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinitionPage"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}},{"code":"403","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-matching/paths/~1datamatchingdefinitions/get"}],"panels":[]}]},"httpPath":"/datamatchingdefinitions"},{"label":"Read Data Matching Definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/data-matching/paths/~1datamatchingdefinitions~1{id}/get","routeSlug":"/apis/data-matching-api/api-v2/data-matching/paths/~1datamatchingdefinitions~1{id}/get","metadata":{"seo":{"title":"Read Data Matching Definition","description":"Read an existing Data Matching Definition by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Read Data Matching Definition","isWebhook":false,"pointer":"/paths/~1datamatchingdefinitions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read Data Matching Definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read an existing Data Matching Definition by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"ID of the Data Matching Definition.","required":true}],"pointer":"/paths/~1datamatchingdefinitions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/datamatchingdefinitions/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6461e6113b1865304b3038b6","schemaId":"components/schemas/DataMatchingDefinitionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","403"],"pointer":"/datamatchingdefinitions/{id}","href":"data-matching/paths/~1datamatchingdefinitions~1{id}/get","summary":"Read Data Matching Definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinition"}},"schemaId":"components/schemas/DataMatchingDefinition"},{"code":"400","description":"The sent request is malformed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"},{"code":"403","description":"Permission denied.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1datamatchingdefinitions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMatchingDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinition"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}},{"code":"403","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-matching/paths/~1datamatchingdefinitions~1{id}/get"}],"panels":[]}]},"httpPath":"/datamatchingdefinitions/{id}"},{"label":"Update Data Matching Definition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/data-matching/paths/~1datamatchingdefinitions~1{id}/put","routeSlug":"/apis/data-matching-api/api-v2/data-matching/paths/~1datamatchingdefinitions~1{id}/put","metadata":{"seo":{"title":"Update Data Matching Definition","description":"Update an existing Data Matching Definition with the given configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Data Matching Definition","isWebhook":false,"pointer":"/paths/~1datamatchingdefinitions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Data Matching Definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing Data Matching Definition with the given configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"ID of the Data Matching Definition.","required":true}],"pointer":"/paths/~1datamatchingdefinitions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinitionUpdate"}},"schemaId":"components/schemas/DataMatchingDefinitionUpdate","pointer":"/paths/~1datamatchingdefinitions~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/datamatchingdefinitions/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6461e6113b1865304b3038b6","schemaId":"components/schemas/DataMatchingDefinitionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinitionUpdate"}},"responseCodes":["200","400","403"],"pointer":"/datamatchingdefinitions/{id}","href":"data-matching/paths/~1datamatchingdefinitions~1{id}/put","summary":"Update Data Matching Definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"schemaId":"components/schemas/DataMatchingDefinitionUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinitionUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinition"}},"schemaId":"components/schemas/DataMatchingDefinition"},{"code":"400","description":"The sent request is malformed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"},{"code":"403","description":"Permission denied.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1datamatchingdefinitions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMatchingDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMatchingDefinition"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}},{"code":"403","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-matching/paths/~1datamatchingdefinitions~1{id}/put"}],"panels":[]}]},"httpPath":"/datamatchingdefinitions/{id}"},{"label":"Delete Data Matching Definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/data-matching/paths/~1datamatchingdefinitions~1{id}/delete","routeSlug":"/apis/data-matching-api/api-v2/data-matching/paths/~1datamatchingdefinitions~1{id}/delete","metadata":{"seo":{"title":"Delete Data Matching Definition","description":"Delete a Data Matching Definition by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete Data Matching Definition","isWebhook":false,"pointer":"/paths/~1datamatchingdefinitions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Data Matching Definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a Data Matching Definition by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"ID of the Data Matching Definition.","required":true}],"pointer":"/paths/~1datamatchingdefinitions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/datamatchingdefinitions/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6461e6113b1865304b3038b6","schemaId":"components/schemas/DataMatchingDefinitionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","403"],"pointer":"/datamatchingdefinitions/{id}","href":"data-matching/paths/~1datamatchingdefinitions~1{id}/delete","summary":"Delete Data Matching Definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The sent request is malformed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"},{"code":"403","description":"Permission denied.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1datamatchingdefinitions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}},{"code":"403","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-matching/paths/~1datamatchingdefinitions~1{id}/delete"}],"panels":[]}]},"httpPath":"/datamatchingdefinitions/{id}"}],"content":{"contentType":"group","meta":{"name":"Data Matching"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Matching","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for managing Data Matching Definitions, which are configurations for matching jobs to identify \nduplicates or link records across data sources. These endpoints support creating, reading, updating, and \ndeleting these configurations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/datamatchingdefinitions","summary":"Create Data Matching Definition","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-matching/paths/~1datamatchingdefinitions/post","deprecated":false},{"title":"/datamatchingdefinitions","summary":"List Data Matching Definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-matching/paths/~1datamatchingdefinitions/get","deprecated":false},{"title":"/datamatchingdefinitions/{id}","summary":"Read Data Matching Definition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-matching/paths/~1datamatchingdefinitions~1{id}/get","deprecated":false},{"title":"/datamatchingdefinitions/{id}","summary":"Update Data Matching Definition","prefix":{"name":"put","color":"put"},"badges":[],"link":"/data-matching/paths/~1datamatchingdefinitions~1{id}/put","deprecated":false},{"title":"/datamatchingdefinitions/{id}","summary":"Delete Data Matching Definition","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/data-matching/paths/~1datamatchingdefinitions~1{id}/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Duplicate Matching","link":"/apis/data-matching-api/api-v2/duplicate-matching","routeSlug":"/apis/data-matching-api/api-v2/duplicate-matching","items":[{"label":"Start Deduplication Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/duplicate-matching/paths/~1v2~1deduplicationjobs/post","routeSlug":"/apis/data-matching-api/api-v2/duplicate-matching/paths/~1v2~1deduplicationjobs/post","metadata":{"seo":{"title":"Start Deduplication Job","description":"Starts a Deduplication Job for the given storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Start Deduplication Job","isWebhook":false,"pointer":"/paths/~1v2~1deduplicationjobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start Deduplication Job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts a Deduplication Job for the given storage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DuplicateMatchingJobRequest"}},"schemaId":"components/schemas/DuplicateMatchingJobRequest","pointer":"/paths/~1v2~1deduplicationjobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/deduplicationjobs","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DuplicateMatchingJobRequest"}},"responseCodes":["200","401","403"],"pointer":"/v2/deduplicationjobs","href":"duplicate-matching/paths/~1v2~1deduplicationjobs/post","summary":"Start Deduplication Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"schemaId":"components/schemas/DuplicateMatchingJobRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DuplicateMatchingJobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DuplicateMatchingJob"}},"schemaId":"components/schemas/DuplicateMatchingJob"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v2~1deduplicationjobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DuplicateMatchingJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DuplicateMatchingJob"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/duplicate-matching/paths/~1v2~1deduplicationjobs/post"}],"panels":[]}]},"httpPath":"/v2/deduplicationjobs"},{"label":"Poll Deduplication Job Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/duplicate-matching/paths/~1deduplicationjobs~1{id}/get","routeSlug":"/apis/data-matching-api/api-v2/duplicate-matching/paths/~1deduplicationjobs~1{id}/get","metadata":{"seo":{"title":"Poll Deduplication Job Status","description":"Polls the status of the Deduplication Job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Poll Deduplication Job Status","isWebhook":false,"pointer":"/paths/~1deduplicationjobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll Deduplication Job Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Polls the status of the Deduplication Job."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"ID of the deduplication job.","required":true}],"pointer":"/paths/~1deduplicationjobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deduplicationjobs/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"65dcc3c60cecd503bcc88c92","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/deduplicationjobs/{id}","href":"duplicate-matching/paths/~1deduplicationjobs~1{id}/get","summary":"Poll Deduplication Job Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DuplicateMatchingJob"}},"schemaId":"components/schemas/DuplicateMatchingJob"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1deduplicationjobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DuplicateMatchingJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DuplicateMatchingJob"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/duplicate-matching/paths/~1deduplicationjobs~1{id}/get"}],"panels":[]}]},"httpPath":"/deduplicationjobs/{id}"}],"content":{"contentType":"group","meta":{"name":"Duplicate Matching"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Duplicate Matching","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for managing duplications within a single data source. These endpoints support creating \nDeduplication Job and checking the Deduplication Job Status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/deduplicationjobs","summary":"Start Deduplication Job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/duplicate-matching/paths/~1v2~1deduplicationjobs/post","deprecated":false},{"title":"/deduplicationjobs/{id}","summary":"Poll Deduplication Job Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/duplicate-matching/paths/~1deduplicationjobs~1{id}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Entity Matching","link":"/apis/data-matching-api/api-v2/entity-matching","routeSlug":"/apis/data-matching-api/api-v2/entity-matching","items":[],"content":{"contentType":"group","meta":{"name":"Entity Matching"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Entity Matching","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for matching business partners. These endpoints support matching business partners against \ndata matching definitions, ensuring comprehensive analytics for data matching activities."}],"panels":[{"children":[]}]}]}},{"type":"group","label":"Identity Resolution","link":"/apis/data-matching-api/api-v2/identity-resolution","routeSlug":"/apis/data-matching-api/api-v2/identity-resolution","items":[{"label":"Get BusinessPartner's Attribute Paths","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/identity-resolution/paths/~1entityresolution~1attributepaths/get","routeSlug":"/apis/data-matching-api/api-v2/identity-resolution/paths/~1entityresolution~1attributepaths/get","metadata":{"seo":{"title":"Get BusinessPartner's Attribute Paths","description":"Get all attribute paths of BusinessPartner."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get BusinessPartner's Attribute Paths","isWebhook":false,"pointer":"/paths/~1entityresolution~1attributepaths/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get BusinessPartner's Attribute Paths","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all attribute paths of BusinessPartner."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entityresolution/attributepaths","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/entityresolution/attributepaths","href":"identity-resolution/paths/~1entityresolution~1attributepaths/get","summary":"Get BusinessPartner's Attribute Paths"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of attribute paths","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttributePathsResult"}},"schemaId":"components/schemas/AttributePathsResult"},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"}],"pointer":"/paths/~1entityresolution~1attributepaths/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AttributePathsResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttributePathsResult"}}},{"code":"400","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"401","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"403","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"500","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity-resolution/paths/~1entityresolution~1attributepaths/get"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/entityresolution/attributepaths"},{"label":"List Available Cleaners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/identity-resolution/paths/~1entityresolution~1cleaners/get","routeSlug":"/apis/data-matching-api/api-v2/identity-resolution/paths/~1entityresolution~1cleaners/get","metadata":{"seo":{"title":"List Available Cleaners","description":"List all available cleaners for identity resolution."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Available Cleaners","isWebhook":false,"pointer":"/paths/~1entityresolution~1cleaners/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Available Cleaners","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all available cleaners for identity resolution."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entityresolution/cleaners","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/entityresolution/cleaners","href":"identity-resolution/paths/~1entityresolution~1cleaners/get","summary":"List Available Cleaners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CleanersResult","exampleIds":["paths/~1entityresolution~1cleaners/get/responses/200/content/application~1json/examples/cleaners"]}},"schemaId":"components/schemas/CleanersResult","exampleIds":["paths/~1entityresolution~1cleaners/get/responses/200/content/application~1json/examples/cleaners"]},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"}],"pointer":"/paths/~1entityresolution~1cleaners/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CleanersResult","exampleIds":["paths/~1entityresolution~1cleaners/get/responses/200/content/application~1json/examples/cleaners"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CleanersResult","exampleIds":["paths/~1entityresolution~1cleaners/get/responses/200/content/application~1json/examples/cleaners"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"401","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"403","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"500","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity-resolution/paths/~1entityresolution~1cleaners/get"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/entityresolution/cleaners"},{"label":"List Available Comparators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/identity-resolution/paths/~1entityresolution~1comparators/get","routeSlug":"/apis/data-matching-api/api-v2/identity-resolution/paths/~1entityresolution~1comparators/get","metadata":{"seo":{"title":"List Available Comparators","description":"List all available comparators for identity resolution."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Available Comparators","isWebhook":false,"pointer":"/paths/~1entityresolution~1comparators/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Available Comparators","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all available comparators for identity resolution."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entityresolution/comparators","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/entityresolution/comparators","href":"identity-resolution/paths/~1entityresolution~1comparators/get","summary":"List Available Comparators"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComparatorsResult"}},"schemaId":"components/schemas/ComparatorsResult"},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"}],"pointer":"/paths/~1entityresolution~1comparators/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ComparatorsResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComparatorsResult"}}},{"code":"400","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"401","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"403","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"500","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity-resolution/paths/~1entityresolution~1comparators/get"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/entityresolution/comparators"},{"label":"Get Available Paths","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/identity-resolution/paths/~1entityresolution~1searchattributepaths/get","routeSlug":"/apis/data-matching-api/api-v2/identity-resolution/paths/~1entityresolution~1searchattributepaths/get","metadata":{"seo":{"title":"Get Available Paths","description":"Get all available paths for search in index-api."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get Available Paths","isWebhook":false,"pointer":"/paths/~1entityresolution~1searchattributepaths/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Available Paths","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all available paths for search in index-api."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entityresolution/searchattributepaths","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/entityresolution/searchattributepaths","href":"identity-resolution/paths/~1entityresolution~1searchattributepaths/get","summary":"Get Available Paths"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of search attributes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchAttributeResult"}},"schemaId":"components/schemas/SearchAttributeResult"},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"}],"pointer":"/paths/~1entityresolution~1searchattributepaths/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchAttributeResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchAttributeResult"}}},{"code":"400","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"401","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"403","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"500","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity-resolution/paths/~1entityresolution~1searchattributepaths/get"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/entityresolution/searchattributepaths"}],"content":{"contentType":"group","meta":{"name":"Identity Resolution"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identity Resolution","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for managing identity resolution configurations and operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/entityresolution/attributepaths","summary":"Get BusinessPartner's Attribute Paths","prefix":{"name":"get","color":"get"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/identity-resolution/paths/~1entityresolution~1attributepaths/get","deprecated":false},{"title":"/entityresolution/cleaners","summary":"List Available Cleaners","prefix":{"name":"get","color":"get"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/identity-resolution/paths/~1entityresolution~1cleaners/get","deprecated":false},{"title":"/entityresolution/comparators","summary":"List Available Comparators","prefix":{"name":"get","color":"get"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/identity-resolution/paths/~1entityresolution~1comparators/get","deprecated":false},{"title":"/entityresolution/searchattributepaths","summary":"Get Available Paths","prefix":{"name":"get","color":"get"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/identity-resolution/paths/~1entityresolution~1searchattributepaths/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Linkage Matching","link":"/apis/data-matching-api/api-v2/linkage-matching","routeSlug":"/apis/data-matching-api/api-v2/linkage-matching","items":[{"label":"Start Linkage Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/linkage-matching/paths/~1linkagejobs/post","routeSlug":"/apis/data-matching-api/api-v2/linkage-matching/paths/~1linkagejobs/post","metadata":{"seo":{"title":"Start Linkage Job","description":"Initiate a new linkage job"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Start Linkage Job","isWebhook":false,"pointer":"/paths/~1linkagejobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start Linkage Job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiate a new linkage job"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkMatchingJobRequest"}},"schemaId":"components/schemas/LinkMatchingJobRequest","pointer":"/paths/~1linkagejobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/linkagejobs","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LinkMatchingJobRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/linkagejobs","href":"linkage-matching/paths/~1linkagejobs/post","summary":"Start Linkage Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"schemaId":"components/schemas/LinkMatchingJobRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkMatchingJobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LinkMatchingJob"}},"schemaId":"components/schemas/LinkMatchingJob"},{"code":"400","description":"The sent request is malformed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1linkagejobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LinkMatchingJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LinkMatchingJob"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/linkage-matching/paths/~1linkagejobs/post"}],"panels":[]}]},"httpPath":"/linkagejobs"},{"label":"Poll Linkage Job Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/linkage-matching/paths/~1linkagejobs~1{id}/get","routeSlug":"/apis/data-matching-api/api-v2/linkage-matching/paths/~1linkagejobs~1{id}/get","metadata":{"seo":{"title":"Poll Linkage Job Status","description":"Check the status of a linkage job by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Poll Linkage Job Status","isWebhook":false,"pointer":"/paths/~1linkagejobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll Linkage Job Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Check the status of a linkage job by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"ID of the linkage job.","required":true}],"pointer":"/paths/~1linkagejobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/linkagejobs/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"65dcc3c60cecd503bcc88c92","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/linkagejobs/{id}","href":"linkage-matching/paths/~1linkagejobs~1{id}/get","summary":"Poll Linkage Job Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LinkMatchingJob"}},"schemaId":"components/schemas/LinkMatchingJob"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1linkagejobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LinkMatchingJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LinkMatchingJob"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/linkage-matching/paths/~1linkagejobs~1{id}/get"}],"panels":[]}]},"httpPath":"/linkagejobs/{id}"}],"content":{"contentType":"group","meta":{"name":"Linkage Matching"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Linkage Matching","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for managing linkages across multiple data sources. These endpoints support creating \nLinkage Job and checking the Linkage Job Status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/linkagejobs","summary":"Start Linkage Job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linkage-matching/paths/~1linkagejobs/post","deprecated":false},{"title":"/linkagejobs/{id}","summary":"Poll Linkage Job Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/linkage-matching/paths/~1linkagejobs~1{id}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Public","link":"/apis/data-matching-api/api-v2/public","routeSlug":"/apis/data-matching-api/api-v2/public","items":[{"label":"Poll Matching Reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/public/paths/~1matchingreports~1{id}/get","routeSlug":"/apis/data-matching-api/api-v2/public/paths/~1matchingreports~1{id}/get","metadata":{"seo":{"title":"Poll Matching Reports","description":"Polls the status of the matching reports."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Poll Matching Reports","isWebhook":false,"pointer":"/paths/~1matchingreports~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll Matching Reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Polls the status of the matching reports."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"ID of the matching report.","required":true,"example":"65dcc3c60cecd503bcc88c92"}],"pointer":"/paths/~1matchingreports~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/matchingreports/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"65dcc3c60cecd503bcc88c92","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/matchingreports/{id}","href":"public/paths/~1matchingreports~1{id}/get","summary":"Poll Matching Reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingReports"}},"schemaId":"components/schemas/MatchingReports"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1matchingreports~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MatchingReports","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingReports"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/public/paths/~1matchingreports~1{id}/get"}],"panels":[]}]},"httpPath":"/matchingreports/{id}"}],"content":{"contentType":"group","meta":{"name":"Public"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Public","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for polling the Matching Reports."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/matchingreports/{id}","summary":"Poll Matching Reports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/public/paths/~1matchingreports~1{id}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"User Feedback","link":"/apis/data-matching-api/api-v2/user-feedback","routeSlug":"/apis/data-matching-api/api-v2/user-feedback","items":[{"label":"Matching Decision Import","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/user-feedback/paths/~1matchingdecisionjobs/post","routeSlug":"/apis/data-matching-api/api-v2/user-feedback/paths/~1matchingdecisionjobs/post","metadata":{"seo":{"title":"Matching Decision Import","description":"To start importing an Identity Linkage Decision import file, use the following request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Matching Decision Import","isWebhook":false,"pointer":"/paths/~1matchingdecisionjobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Matching Decision Import","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To start importing an Identity Linkage Decision import file, use the following request."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST https://api.corporate-data-league.ch/data-matching/rest/jobs/matchingdecisionjobs\n  ?file=@{YOUR FILE}\n  ?decisionLogId={YOUR MatchingDecisionLog ID}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST https://api.corporate-data-league.ch/data-matching/rest/jobs/matchingdecisionjobs\n  ?file=@{YOUR FILE}\n  ?decisionLogId={YOUR MatchingDecisionLog ID}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With using output file from duplication or linkage job."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please remember not to remove the mandatory columns when modifying this file: No Match Feedback, Matching Group, Storage ID, Data Source ID, Record ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response is shown below. Use the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-matching-api/api-v2/user-feedback/paths/~1matchingdecisionjobs~1%7Bid%7D/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"poll"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the import job status."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"id\" : \"{YOUR JOB ID}\"\n    ...\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"id\" : \"{YOUR JOB ID}\"\n    ...\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This import leads to the following link in the MatchingDecisionLog."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n   \"id\" : \"{AUTO GENERATED}\",\n   \"decisionLogId\" : \"b7d528eace273a10aeb00825f48b5b18\",\n   \"entities\" : [{\n       \"storageId\": \"b7d528eace273a10aeb00825f48b5b18\",\n       \"dataSourceId\": \"5f9fc1b97e1e490001fcfc9e\",\n       \"businessPartnerId\": \"5e60dfdbd5fa2d000166ab4a\"\n     },\n     {\n       \"storageId\": \"b7d528eace273a10aeb00825f48b5b18\",\n       \"dataSourceId\": \"5f9fc1b97e1e490001fcfc9e\",\n       \"businessPartnerId\": \"5e60dfdbd5fa2d000166ab4b\"\n     }]\n }\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n   \"id\" : \"{AUTO GENERATED}\",\n   \"decisionLogId\" : \"b7d528eace273a10aeb00825f48b5b18\",\n   \"entities\" : [{\n       \"storageId\": \"b7d528eace273a10aeb00825f48b5b18\",\n       \"dataSourceId\": \"5f9fc1b97e1e490001fcfc9e\",\n       \"businessPartnerId\": \"5e60dfdbd5fa2d000166ab4a\"\n     },\n     {\n       \"storageId\": \"b7d528eace273a10aeb00825f48b5b18\",\n       \"dataSourceId\": \"5f9fc1b97e1e490001fcfc9e\",\n       \"businessPartnerId\": \"5e60dfdbd5fa2d000166ab4b\"\n     }]\n }\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_6"}},"schemaId":"schema_6","pointer":"/paths/~1matchingdecisionjobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/matchingdecisionjobs","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_6"}},"responseCodes":["200","400"],"pointer":"/matchingdecisionjobs","href":"user-feedback/paths/~1matchingdecisionjobs/post","summary":"Matching Decision Import"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"schemaId":"schema_6","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_6"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingDecisionImportJob"}},"schemaId":"components/schemas/MatchingDecisionImportJob"},{"code":"400","description":"The sent request is malformed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1matchingdecisionjobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MatchingDecisionImportJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingDecisionImportJob"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-feedback/paths/~1matchingdecisionjobs/post"}],"panels":[]}]},"httpPath":"/matchingdecisionjobs"},{"label":"Matching Decision Import Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/user-feedback/paths/~1matchingdecisionjobs~1{id}/get","routeSlug":"/apis/data-matching-api/api-v2/user-feedback/paths/~1matchingdecisionjobs~1{id}/get","metadata":{"seo":{"title":"Matching Decision Import Status","description":"Polls the status of the matching decision import job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Matching Decision Import Status","isWebhook":false,"pointer":"/paths/~1matchingdecisionjobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Matching Decision Import Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Polls the status of the matching decision import job.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"ID of the Matching Decision Import Job.","required":true}],"pointer":"/paths/~1matchingdecisionjobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/matchingdecisionjobs/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"65dcc3c60cecd503bcc88c92","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/matchingdecisionjobs/{id}","href":"user-feedback/paths/~1matchingdecisionjobs~1{id}/get","summary":"Matching Decision Import Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingDecisionImportJob"}},"schemaId":"components/schemas/MatchingDecisionImportJob"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1matchingdecisionjobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MatchingDecisionImportJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingDecisionImportJob"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-feedback/paths/~1matchingdecisionjobs~1{id}/get"}],"panels":[]}]},"httpPath":"/matchingdecisionjobs/{id}"},{"label":"List User Feedbacks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks/get","routeSlug":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks/get","metadata":{"seo":{"title":"List User Feedbacks","description":"Read available Matching Decision Logs across your organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List User Feedbacks","isWebhook":false,"pointer":"/paths/~1userfeedbacks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List User Feedbacks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read available Matching Decision Logs across your organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startAfter","in":"query","schemaId":"schema_7","description":"Indicator for the next page. Used together with nextStartAfter from the result."},{"name":"limit","in":"query","schemaId":"schema_8","description":"Number of items to be returned."},{"name":"featuresOn","in":"query","schemaId":"schema_9","description":"Enable additional features for User Feedbacks."}],"pointer":"/paths/~1userfeedbacks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/userfeedbacks","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"components/schemas/StartAfter"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"schema_8"},{"name":"featuresOn","in":"query","required":false,"schemaId":"schema_9"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","201","401","403","404"],"pointer":"/userfeedbacks","href":"user-feedback/paths/~1userfeedbacks/get","summary":"List User Feedbacks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingDecisionLogs"}},"schemaId":"components/schemas/MatchingDecisionLogs"},{"code":"201","description":"Created"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1userfeedbacks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MatchingDecisionLogs","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingDecisionLogs"}}},{"code":"201"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-feedback/paths/~1userfeedbacks/get"}],"panels":[]}]},"httpPath":"/userfeedbacks"},{"label":"Create User Feedback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks/post","routeSlug":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks/post","metadata":{"seo":{"title":"Create User Feedback","description":"Create Matching Decision Log where decisions will be stored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create User Feedback","isWebhook":false,"pointer":"/paths/~1userfeedbacks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create User Feedback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create Matching Decision Log where decisions will be stored."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MatchingDecisionLogCreateRequest"}},"schemaId":"components/schemas/MatchingDecisionLogCreateRequest","pointer":"/paths/~1userfeedbacks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/userfeedbacks","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MatchingDecisionLogCreateRequest"}},"responseCodes":["200","401","403"],"pointer":"/userfeedbacks","href":"user-feedback/paths/~1userfeedbacks/post","summary":"Create User Feedback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"schemaId":"components/schemas/MatchingDecisionLogCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MatchingDecisionLogCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingDecisionLog"}},"schemaId":"components/schemas/MatchingDecisionLog"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1userfeedbacks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MatchingDecisionLog","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingDecisionLog"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-feedback/paths/~1userfeedbacks/post"}],"panels":[]}]},"httpPath":"/userfeedbacks"},{"label":"Read User Feedback","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks~1{id}/get","routeSlug":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks~1{id}/get","metadata":{"seo":{"title":"Read User Feedback","description":"Read Matching Decision Logs details provided by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Read User Feedback","isWebhook":false,"pointer":"/paths/~1userfeedbacks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read User Feedback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read Matching Decision Logs details provided by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_10","description":"ID of the Matching Decision Log.","required":true}],"pointer":"/paths/~1userfeedbacks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/userfeedbacks/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"9cfa14e7-51f5-4490-88e4-667501575b41","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","201","401","403","404"],"pointer":"/userfeedbacks/{id}","href":"user-feedback/paths/~1userfeedbacks~1{id}/get","summary":"Read User Feedback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingDecisionLogResult"}},"schemaId":"components/schemas/MatchingDecisionLogResult"},{"code":"201","description":"Created"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1userfeedbacks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MatchingDecisionLogResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MatchingDecisionLogResult"}}},{"code":"201"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-feedback/paths/~1userfeedbacks~1{id}/get"}],"panels":[]}]},"httpPath":"/userfeedbacks/{id}"},{"label":"Create Identity Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks~1{id}/post","routeSlug":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks~1{id}/post","metadata":{"seo":{"title":"Create Identity Link","description":"Add Identity Links to the Matching Decision Log identified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create Identity Link","isWebhook":false,"pointer":"/paths/~1userfeedbacks~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Identity Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add Identity Links to the Matching Decision Log identified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_10","description":"ID of the Matching Decision Log.","required":true}],"pointer":"/paths/~1userfeedbacks~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityLinkCreateRequest"}},"schemaId":"components/schemas/IdentityLinkCreateRequest","pointer":"/paths/~1userfeedbacks~1{id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/userfeedbacks/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"9cfa14e7-51f5-4490-88e4-667501575b41","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IdentityLinkCreateRequest"}},"responseCodes":["200","401","403"],"pointer":"/userfeedbacks/{id}","href":"user-feedback/paths/~1userfeedbacks~1{id}/post","summary":"Create Identity Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"schemaId":"components/schemas/IdentityLinkCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityLinkCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityLinkCreateResult"}},"schemaId":"components/schemas/IdentityLinkCreateResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1userfeedbacks~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdentityLinkCreateResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityLinkCreateResult"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-feedback/paths/~1userfeedbacks~1{id}/post"}],"panels":[]}]},"httpPath":"/userfeedbacks/{id}"},{"label":"Delete User Feedback","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks~1{id}/delete","routeSlug":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks~1{id}/delete","metadata":{"seo":{"title":"Delete User Feedback","description":"Delete the Matching Decision Log identified by ID. !Warning! action cannot be reverted!"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete User Feedback","isWebhook":false,"pointer":"/paths/~1userfeedbacks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete User Feedback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete the Matching Decision Log identified by ID. !Warning! action cannot be reverted!"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_10","description":"ID of the Matching Decision Log.","required":true}],"pointer":"/paths/~1userfeedbacks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/userfeedbacks/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"9cfa14e7-51f5-4490-88e4-667501575b41","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","403"],"pointer":"/userfeedbacks/{id}","href":"user-feedback/paths/~1userfeedbacks~1{id}/delete","summary":"Delete User Feedback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The sent request is malformed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"},{"code":"403","description":"Permission denied.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1userfeedbacks~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}},{"code":"403","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-feedback/paths/~1userfeedbacks~1{id}/delete"}],"panels":[]}]},"httpPath":"/userfeedbacks/{id}"},{"label":"Clear User Feedback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks~1{id}~1clear/post","routeSlug":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks~1{id}~1clear/post","metadata":{"seo":{"title":"Clear User Feedback","description":"Remove all links from the Matching Decision Log identified by ID. !Warning! action cannot be reverted!"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Clear User Feedback","isWebhook":false,"pointer":"/paths/~1userfeedbacks~1{id}~1clear/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear User Feedback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove all links from the Matching Decision Log identified by ID. !Warning! action cannot be reverted!"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_10","description":"ID of the Matching Decision Log.","required":true}],"pointer":"/paths/~1userfeedbacks~1{id}~1clear/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/userfeedbacks/{id}/clear","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"9cfa14e7-51f5-4490-88e4-667501575b41","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","201","401","403","404"],"pointer":"/userfeedbacks/{id}/clear","href":"user-feedback/paths/~1userfeedbacks~1{id}~1clear/post","summary":"Clear User Feedback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"201","description":"Created"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1userfeedbacks~1{id}~1clear/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-feedback/paths/~1userfeedbacks~1{id}~1clear/post"}],"panels":[]}]},"httpPath":"/userfeedbacks/{id}/clear"},{"label":"List Identity Links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks~1identitylinks/get","routeSlug":"/apis/data-matching-api/api-v2/user-feedback/paths/~1userfeedbacks~1identitylinks/get","metadata":{"seo":{"title":"List Identity Links","description":"Read Identity Links from the Matching Decision Log identified by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Identity Links","isWebhook":false,"pointer":"/paths/~1userfeedbacks~1identitylinks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Identity Links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read Identity Links from the Matching Decision Log identified by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startAfter","in":"query","schemaId":"schema_7","description":"Indicator for the next page. Used together with nextStartAfter from the result."},{"name":"limit","in":"query","schemaId":"schema_8","description":"Number of items to be returned."},{"name":"linkStorageId","in":"query","schemaId":"schema_11","description":"Link Storage Id.","required":true},{"name":"storageId","in":"query","schemaId":"schema_12","description":"Unique Storage identifier."},{"name":"dataSourceId","in":"query","schemaId":"schema_13","description":"Unique Storage's Data Source identifier."},{"name":"businessPartnerId","in":"query","schemaId":"schema_14","description":"Business Partner ID provided by CDQ that is unique across all stored Business Partners in CDQ Cloud. Used to filter results by this ID."}],"pointer":"/paths/~1userfeedbacks~1identitylinks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/userfeedbacks/identitylinks","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"components/schemas/StartAfter"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"schema_8"},{"name":"linkStorageId","in":"query","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"schema_11"},{"name":"storageId","in":"query","required":false,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"dataSourceId","in":"query","required":false,"example":"648824a691d8d2503d65103e","schemaId":"components/schemas/BusinessPartnerStorageDataSourceId"},{"name":"businessPartnerId","in":"query","required":false,"example":"63e635235c06b7396330fe40","schemaId":"components/schemas/BusinessPartnerId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","201","401","403","404"],"pointer":"/userfeedbacks/identitylinks","href":"user-feedback/paths/~1userfeedbacks~1identitylinks/get","summary":"List Identity Links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityLinks"}},"schemaId":"components/schemas/IdentityLinks"},{"code":"201","description":"Created"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1userfeedbacks~1identitylinks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdentityLinks","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityLinks"}}},{"code":"201"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-feedback/paths/~1userfeedbacks~1identitylinks/get"}],"panels":[]}]},"httpPath":"/userfeedbacks/identitylinks"}],"content":{"contentType":"group","meta":{"name":"User Feedback"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Feedback","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for managing user feedback related to data matching decisions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/matchingdecisionjobs","summary":"Matching Decision Import","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-feedback/paths/~1matchingdecisionjobs/post","deprecated":false},{"title":"/matchingdecisionjobs/{id}","summary":"Matching Decision Import Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-feedback/paths/~1matchingdecisionjobs~1{id}/get","deprecated":false},{"title":"/userfeedbacks","summary":"List User Feedbacks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-feedback/paths/~1userfeedbacks/get","deprecated":false},{"title":"/userfeedbacks","summary":"Create User Feedback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-feedback/paths/~1userfeedbacks/post","deprecated":false},{"title":"/userfeedbacks/{id}","summary":"Read User Feedback","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-feedback/paths/~1userfeedbacks~1{id}/get","deprecated":false},{"title":"/userfeedbacks/{id}","summary":"Create Identity Link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-feedback/paths/~1userfeedbacks~1{id}/post","deprecated":false},{"title":"/userfeedbacks/{id}","summary":"Delete User Feedback","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-feedback/paths/~1userfeedbacks~1{id}/delete","deprecated":false},{"title":"/userfeedbacks/{id}/clear","summary":"Clear User Feedback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-feedback/paths/~1userfeedbacks~1{id}~1clear/post","deprecated":false},{"title":"/userfeedbacks/identitylinks","summary":"List Identity Links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-feedback/paths/~1userfeedbacks~1identitylinks/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Duplicate Links","link":"/apis/data-matching-api/api-v2/duplicate-links","routeSlug":"/apis/data-matching-api/api-v2/duplicate-links","items":[],"content":{"contentType":"group","meta":{"name":"Duplicate Links"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Duplicate Links","showPageActions":true}],"panels":[{"children":[]}]}]}},{"type":"group","label":"Configurations","link":"/apis/data-matching-api/api-v2/configurations","routeSlug":"/apis/data-matching-api/api-v2/configurations","items":[{"label":"List Identity Resolution Configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/configurations/paths/~1configurations~1entityresolution/get","routeSlug":"/apis/data-matching-api/api-v2/configurations/paths/~1configurations~1entityresolution/get","metadata":{"seo":{"title":"List Identity Resolution Configurations","description":"List all identity resolution configurations of the current user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Identity Resolution Configurations","isWebhook":false,"pointer":"/paths/~1configurations~1entityresolution/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Identity Resolution Configurations","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all identity resolution configurations of the current user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_18","description":"Maximum number of configurations to return. Used for pagination."},{"name":"startAfter","in":"query","schemaId":"schema_7","description":"ID of the last configuration returned in the previous request. Used for pagination."},{"name":"defaultConfiguration","in":"query","schemaId":"schema_19","description":"Limit search to configurations with provided default flag value. If left empty, all configurations will be returned."},{"name":"clientId","in":"query","schemaId":"schema_20","description":"API Key ID or Client ID. When present returns only configurations assigned to the given API key."}],"pointer":"/paths/~1configurations~1entityresolution/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/configurations/entityresolution","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"100","schemaId":"components/schemas/Limit"},{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"components/schemas/StartAfter"},{"name":"defaultConfiguration","in":"query","required":false,"example":true,"schemaId":"schema_19"},{"name":"clientId","in":"query","required":false,"example":"12345678-1234-5678-1234-567812345678","schemaId":"schema_20"},{"name":"workspaceId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/WorkspaceId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/configurations/entityresolution","href":"configurations/paths/~1configurations~1entityresolution/get","summary":"List Identity Resolution Configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1entityresolution/get/responses/200/content/application~1json/examples/identityResolutionConfigurations"]}},"schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1entityresolution/get/responses/200/content/application~1json/examples/identityResolutionConfigurations"]},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"401","description":"Unauthorized access.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"}],"pointer":"/paths/~1configurations~1entityresolution/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1entityresolution/get/responses/200/content/application~1json/examples/identityResolutionConfigurations"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResponsePage","exampleIds":["paths/~1configurations~1entityresolution/get/responses/200/content/application~1json/examples/identityResolutionConfigurations"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"401","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"403","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"500","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurations/paths/~1configurations~1entityresolution/get"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/configurations/entityresolution"},{"label":"Read Identity Resolution Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/configurations/paths/~1configurations~1entityresolution~1{configurationid}/get","routeSlug":"/apis/data-matching-api/api-v2/configurations/paths/~1configurations~1entityresolution~1{configurationid}/get","metadata":{"seo":{"title":"Read Identity Resolution Configuration","description":"Read an identity resolution configuration of the current user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Read Identity Resolution Configuration","isWebhook":false,"pointer":"/paths/~1configurations~1entityresolution~1{configurationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read Identity Resolution Configuration","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read an identity resolution configuration of the current user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"configurationId","in":"path","schemaId":"schema_21","description":"ID of the configuration.","required":true}],"pointer":"/paths/~1configurations~1entityresolution~1{configurationId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[],"pointer":"/paths/~1configurations~1entityresolution~1{configurationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/configurations/entityresolution/{configurationId}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"configurationId","in":"path","required":true,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"schema_21"}],"query":[{"name":"workspaceId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/WorkspaceId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/configurations/entityresolution/{configurationId}","href":"configurations/paths/~1configurations~1entityresolution~1{configurationid}/get","summary":"Read Identity Resolution Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResponse","exampleIds":["paths/~1configurations~1entityresolution~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration"]}},"schemaId":"components/schemas/WorkspaceConfigurationResponse","exampleIds":["paths/~1configurations~1entityresolution~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration"]},{"code":"400","description":"Bad request, for example, missing organization ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"401","description":"Unauthorized access.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"}],"pointer":"/paths/~1configurations~1entityresolution~1{configurationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkspaceConfigurationResponse","exampleIds":["paths/~1configurations~1entityresolution~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationResponse","exampleIds":["paths/~1configurations~1entityresolution~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"401","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"403","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"500","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurations/paths/~1configurations~1entityresolution~1{configurationid}/get"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/configurations/entityresolution/{configurationId}"},{"label":"Read Identity Resolution Configuration Version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/configurations/paths/~1configurations~1entityresolution~1{configurationid}~1versions~1{version}/get","routeSlug":"/apis/data-matching-api/api-v2/configurations/paths/~1configurations~1entityresolution~1{configurationid}~1versions~1{version}/get","metadata":{"seo":{"title":"Read Identity Resolution Configuration Version","description":"Read a specific version of an identity resolution configuration by id and version number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Read Identity Resolution Configuration Version","isWebhook":false,"pointer":"/paths/~1configurations~1entityresolution~1{configurationId}~1versions~1{version}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read Identity Resolution Configuration Version","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read a specific version of an identity resolution configuration by id and version number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"configurationId","in":"path","schemaId":"schema_21","description":"ID of the configuration.","required":true},{"name":"version","in":"path","schemaId":"schema_24","description":"Version number of the configuration.","required":true}],"pointer":"/paths/~1configurations~1entityresolution~1{configurationId}~1versions~1{version}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[],"pointer":"/paths/~1configurations~1entityresolution~1{configurationId}~1versions~1{version}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/configurations/entityresolution/{configurationId}/versions/{version}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"configurationId","in":"path","required":true,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"schema_21"},{"name":"version","in":"path","required":true,"example":1,"schemaId":"schema_24"}],"query":[{"name":"workspaceId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/WorkspaceId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/configurations/entityresolution/{configurationId}/versions/{version}","href":"configurations/paths/~1configurations~1entityresolution~1{configurationid}~1versions~1{version}/get","summary":"Read Identity Resolution Configuration Version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationVersionResponse","exampleIds":["paths/~1configurations~1entityresolution~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationInGivenVersion"]}},"schemaId":"components/schemas/WorkspaceConfigurationVersionResponse","exampleIds":["paths/~1configurations~1entityresolution~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationInGivenVersion"]}],"pointer":"/paths/~1configurations~1entityresolution~1{configurationId}~1versions~1{version}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkspaceConfigurationVersionResponse","exampleIds":["paths/~1configurations~1entityresolution~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationInGivenVersion"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceConfigurationVersionResponse","exampleIds":["paths/~1configurations~1entityresolution~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationInGivenVersion"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurations/paths/~1configurations~1entityresolution~1{configurationid}~1versions~1{version}/get"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/configurations/entityresolution/{configurationId}/versions/{version}"}],"content":{"contentType":"group","meta":{"name":"Configurations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configurations","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/configurations/entityresolution","summary":"List Identity Resolution Configurations","prefix":{"name":"get","color":"get"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/configurations/paths/~1configurations~1entityresolution/get","deprecated":false},{"title":"/configurations/entityresolution/{configurationId}","summary":"Read Identity Resolution Configuration","prefix":{"name":"get","color":"get"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/configurations/paths/~1configurations~1entityresolution~1{configurationid}/get","deprecated":false},{"title":"/configurations/entityresolution/{configurationId}/versions/{version}","summary":"Read Identity Resolution Configuration Version","prefix":{"name":"get","color":"get"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/configurations/paths/~1configurations~1entityresolution~1{configurationid}~1versions~1{version}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Identity Link Storage","link":"/apis/data-matching-api/api-v2/identity-link-storage","routeSlug":"/apis/data-matching-api/api-v2/identity-link-storage","items":[],"content":{"contentType":"group","meta":{"name":"Identity Link Storage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identity Link Storage","showPageActions":true}],"panels":[{"children":[]}]}]}},{"type":"group","label":"Entity Matching Links","link":"/apis/data-matching-api/api-v2/entity-matching-links","routeSlug":"/apis/data-matching-api/api-v2/entity-matching-links","items":[{"label":"Retrieve duplicate business partner records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/entity-matching-links/paths/~1entityresolution~1entitymatchinglinks/get","routeSlug":"/apis/data-matching-api/api-v2/entity-matching-links/paths/~1entityresolution~1entitymatchinglinks/get","metadata":{"seo":{"title":"Retrieve duplicate business partner records","description":"Returns a paginated list of potential duplicate business partner records based on search criteria"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieve duplicate business partner records","isWebhook":false,"pointer":"/paths/~1entityresolution~1entitymatchinglinks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve duplicate business partner records","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of potential duplicate business partner records based on search criteria"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"matchingScore","in":"query","schemaId":"schema_27","description":"Minimum matching score threshold","required":true},{"name":"dataMonitorId","in":"query","schemaId":"schema_11","description":"Unique Data Monitor identifier","required":true},{"name":"businessPartnerIds","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return only entity matching links associated with the specified Business Partner IDs. Provide an array of Business Partner IDs to filter the results. Maximum 500 IDs can be specified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To provide multiple values, use a comma-separated list: businessPartnerIds=bpId1,bpId2."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also pass them separately as multiple query parameters: businessPartnerIds=bpId1&businessPartnerIds=bpId2."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_29","description":"Status of the entity matching link"},{"name":"limit","in":"query","schemaId":"schema_30","description":"Number of items to be returned."},{"name":"startAfter","in":"query","schemaId":"schema_7","description":"Indicator for the next page. Used together with nextStartAfter from the result."},{"name":"featuresOn","in":"query","schemaId":"schema_31","description":"Enable additional features for entity matching links."},{"name":"dataSourceId","in":"query","schemaId":"schema_13","description":"Unique Storage's Data Source identifier."},{"name":"createdBefore","in":"query","schemaId":"schema_32","description":"Return entries which were created before given date. The given date should support ISO-8601 representation."},{"name":"createdAfter","in":"query","schemaId":"schema_32","description":"Return entries which were created after given date. The given date should support ISO-8601 representation."},{"name":"externalIds","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner externalIDs. To provide multiple values, use a comma-separated list: externalIds=extId1,extId2."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also pass them separately as multiple query parameters: externalIds=extId1&externalIds=extId2."},"children":[]}]}]}]},{"name":"confidenceStatus","in":"query","schemaId":"schema_34","description":"Filter by link confidence status."},{"name":"sort","in":"query","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the attributes to sort by. Supported attribute is 'matchingScore'. Sort direction can be specified in front of each attribute. '+' means ascending, '-' means descending. If direction is not given default sort is '-matchingScore'."},"children":[]}]}]}]}],"pointer":"/paths/~1entityresolution~1entitymatchinglinks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entityresolution/entitymatchinglinks","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"matchingScore","in":"query","required":true,"example":0.8,"schemaId":"schema_27"},{"name":"dataMonitorId","in":"query","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"schema_11"},{"name":"businessPartnerIds","in":"query","required":false,"schemaId":"schema_28"},{"name":"status","in":"query","required":false,"example":"INFERRED","schemaId":"components/schemas/LinkStatusEnum"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"schema_30"},{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"components/schemas/StartAfter"},{"name":"featuresOn","in":"query","required":false,"schemaId":"schema_31"},{"name":"dataSourceId","in":"query","required":false,"example":"648824a691d8d2503d65103e","schemaId":"components/schemas/BusinessPartnerStorageDataSourceId"},{"name":"createdBefore","in":"query","required":false,"example":"2026-11-11T03:23:28Z","schemaId":"schema_32"},{"name":"createdAfter","in":"query","required":false,"example":"2026-11-11T03:23:28Z","schemaId":"schema_32"},{"name":"externalIds","in":"query","required":false,"schemaId":"schema_33"},{"name":"confidenceStatus","in":"query","required":false,"example":"MATCH","schemaId":"components/schemas/EntityMatchingStatusParam"},{"name":"sort","in":"query","required":false,"example":"-matchingScore","schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/entityresolution/entitymatchinglinks","href":"entity-matching-links/paths/~1entityresolution~1entitymatchinglinks/get","summary":"Retrieve duplicate business partner records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with list of duplicates","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityMatchingLinks","exampleIds":["paths/~1entityresolution~1entitymatchinglinks/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/EntityMatchingLinks","exampleIds":["paths/~1entityresolution~1entitymatchinglinks/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"}],"pointer":"/paths/~1entityresolution~1entitymatchinglinks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityMatchingLinks","exampleIds":["paths/~1entityresolution~1entitymatchinglinks/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityMatchingLinks","exampleIds":["paths/~1entityresolution~1entitymatchinglinks/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"401","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"403","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"500","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entity-matching-links/paths/~1entityresolution~1entitymatchinglinks/get"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/entityresolution/entitymatchinglinks"},{"label":"Update entity matching link status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-matching-api/api-v2/entity-matching-links/paths/~1entityresolution~1entitymatchinglinks~1{id}/patch","routeSlug":"/apis/data-matching-api/api-v2/entity-matching-links/paths/~1entityresolution~1entitymatchinglinks~1{id}/patch","metadata":{"seo":{"title":"Update entity matching link status","description":"Update the link status of an entity matching link. Allows changing status from:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update entity matching link status","isWebhook":false,"pointer":"/paths/~1entityresolution~1entitymatchinglinks~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update entity matching link status","badges":[{"name":"BETA","color":"blue","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the link status of an entity matching link. Allows changing status from:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INFERRED to RETRACTED or ASSERTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETRACTED to ASSERTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASSERTED to RETRACTED"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Cannot change status back to INFERRED once it has been manually modified."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_36","description":"ID of the entity matching link to update","required":true}],"pointer":"/paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityMatchingLinkUpdate","exampleIds":["paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/retract_link","paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/assert_link","paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/no_comment"]}},"schemaId":"components/schemas/EntityMatchingLinkUpdate","exampleIds":["paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/retract_link","paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/assert_link","paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/no_comment"],"pointer":"/paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/entityresolution/entitymatchinglinks/{id}","servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"5712566172571652","schemaId":"components/schemas/EntityMatchingLinkId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EntityMatchingLinkUpdate","exampleIds":["paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/retract_link","paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/assert_link","paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/no_comment"]}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/entityresolution/entitymatchinglinks/{id}","href":"entity-matching-links/paths/~1entityresolution~1entitymatchinglinks~1{id}/patch","summary":"Update entity matching link status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"schemaId":"components/schemas/EntityMatchingLinkUpdate","exampleIds":["paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/retract_link","paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/assert_link","paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/no_comment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityMatchingLinkUpdate","exampleIds":["paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/retract_link","paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/assert_link","paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/no_comment"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated entity matching link","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityMatchingLinkUpdateResult"}},"schemaId":"components/schemas/EntityMatchingLinkUpdateResult"},{"code":"400","description":"Invalid request parameters or invalid status transition","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"404","description":"Entity matching link not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}},"schemaId":"components/schemas/ApiErrorWithStatus"}],"pointer":"/paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityMatchingLinkUpdateResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityMatchingLinkUpdateResult"}}},{"code":"400","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"401","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"403","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"404","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}},{"code":"500","schemaId":"components/schemas/ApiErrorWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorWithStatus"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entity-matching-links/paths/~1entityresolution~1entitymatchinglinks~1{id}/patch"}],"panels":[]}]},"badges":[{"name":"BETA","color":"blue","position":"after"}],"httpPath":"/entityresolution/entitymatchinglinks/{id}"}],"content":{"contentType":"group","meta":{"name":"Entity Matching Links"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Entity Matching Links","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/entityresolution/entitymatchinglinks","summary":"Retrieve duplicate business partner records","prefix":{"name":"get","color":"get"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/entity-matching-links/paths/~1entityresolution~1entitymatchinglinks/get","deprecated":false},{"title":"/entityresolution/entitymatchinglinks/{id}","summary":"Update entity matching link status","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"BETA","color":"blue","position":"after"}],"link":"/entity-matching-links/paths/~1entityresolution~1entitymatchinglinks~1{id}/patch","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/DuplicateMatchingRequests":{"id":"components/schemas/DuplicateMatchingRequests","kind":"json-schema","title":"DuplicateMatchingRequests","data":{"description":"Duplicate Matching requests","type":"object","properties":{"requests":{"type":"array","items":{"$ref":"#/components/schemas/DuplicateMatchingRequest"}}}}},"components/schemas/DuplicateMatchingRequest":{"id":"components/schemas/DuplicateMatchingRequest","kind":"json-schema","title":"DuplicateMatchingRequest","data":{"type":"object","description":"Duplicate Matching request","properties":{"businessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerId"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"businessPartnerExternalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"businessPartner":{"$ref":"#/components/schemas/schemas-BusinessPartner"}}}},"components/schemas/DuplicateMatchingResults":{"id":"components/schemas/DuplicateMatchingResults","kind":"json-schema","title":"DuplicateMatchingResults","data":{"description":"Results of duplicate matching","type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/DuplicateMatchingResult"}}}}},"components/schemas/DuplicateMatchingResult":{"id":"components/schemas/DuplicateMatchingResult","kind":"json-schema","title":"DuplicateMatchingResult","data":{"description":"Result of duplicate matching","type":"object","properties":{"businessPartner":{"$ref":"#/components/schemas/DuplicateMatchResultEntity"},"duplicateMatches":{"$ref":"#/components/schemas/DuplicateMatchResults"}}}},"components/schemas/DuplicateMatchResults":{"id":"components/schemas/DuplicateMatchResults","kind":"json-schema","title":"DuplicateMatchResults","data":{"type":"object","description":"Duplicate Match results.","properties":{"duplicateMatches":{"type":"array","description":"List of duplicate matches.","items":{"$ref":"#/components/schemas/DuplicateMatchResult"}}}}},"components/schemas/DuplicateMatchResult":{"id":"components/schemas/DuplicateMatchResult","kind":"json-schema","title":"DuplicateMatchResult","data":{"type":"object","description":"Duplicate Match result.","properties":{"entity":{"$ref":"#/components/schemas/DuplicateMatchResultEntity"},"confidence":{"$ref":"#/components/schemas/MatchingConfidenceSearchResult"}}}},"components/schemas/DuplicateMatchResultEntity":{"id":"components/schemas/DuplicateMatchResultEntity","kind":"json-schema","title":"DuplicateMatchResultEntity","data":{"type":"object","description":"Duplicate Match result entity.","properties":{"businessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerId"},"addressId":{"$ref":"#/components/schemas/AddressExternalId"},"organizationId":{"$ref":"#/components/schemas/OrganizationId"},"workspaceId":{"$ref":"#/components/schemas/WorkspaceId"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"businessPartnerExternalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"addressExternalId":{"$ref":"#/components/schemas/AddressExternalId"}}}},"components/schemas/IdentityLinkEntity":{"id":"components/schemas/IdentityLinkEntity","kind":"json-schema","title":"IdentityLinkEntity","data":{"type":"object","description":"Identity Link entity.","properties":{"businessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerId"},"addressId":{"type":"string","description":"Address identifier within a Business Partner.","example":"1"},"organizationId":{"$ref":"#/components/schemas/OrganizationId"},"workspaceId":{"$ref":"#/components/schemas/WorkspaceId"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"businessPartnerExternalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"addressExternalId":{"$ref":"#/components/schemas/AddressExternalId"}}}},"components/schemas/MatchingConfidenceSearchResult":{"id":"components/schemas/MatchingConfidenceSearchResult","kind":"json-schema","title":"MatchingConfidenceSearchResult","data":{"type":"object","description":"Matching confidence search result.","properties":{"overallScore":{"type":"number","description":"Overall score of the match.","example":"0.8"},"businessPartnerScore":{"type":"number","description":"Business Partner score of the match.","example":"0.8"},"addressScore":{"type":"number","description":"Address score of the match.","example":"0.8"},"confidenceStatus":{"$ref":"#/components/schemas/ConfidenceStatus"},"matchingExplanation":{"type":"array","description":"List of matching explanations.","items":{"$ref":"#/components/schemas/AttributeMatchingExplanation"}}}}},"components/schemas/ConfidenceStatus":{"id":"components/schemas/ConfidenceStatus","kind":"json-schema","title":"ConfidenceStatus","data":{"type":"string","description":"Represents decision on the existing link between Business Partner entities.","example":"MATCH"}},"components/schemas/ConfidenceStatusEnum":{"id":"components/schemas/ConfidenceStatusEnum","kind":"json-schema","title":"ConfidenceStatusEnum","data":{"type":"string","description":"Represents decision on the existing link between Business Partner entities.","example":"MATCH","enum":["MATCH","MAYBE_MATCH","DIFFERENT"],"x-enumDescriptions":{"MATCH":"The match between two entities is that high, that it can be said that two entities are identical.","MAYBE_MATCH":"The match between two entities is between lower matching threshold and higher matching threshold. Based on similarity it cannot be said that two entities are identical.","DIFFERENT":"The match between two entities is too low to decide if those are identical, it can be said that two entities are different."}}},"components/schemas/AttributeMatchingExplanation":{"id":"components/schemas/AttributeMatchingExplanation","kind":"json-schema","title":"AttributeMatchingExplanation","data":{"type":"object","description":"Attribute matching explanation.","properties":{"jsonPath":{"type":"string","description":"JSON path to the attribute in the record.","example":"attributeJsonPath"},"valueA":{"type":"string","description":"Value of property under the json path from entityA.","example":"valueA"},"valueB":{"type":"string","description":"Value of property under the json path from entityB.","example":"valueB"},"similarity":{"type":"number","description":"Number value of similarity between valueA and valueB.","example":"0.8"}},"required":["jsonPath","valueA","valueB","similarity"]}},"components/schemas/LinkStatus":{"id":"components/schemas/LinkStatus","kind":"json-schema","title":"LinkStatus","data":{"type":"string","description":"Value of Link status.","example":"INFERRED"}},"components/schemas/LinkStatusEnum":{"id":"components/schemas/LinkStatusEnum","kind":"json-schema","title":"LinkStatusEnum","data":{"type":"string","description":"Link status enum.","example":"INFERRED","enum":["INFERRED","ASSERTED","RETRACTED"],"x-enumDescriptions":{"INFERRED":"This status means that the link was identified as a result of the matching process. It is purely algorithm based.","ASSERTED":"This status means that the link was manually reviewed and approved.","RETRACTED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFERRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but status was manually changed. This can be either customer stating that the link was not valid, the data of the records changed or matching configuration was altered."},"children":[]}]}]}]}}},"components/schemas/IdentityLinkUpdate":{"id":"components/schemas/IdentityLinkUpdate","kind":"json-schema","title":"IdentityLinkUpdate","data":{"type":"object","description":"Update of identity link.","properties":{"id":{"type":"string","description":"ID of Identity Link.","example":"65dcc3c60cecd503bcc88c92"},"status":{"$ref":"#/components/schemas/ConfidenceStatusEnum"}},"required":["status"]}},"components/schemas/IdentityLinkUpdateResult":{"id":"components/schemas/IdentityLinkUpdateResult","kind":"json-schema","title":"IdentityLinkUpdateResult","data":{"type":"object","description":"Result of updating identity link.","properties":{"id":{"type":"string","description":"ID of the identity link.","example":"65dcc3c60cecd503bcc88c92"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK - identity link has been updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND - identity link is not found"},"children":[]}]}]}]}],"example":"OK"}}}},"components/schemas/IdentityLinkDelete":{"id":"components/schemas/IdentityLinkDelete","kind":"json-schema","title":"IdentityLinkDelete","data":{"type":"object","description":"Deletion of identity link.","properties":{"id":{"type":"string","description":"ID of the identity link.","example":"65dcc3c60cecd503bcc88c92"}}}},"components/schemas/IdentityLinkDeleteResult":{"id":"components/schemas/IdentityLinkDeleteResult","kind":"json-schema","title":"IdentityLinkDeleteResult","data":{"type":"object","description":"Result of deleting identity link.","properties":{"identityLink":{"$ref":"#/components/schemas/IdentityLinkDelete"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK - identity link has been removed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND - identity link is not found"},"children":[]}]}]}]}],"example":"OK"}}}},"components/schemas/BusinessPartnerMatchingProfile":{"id":"components/schemas/BusinessPartnerMatchingProfile","kind":"json-schema","title":"BusinessPartnerMatchingProfile","data":{"type":"object","description":"Matching profile for a Business Partner.","properties":{"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"matchingProfile":{"$ref":"#/components/schemas/MatchingProfile"}}}},"components/schemas/Name":{"id":"components/schemas/Name","kind":"json-schema","title":"Name","data":{"type":"object","description":"Name of a Business Partner.","allOf":[{"$ref":"#/components/schemas/schemas-Name"},{"type":"object","description":"Name of a Business Partner.","properties":{"nameValueClassification":{"$ref":"#/components/schemas/NameValueClassification"}}}]}},"components/schemas/MatchingProfile":{"id":"components/schemas/MatchingProfile","kind":"json-schema","title":"MatchingProfile","data":{"type":"object","description":"Matching profile used for the match. It contains the matching threshold and the matching scores.","properties":{"matchingScores":{"$ref":"#/components/schemas/MatchingScores"}}}},"components/schemas/MatchingScores":{"id":"components/schemas/MatchingScores","kind":"json-schema","title":"MatchingScores","data":{"type":"object","description":"List of the numerical value of similarity between Business Partners or addresses enhanced with the overall score.","properties":{"overall":{"$ref":"#/components/schemas/MatchingScore"},"businessPartner":{"$ref":"#/components/schemas/MatchingScore"},"address":{"$ref":"#/components/schemas/MatchingScore"}}}},"components/schemas/MatchingScore":{"id":"components/schemas/MatchingScore","kind":"json-schema","title":"MatchingScore","data":{"type":"object","description":"Shows numerical value of similarity between Business Partners or address stored in the Data Mirror and the Business Partner from the request.","properties":{"classification":{"$ref":"#/components/schemas/MatchingClassification"},"value":{"type":"number","description":"Matching score value.","example":"0.9"},"explanation":{"type":"string","description":"Explanation for matching score value.","example":"BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"}}}},"components/schemas/MatchingClassification":{"id":"components/schemas/MatchingClassification","kind":"json-schema","title":"MatchingClassification","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classification of the matching score. It can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HIGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MEDIUM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"technicalKey":{"type":"string","description":"Technical key of the Matching Classification.","example":"HIGH"},"name":{"type":"string","description":"Name of the Matching Classification.","example":"My Matching Configuration"}}}},"components/schemas/BusinessPartner":{"id":"components/schemas/BusinessPartner","kind":"json-schema","title":"BusinessPartner","data":{"type":"object","description":"An organization which has some degree of involvement with another organization's business dealings. Typically, a company's Business Partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the Business Partner is the core managed entity. A Business Partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a Business Partner.","properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerId"},"names":{"type":"array","description":"List of names of the Business Partner.","items":{"$ref":"#/components/schemas/Name"}},"legalForm":{"$ref":"#/components/schemas/schemas-LegalForm"},"identifiers":{"type":"array","description":"List of identifiers of the Business Partner.","items":{"$ref":"#/components/schemas/schemas-Identifier"}},"categories":{"type":"array","description":"List of categories of the Business Partner.","items":{"$ref":"#/components/schemas/BusinessPartnerCategory"}},"status":{"$ref":"#/components/schemas/BusinessPartnerStatus"},"addresses":{"type":"array","description":"List of addresses of the Business Partner.","items":{"$ref":"#/components/schemas/schemas-Address"}},"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"profile":{"$ref":"#/components/schemas/PartnerProfile"},"formattedSapRecord":{"$ref":"#/components/schemas/FormattedSapRecord"},"relations":{"type":"array","description":"List of relations of the Business Partner.","items":{"$ref":"#/components/schemas/BusinessPartnerRelation"}},"bankAccounts":{"type":"array","description":"List of bank accounts of the Business Partner.","items":{"$ref":"#/components/schemas/BankAccount"}},"types":{"type":"array","description":"List of types of the Business Partner.","items":{"$ref":"#/components/schemas/BusinessPartnerType"}},"dataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceName"},"record":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stringified JSON of an individual Business Partner record. Characters: backslash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and double quote "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be escaped (respectively: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\\\\\\\"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Fields containing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are unallowed. Maximum size: 15MB."},"children":[]}]}]}],"example":"{\"name\": \"BUSINESSPARTNER_NAME\", ...}"}}}},"components/schemas/ApiError":{"id":"components/schemas/ApiError","kind":"json-schema","title":"ApiError","data":{"type":"object","description":"Detailed information about API errors.","properties":{"status":{"$ref":"#/components/schemas/HttpStatus"},"path":{"$ref":"#/components/schemas/HttpPath"},"timestamp":{"$ref":"#/components/schemas/ApiErrorTimestamp"},"error":{"$ref":"#/components/schemas/HttpError"},"message":{"$ref":"#/components/schemas/ApiErrorMessage"}}}},"components/schemas/DuplicateMatchingJobRequest":{"id":"components/schemas/DuplicateMatchingJobRequest","kind":"json-schema","title":"DuplicateMatchingJobRequest","data":{"type":"object","description":"Used to start a new Deduplication Job for the given storage.","properties":{"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"countryShortNames":{"type":"array","description":"If set, only the records that belong to the countries identified by these short names are processed. By default, all records of the storage (means from all countries) are processed (considering other filters).","items":{"$ref":"#/components/schemas/CountryShortName"}},"dataSourceIds":{"type":"array","description":"If set, only the records that belong to the data sources identified by these IDs are processed. By default, all records of the storage (means from all data sources) are processed (considering other filters).","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}},"decisionLogIds":{"type":"array","description":"If set, feedback from listed Matching Decision Logs will be considered.","items":{"type":"string","description":"ID of the Matching Decision Log.","example":"65dcb1d68f01e37c2cf9bbb2"}},"dataMatchingDefinitionId":{"$ref":"#/components/schemas/DataMatchingDefinitionId"},"reportsRequest":{"$ref":"#/components/schemas/DuplicateReportsRequestParams"}}}},"components/schemas/DuplicateReportsRequestParams":{"id":"components/schemas/DuplicateReportsRequestParams","kind":"json-schema","title":"DuplicateReportsRequestParams","data":{"type":"object","description":"Parameters for reports generation for the Deduplication Job.","properties":{"reportsConfiguration":{"$ref":"#/components/schemas/DuplicateReportsConfiguration"}}}},"components/schemas/JobTags":{"id":"components/schemas/JobTags","kind":"json-schema","title":"JobTags","data":{"type":"array","description":"List of tags that can be used to tag the job.","maxItems":10,"items":{"$ref":"#/components/schemas/JobTag"}}},"components/schemas/JobTag":{"id":"components/schemas/JobTag","kind":"json-schema","title":"JobTag","data":{"type":"string","description":"Tag that can be used to tag the job.","example":"Custom tag","maxLength":100}},"components/schemas/DuplicateReportsConfiguration":{"id":"components/schemas/DuplicateReportsConfiguration","kind":"json-schema","title":"DuplicateReportsConfiguration","data":{"type":"object","description":"Configuration for reports generation for the Deduplication Job.","properties":{"duplicateMatching":{"$ref":"#/components/schemas/DuplicateMatchingReportConfiguration"},"duplicateConsolidation":{"$ref":"#/components/schemas/DuplicateConsolidationReportConfiguration"}}}},"components/schemas/IdentityLinksReadFeatureEnum":{"id":"components/schemas/IdentityLinksReadFeatureEnum","kind":"json-schema","title":"IdentityLinksReadFeatureEnum","data":{"type":"string","description":"Features to be activated for reading identity links.","example":"NUMBER_OF_TOTAL","enum":["NUMBER_OF_TOTAL"],"x-enumDescriptions":{"NUMBER_OF_TOTAL":"When enabled it will fetch total number of records."}}},"components/schemas/EntityMatchingLinks":{"id":"components/schemas/EntityMatchingLinks","kind":"json-schema","title":"EntityMatchingLinks","data":{"type":"object","description":"List of entity matching links.","properties":{"status":{"$ref":"#/components/schemas/Status"},"startAfter":{"$ref":"#/components/schemas/StartAfter"},"limit":{"$ref":"#/components/schemas/Limit"},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"},"total":{"$ref":"#/components/schemas/PageTotal"},"values":{"type":"array","description":"List of entity matching links.","items":{"$ref":"#/components/schemas/EntityMatchingLink"}}}}},"components/schemas/EntityMatchingLink":{"id":"components/schemas/EntityMatchingLink","kind":"json-schema","title":"EntityMatchingLink","data":{"type":"object","description":"Represents relations between entities in a given storage.","properties":{"id":{"$ref":"#/components/schemas/EntityMatchingLinkId"},"storageId":{"type":"string","description":"Uniquely identifying ID of entity matching link's the storage.","example":"96f89e48aa7b331c82fb30c02d0f7154"},"dataMonitorId":{"type":"string","description":"Unique Data Monitor identifier.","example":"72d6900fce6b326088f5d9d91049e3e6"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"modifiedBy":{"$ref":"#/components/schemas/ModifiedBy"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"entityA":{"$ref":"#/components/schemas/MatchingEntity"},"entityB":{"$ref":"#/components/schemas/MatchingEntity"},"confidence":{"$ref":"#/components/schemas/MatchingConfidence"},"linkStatus":{"$ref":"#/components/schemas/EntityLinkStatus"},"linkStatusUserComment":{"type":"string","description":"Optional user comment explaining the link status","maxLength":512,"example":"Verified during manual review process"}}}},"components/schemas/EntityMatchingLinkId":{"id":"components/schemas/EntityMatchingLinkId","kind":"json-schema","title":"EntityMatchingLinkId","data":{"type":"string","description":"ID of the Entity Matching Link.","example":"5712566172571652"}},"components/schemas/MatchingEntity":{"id":"components/schemas/MatchingEntity","kind":"json-schema","title":"MatchingEntity","data":{"type":"object","description":"Represents a business entity in the system with its unique identifiers and source information.","required":["dataSourceId","businessPartnerId","externalId"],"properties":{"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"businessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerId"},"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"}}}},"components/schemas/EntityMatchingLinkUpdate":{"id":"components/schemas/EntityMatchingLinkUpdate","kind":"json-schema","title":"EntityMatchingLinkUpdate","data":{"type":"object","description":"Request to update an entity matching link status","required":["linkStatus"],"properties":{"linkStatus":{"$ref":"#/components/schemas/EntityLinkStatusUpdateEnum"},"linkStatusUserComment":{"type":"string","description":"Optional user comment explaining the status change","maxLength":128,"example":"Small Update - completely wrong duplicate"}}}},"components/schemas/EntityLinkStatusUpdateEnum":{"id":"components/schemas/EntityLinkStatusUpdateEnum","kind":"json-schema","title":"EntityLinkStatusUpdateEnum","data":{"type":"string","description":"Entity link status update enum (excludes INFERRED)","example":"RETRACTED","enum":["ASSERTED","RETRACTED"],"x-enumDescriptions":{"ASSERTED":"Manually verified and approved as a correct match","RETRACTED":"Manually marked as incorrect match or duplicate"}}},"components/schemas/EntityMatchingLinkUpdateResult":{"id":"components/schemas/EntityMatchingLinkUpdateResult","kind":"json-schema","title":"EntityMatchingLinkUpdateResult","data":{"type":"object","description":"Result of updating an entity matching link","properties":{"id":{"$ref":"#/components/schemas/EntityMatchingLinkId"},"linkStatus":{"$ref":"#/components/schemas/EntityLinkStatus"},"linkStatusUserComment":{"type":"string","description":"User comment associated with the status change","example":"Small Update - completely wrong duplicate"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"modifiedBy":{"$ref":"#/components/schemas/ModifiedBy"},"status":{"$ref":"#/components/schemas/Status"}}}},"components/schemas/MatchingConfidence":{"id":"components/schemas/MatchingConfidence","kind":"json-schema","title":"MatchingConfidence","data":{"type":"object","description":"Represents the confidence level of a match between two entities, including scoring and status information.","required":["overallScore","status"],"properties":{"overallScore":{"type":"number","format":"double","minimum":0,"maximum":1,"description":"Overall confidence score of the match between two entities (0.0 to 1.0).","example":0.95},"status":{"$ref":"#/components/schemas/EntityMatchingStatus"},"explanation":{"$ref":"#/components/schemas/EntityMatchExplanation"}}}},"components/schemas/EntityMatchingStatus":{"id":"components/schemas/EntityMatchingStatus","kind":"json-schema","title":"EntityMatchingStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of confidence status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Entities match with high confidence and are considered identical."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_MATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Entities do not match and are considered different."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MAYBE_MATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Match confidence is uncertain and falls between threshold ranges."},"children":[]}]}]}]}],"example":"MATCH"}},"components/schemas/EntityMatchingStatusParam":{"id":"components/schemas/EntityMatchingStatusParam","kind":"json-schema","title":"EntityMatchingStatusParam","data":{"type":"string","description":"Confidence status enum.","example":"MATCH","enum":["MATCH","NO_MATCH","MAYBE_MATCH"],"x-enumDescriptions":{"MATCH":"Entities match with high confidence and are considered identical.","NO_MATCH":"Entities do not match and are considered different.","MAYBE_MATCH":"Match confidence is uncertain and falls between threshold ranges."}}},"components/schemas/EntityLinkStatus":{"id":"components/schemas/EntityLinkStatus","kind":"json-schema","title":"EntityLinkStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of Entity Link status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFERRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This status means that the link was identified as a result of the matching process. It is purely algorithm based."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASSERTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This status means that the link was manually reviewed and approved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETRACTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Status was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFERRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but the status was manually changed. This can be either the customer stating that the link was not valid, the data of the records changed, or the matching configuration was altered."},"children":[]}]}]}]}],"example":"INFERRED"}},"components/schemas/EntityLinkStatusParam":{"id":"components/schemas/EntityLinkStatusParam","kind":"json-schema","title":"EntityLinkStatusParam","data":{"type":"string","description":"Link status enum.","example":"INFERRED","enum":["INFERRED","ASSERTED","RETRACTED"],"x-enumDescriptions":{"INFERRED":"This status means that the link was identified as a result of the matching process. It is purely algorithm based.","ASSERTED":"This status means that the link was manually reviewed and approved.","RETRACTED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFERRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but status was manually changed. This can be either customer stating that the link was not valid, the data of the records changed or matching configuration was altered."},"children":[]}]}]}]}}},"components/schemas/EntityMatchExplanation":{"id":"components/schemas/EntityMatchExplanation","kind":"json-schema","title":"EntityMatchExplanation","data":{"type":"object","description":"Detailed explanation of why entities were considered matches, breaking down the matching logic by attributes.","properties":{"attributeMatchingExplanation":{"type":"array","items":{"$ref":"#/components/schemas/EntityAttributeMatch"}}}}},"components/schemas/EntityAttributeMatch":{"id":"components/schemas/EntityAttributeMatch","kind":"json-schema","title":"EntityAttributeMatch","data":{"type":"object","description":"Detailed comparison of a specific attribute between two entities, including their values and similarity score.","required":["jsonPath","valueA","valueB","similarity"],"properties":{"jsonPath":{"type":"string","description":"JSON path indicating the location of the matched attribute in the entity structure.","example":"businessPartner.name"},"valueA":{"type":"string","description":"Value of the attribute from the first entity being compared.","example":"Acme Corporation"},"valueB":{"type":"string","description":"Value of the attribute from the second entity being compared.","example":"ACME Corp"},"similarity":{"type":"number","format":"double","minimum":0,"maximum":1,"description":"Numerical score indicating how similar the two values are (0.0 to 1.0).","example":0.85}}}},"components/schemas/EntityMatchingLinksReadFeatureEnum":{"id":"components/schemas/EntityMatchingLinksReadFeatureEnum","kind":"json-schema","title":"EntityMatchingLinksReadFeatureEnum","data":{"type":"string","description":"Features to be activated for reading identity links.","example":"NUMBER_OF_TOTAL","enum":["NUMBER_OF_TOTAL"],"x-enumDescriptions":{"NUMBER_OF_TOTAL":"When enabled it will fetch total number of records."}}},"components/schemas/UserfeedbacksFeatureEnum":{"id":"components/schemas/UserfeedbacksFeatureEnum","kind":"json-schema","title":"UserfeedbacksFeatureEnum","data":{"type":"string","description":"Features to be activated for getting User Feedbacks.","example":"NUMBER_OF_TOTAL","enum":["NUMBER_OF_TOTAL"],"x-enumDescriptions":{"NUMBER_OF_TOTAL":"When enabled it will fetch total number of records."}}},"components/schemas/LinkMatchingJobRequest":{"id":"components/schemas/LinkMatchingJobRequest","kind":"json-schema","title":"LinkMatchingJobRequest","data":{"type":"object","description":"Request to start a linkage matching job.","properties":{"patternSources":{"type":"array","description":"The source, in form of a BusinessPartner storage (at least one but can be more), to get the pattern records for the matching.","items":{"$ref":"#/components/schemas/DataMatchingSource"},"minItems":1},"matchSources":{"type":"array","description":"The source, in form of a BusinessPartner storage (at least one but can be more), to get the match records for the matching.","items":{"$ref":"#/components/schemas/DataMatchingSource"},"minItems":1},"countryShortNames":{"type":"array","description":"If set, only the records that belong to the countries identified by these short names are processed. By default all records of the storage (means from all countries) are processed (considering other filters).","items":{"$ref":"#/components/schemas/CountryShortName"}},"dataMatchingDefinitionId":{"type":"string","description":"ID of the DataMatchingDefinition that should be used to perform the link matching.","example":"6461e6113b1865304b3038b6","required":["patternSources","matchSources","dataMatchingDefinitionId"]},"decisionLogIds":{"type":"array","description":"If set, feedback from listed Matching Decision Logs will be considered.","items":{"type":"string","description":"ID of the Matching Decision Log.","example":"65dcb1d68f01e37c2cf9bbb2"}}}}},"components/schemas/LinkageMatchingReportProperties":{"id":"components/schemas/LinkageMatchingReportProperties","kind":"json-schema","title":"LinkageMatchingReportProperties","data":{"type":"object","description":"Properties for the linkage matching report.","properties":{"reportType":{"$ref":"#/components/schemas/LinkageMatchingReportType"}}}},"components/schemas/LinkageMatchingReportType":{"id":"components/schemas/LinkageMatchingReportType","kind":"json-schema","title":"LinkageMatchingReportType","data":{"type":"string","description":"Type of the linkage matching report.","example":"EXCEL","default":"EXCEL","enum":["EXCEL","JOB_RESULTS"],"x-enumDescriptions":{"EXCEL":"Excel report.","JOB_RESULTS":"Job results."}}},"components/schemas/DataMatchingSource":{"id":"components/schemas/DataMatchingSource","kind":"json-schema","title":"DataMatchingSource","data":{"type":"object","description":"A source of data for matching.","properties":{"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"dataSourceIds":{"type":"array","description":"Optional list of DataSource IDs of the storage (identified by the storageId) that should be used for matching.","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}}},"required":["storageId"]}},"components/schemas/JobDependency":{"id":"components/schemas/JobDependency","kind":"json-schema","title":"JobDependency","data":{"type":"object","description":"Relations between jobs.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"strategy":{"type":"string","description":"Defines the strategy for handling the job in case of a failure of the dependency.","example":"SCHEDULE_NEXT_WHEN_ENDED","default":"SCHEDULE_NEXT_WHEN_FINISHED","enum":["SCHEDULE_NEXT_WHEN_ENDED","SCHEDULE_NEXT_WHEN_FINISHED","SCHEDULE_NEXT_WHEN_FINISHED_OR_FAILED"],"x-enumDescriptions":{"SCHEDULE_NEXT_WHEN_ENDED":"The job will be scheduled when the dependency job has ended.","SCHEDULE_NEXT_WHEN_FINISHED":"The job will be scheduled when the dependency job has finished.","SCHEDULE_NEXT_WHEN_FINISHED_OR_FAILED":"The job will be scheduled when the dependency job has finished or failed."}}}}},"components/schemas/Label":{"id":"components/schemas/Label","kind":"json-schema","title":"Label","data":{"type":"object","description":"Labels are used to tag jobs with a certain label.","properties":{"key":{"type":"string","description":"Key of the job's label.","maxLength":63,"example":"labelKey"},"value":{"type":"string","description":"Value of the job's label.","maxLength":63,"example":"labelValue"}}}},"components/schemas/LinkMatchingJob":{"id":"components/schemas/LinkMatchingJob","kind":"json-schema","title":"LinkMatchingJob","data":{"type":"object","description":"A job to perform linkage matching.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"patternSources":{"type":"array","description":"The source, in form of a BusinessPartner storage (at least one but can be more), to get the pattern records for the matching.","items":{"$ref":"#/components/schemas/DataMatchingSource"},"minItems":1},"matchSources":{"type":"array","description":"The source, in form of a BusinessPartner storage (at least one but can be more), to get the match records for the matching.","items":{"$ref":"#/components/schemas/DataMatchingSource"},"minItems":1},"countryShortNames":{"type":"array","description":"List of country short names.","items":{"$ref":"#/components/schemas/CountryShortName"}},"dataMatchingDefinitionId":{"$ref":"#/components/schemas/DataMatchingDefinitionId"},"decisionLogIds":{"type":"array","description":"If set, feedback from listed Matching Decision Logs will be considered.","items":{"type":"string","description":"ID of the Matching Decision Log.","example":"65dcb1d68f01e37c2cf9bbb2"}},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"status":{"$ref":"#/components/schemas/JobStatus"},"progress":{"$ref":"#/components/schemas/JobProgress"}}}},"components/schemas/JobStatus":{"id":"components/schemas/JobStatus","kind":"json-schema","title":"JobStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Curation Job execution status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ARCHIVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job is archived."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job status is unknown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job has been created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSISTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job has been persisted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCHEDULED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job is scheduled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job is waiting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COULDNT_START"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job could not be started."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RUNNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job is running."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINISHED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job has finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job has died."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job has been canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The job has failed."},"children":[]}]}]}]}],"example":"RUNNING"}},"components/schemas/DataMatchingDefinitionCreate":{"id":"components/schemas/DataMatchingDefinitionCreate","kind":"json-schema","title":"DataMatchingDefinitionCreate","data":{"type":"object","description":"Structured data entity that encapsulates the parameters necessary for the instantiation of a new Data Matching Definition.","required":["name","type","xmlDukeConfiguration"],"properties":{"name":{"type":"string","maxLength":30,"description":"A human-readable Name for the Data Matching Definition instance.","example":"Custom Matching Definition Name"},"type":{"$ref":"#/components/schemas/MatchingTypeParam"},"xmlDukeConfiguration":{"type":"string","description":"Holds the Duke XML configuration for data matching.","example":"<duke>...</duke>"},"reportConfiguration":{"$ref":"#/components/schemas/ReportConfiguration"},"goldenRecordConfiguration":{"$ref":"#/components/schemas/GoldenRecordConfiguration"},"workspace":{"$ref":"#/components/schemas/Workspace"}}}},"components/schemas/Workspace":{"id":"components/schemas/Workspace","kind":"json-schema","title":"Workspace","data":{"type":"object","description":"Collaboration space to share/configure configurations.","properties":{"id":{"$ref":"#/components/schemas/WorkspaceId"}}}},"components/schemas/DataMatchingDefinitionUpdate":{"id":"components/schemas/DataMatchingDefinitionUpdate","kind":"json-schema","title":"DataMatchingDefinitionUpdate","data":{"type":"object","description":"Structured data entity that encapsulates the parameters necessary for updating an existing Data Matching Definition.","required":["name","type","xmlDukeConfiguration"],"properties":{"name":{"type":"string","maxLength":30,"description":"A human-readable name for the Data Matching Definition instance.","example":"Custom Matching Definition Name"},"type":{"$ref":"#/components/schemas/MatchingTypeParam"},"xmlDukeConfiguration":{"type":"string","description":"Holds the Duke XML configuration for data matching.","example":"<duke>...</duke>"},"reportConfiguration":{"$ref":"#/components/schemas/ReportConfiguration"},"goldenRecordConfiguration":{"$ref":"#/components/schemas/GoldenRecordConfiguration"},"workspace":{"$ref":"#/components/schemas/Workspace"}}}},"components/schemas/DataMatchingDefinition":{"id":"components/schemas/DataMatchingDefinition","kind":"json-schema","title":"DataMatchingDefinition","data":{"type":"object","description":"Data structure that encapsulates the configuration details.","properties":{"id":{"$ref":"#/components/schemas/DataMatchingDefinitionId"},"name":{"type":"string","maxLength":30,"description":"A human-readable name for the Data Matching Definition instance.","example":"Custom Matching Definition Name"},"creatorUsername":{"$ref":"#/components/schemas/UserId"},"creatorOrganization":{"$ref":"#/components/schemas/OrganizationId"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"lastModifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"type":{"$ref":"#/components/schemas/MatchingType"},"xmlDukeConfiguration":{"type":"string","description":"Holds the Duke XML configuration for data matching.","example":"<duke>...</duke>"},"reportConfiguration":{"$ref":"#/components/schemas/ReportConfiguration"},"goldenRecordConfiguration":{"$ref":"#/components/schemas/GoldenRecordConfigurationResult"},"workspace":{"$ref":"#/components/schemas/Workspace"}}}},"components/schemas/MatchingType":{"id":"components/schemas/MatchingType","kind":"json-schema","title":"MatchingType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the matching configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEDUPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The matching configuration is used to identify duplicates in a storage."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LINKAGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The matching configuration is used to identify links between records in different storages."},"children":[]}]}]}]}],"example":"DEDUPLICATION"}},"components/schemas/MatchingTypeParam":{"id":"components/schemas/MatchingTypeParam","kind":"json-schema","title":"MatchingTypeParam","data":{"type":"string","description":"Type of the matching configuration.","example":"DEDUPLICATION","enum":["DEDUPLICATION","LINKAGE"],"x-enumDescriptions":{"DEDUPLICATION":"The matching configuration is used to identify duplicates in a storage.","LINKAGE":"The matching configuration is used to identify links between records in different storages."}}},"components/schemas/ReportConfiguration":{"id":"components/schemas/ReportConfiguration","kind":"json-schema","title":"ReportConfiguration","data":{"type":"object","description":"Configuration for generating reports related to the Data Matching Definition.","properties":{"header":{"type":"array","description":"List of column mappings for the header of the report.","items":{"$ref":"#/components/schemas/ColumnMapping"}}}}},"components/schemas/ColumnMapping":{"id":"components/schemas/ColumnMapping","kind":"json-schema","title":"ColumnMapping","data":{"type":"object","description":"Mapping of a column in the report to an attribute in the result object.","properties":{"attributeJsonPath":{"type":"string","description":"JSON path to the attribute in the result object.","example":"attributeJsonPath"},"columnName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the column in the report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accessible values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tax Number 1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tax Number 2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT Number"},"children":[]}]}]}]}],"example":"External ID"}}}},"components/schemas/GoldenRecordConfiguration":{"id":"components/schemas/GoldenRecordConfiguration","kind":"json-schema","title":"GoldenRecordConfiguration","data":{"type":"object","description":"Configuration for creating Golden Records in the context of Data Matching.","properties":{"decisionStrategy":{"$ref":"#/components/schemas/DecisionStrategy"},"creationStrategy":{"$ref":"#/components/schemas/CreationStrategy"}}}},"components/schemas/GoldenRecordConfigurationResult":{"id":"components/schemas/GoldenRecordConfigurationResult","kind":"json-schema","title":"GoldenRecordConfigurationResult","data":{"type":"object","description":"Configuration for creating Golden Records in the context of Data Matching.","properties":{"decisionStrategy":{"$ref":"#/components/schemas/DecisionStrategyResult"},"creationStrategy":{"$ref":"#/components/schemas/CreationStrategyResult"}}}},"components/schemas/DecisionStrategy":{"id":"components/schemas/DecisionStrategy","kind":"json-schema","title":"DecisionStrategy","data":{"type":"object","description":"Defines how the decision tree is created.","properties":{"root":{"$ref":"#/components/schemas/DecisionNode"}}}},"components/schemas/DecisionStrategyResult":{"id":"components/schemas/DecisionStrategyResult","kind":"json-schema","title":"DecisionStrategyResult","data":{"type":"object","description":"Defines how the decision tree is created.","properties":{"root":{"$ref":"#/components/schemas/DecisionNodeResult"}}}},"components/schemas/DecisionNode":{"id":"components/schemas/DecisionNode","kind":"json-schema","title":"DecisionNode","data":{"type":"object","description":"Defines a node in the decision tree.","properties":{"rule":{"$ref":"#/components/schemas/Rule"},"yesBranch":{"$ref":"#/components/schemas/DecisionNode"},"noBranch":{"$ref":"#/components/schemas/DecisionNode"}}}},"components/schemas/DecisionNodeResult":{"id":"components/schemas/DecisionNodeResult","kind":"json-schema","title":"DecisionNodeResult","data":{"type":"object","description":"Defines a node in the decision tree.","properties":{"rule":{"$ref":"#/components/schemas/RuleResult"},"yesBranch":{"$ref":"#/components/schemas/DecisionNodeResult"},"noBranch":{"$ref":"#/components/schemas/DecisionNodeResult"}}}},"components/schemas/CreationStrategyResult":{"id":"components/schemas/CreationStrategyResult","kind":"json-schema","title":"CreationStrategyResult","data":{"type":"object","description":"Defines the strategy for creating Golden Records in the context of Data Matching.","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/CreationType"},"protectedAttributes":{"type":"array","description":"List of attributes of the base record that should be kept.","items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of an attribute in the report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tax Number 1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tax Number 2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT Number"},"children":[]}]}]}]}],"example":"External ID"}},"recordExclusionRules":{"type":"array","description":"List of rules to exclude certain records from Golden Record creation (e.g., has a deletion flag).","items":{"$ref":"#/components/schemas/RuleResult"}},"attributeEnhancementRules":{"type":"array","description":"List of rules to define if and how a certain attribute should be included or removed from the Golden Record.","items":{"$ref":"#/components/schemas/EnhancementRule"}}}}},"components/schemas/CreationStrategy":{"id":"components/schemas/CreationStrategy","kind":"json-schema","title":"CreationStrategy","data":{"type":"object","description":"Defines the strategy for creating Golden Records in the context of Data Matching.","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/CreationTypeParam"},"protectedAttributes":{"type":"array","description":"List of attributes of the base record that should be kept.","items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of an attribute in the report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tax Number 1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tax Number 2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT Number"},"children":[]}]}]}]}],"example":"External ID"}},"recordExclusionRules":{"type":"array","description":"List of rules to exclude certain records from Golden Record creation (e.g. has a deletion flag).","items":{"$ref":"#/components/schemas/Rule"}},"attributeEnhancementRules":{"type":"array","description":"List of rules to define if and how a certain attribute should be included or removed from the Golden Record.","items":{"$ref":"#/components/schemas/EnhancementRule"}}}}},"components/schemas/CreationType":{"id":"components/schemas/CreationType","kind":"json-schema","title":"CreationType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how attributes should be added to the Golden Record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONSTANT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The value of the attribute is set to a constant value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MAJORITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The value of the attribute is set to the value that occurs most often in Golden Records."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JOIN_DISTINCT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The value of the attribute is set to the distinct value of the attribute in the Golden Record."},"children":[]}]}]}]}],"example":"CONSTANT"}},"components/schemas/CreationTypeParam":{"id":"components/schemas/CreationTypeParam","kind":"json-schema","title":"CreationTypeParam","data":{"type":"string","description":"Defines how an attributes should be added to the Golden Record.","example":"CONSTANT","enum":["CONSTANT","MAJORITY","JOIN_DISTINCT"],"x-enumDescriptions":{"CONSTANT":"The value of the attribute is set to a constant value.","MAJORITY":"The value of the attribute is set to the value that occurs most often in Golden Records.","JOIN_DISTINCT":"The value of the attribute is set to the distinct value of the attribute in Golden Record."}}},"components/schemas/ExecutionType":{"id":"components/schemas/ExecutionType","kind":"json-schema","title":"ExecutionType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines options for handling attributes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The value of the attribute is set to the new value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENRICH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The value of the attribute is only set if the Golden Record does not have a value yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REMOVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The value of the attribute is removed from the Golden Record."},"children":[]}]}]}]}],"example":"SET"}},"components/schemas/EnhancementRule":{"id":"components/schemas/EnhancementRule","kind":"json-schema","title":"EnhancementRule","data":{"type":"object","description":"Defines how the attributes of the Golden Record are chosen.","properties":{"attributes":{"type":"array","description":"List of attributes affected by this rule of enhancement.","minItems":1,"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tax Number 1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tax Number 2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT Number"},"children":[]}]}]}]}],"example":"External ID"}},"constraintChain":{"$ref":"#/components/schemas/ConstraintChain"},"creationType":{"$ref":"#/components/schemas/CreationType"},"creationConstant":{"type":"string","description":"Constant value that should be used for the attribute.","example":"constantValue"},"executionType":{"$ref":"#/components/schemas/ExecutionType"},"fallbackExecutionType":{"$ref":"#/components/schemas/ExecutionType"}},"required":["attributes","executionType"]}},"components/schemas/ConstraintChain":{"id":"components/schemas/ConstraintChain","kind":"json-schema","title":"ConstraintChain","data":{"type":"object","description":"Defines a chain of constraints that are applied to the attributes.","properties":{"constraints":{"type":"array","description":"List of attributes affected by this rule of enhancement.","items":{"$ref":"#/components/schemas/RuleResult"}},"allRecordsShouldMatch":{"type":"boolean","description":"If true, all records should match the constraints. If false, at least one record should match the constraints.","example":"true"},"constraintChainType":{"$ref":"#/components/schemas/ConstraintChainType"}}}},"components/schemas/ConstraintChainType":{"id":"components/schemas/ConstraintChainType","kind":"json-schema","title":"ConstraintChainType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the constraint chain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All constraints should match."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": At least one constraint should match."},"children":[]}]}]}]}],"example":"AND"}},"components/schemas/RuleResult":{"id":"components/schemas/RuleResult","kind":"json-schema","title":"RuleResult","data":{"type":"object","description":"Defines a rule that can be used to filter records.","properties":{"type":{"$ref":"#/components/schemas/RuleType"},"jsonPath":{"type":"string","description":"JSON path to the attribute in the record.","example":"attributeJsonPath"},"valueType":{"$ref":"#/components/schemas/ValueType"},"expectedValues":{"type":"array","description":"List of expected values for the attribute.","items":{"type":"string","description":"Expected value for the attribute.","example":"expectedValue"}}}}},"components/schemas/Rule":{"id":"components/schemas/Rule","kind":"json-schema","title":"Rule","data":{"type":"object","description":"Defines a rule that can be used to filter records.","properties":{"type":{"$ref":"#/components/schemas/RuleTypeParam"},"jsonPath":{"type":"string","description":"JSON path to the attribute in the record.","example":"attributeJsonPath"},"valueType":{"$ref":"#/components/schemas/ValueType"},"expectedValues":{"type":"array","description":"List of expected values for the attribute.","items":{"type":"string","description":"Expected value for the attribute.","example":"expectedValue"}}}}},"components/schemas/RuleType":{"id":"components/schemas/RuleType","kind":"json-schema","title":"RuleType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the rule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HAS_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The attribute has a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HAS_NOT_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The attribute has no value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HAS_VALUE_IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The attribute has a value that is in the list of expected values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HAS_NOT_VALUE_IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The attribute has no value that is in the list of expected values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HAS_VALUE_LIKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The attribute has a value that is like the expected value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HAS_NOT_VALUE_LIKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The attribute has no value that is like the expected value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HAS_HIGHEST_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The attribute has the highest value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HAS_LOWEST_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The attribute has the lowest value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS_MARKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The record is marked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS_NOT_MARKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The record is not marked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS_MOST_COMPLETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The record is the most complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HAS_HIGHEST_MATCH_SCORE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The record has the highest match score."},"children":[]}]}]}]}],"example":"HAS_VALUE"}},"components/schemas/RuleTypeParam":{"id":"components/schemas/RuleTypeParam","kind":"json-schema","title":"RuleTypeParam","data":{"type":"string","description":"Defines the type of the rule.","example":"HAS_VALUE","enum":["HAS_VALUE","HAS_NOT_VALUE","HAS_VALUE_IN","HAS_NOT_VALUE_IN","HAS_VALUE_LIKE","HAS_NOT_VALUE_LIKE","HAS_HIGHEST_VALUE","HAS_LOWEST_VALUE","IS_MARKED","IS_NOT_MARKED","IS_MOST_COMPLETE","HAS_HIGHEST_MATCH_SCORE"],"x-enumDescriptions":{"HAS_VALUE":"The attribute has a value.","HAS_NOT_VALUE":"The attribute has no value.","HAS_VALUE_IN":"The attribute has a value that is in the list of expected values.","HAS_NOT_VALUE_IN":"The attribute has no value that is in the list of expected values.","HAS_VALUE_LIKE":"The attribute has a value that is like the expected value.","HAS_NOT_VALUE_LIKE":"The attribute has no value that is like the expected value.","HAS_HIGHEST_VALUE":"The attribute has the highest value.","HAS_LOWEST_VALUE":"The attribute has the lowest value.","IS_MARKED":"The record is marked.","IS_NOT_MARKED":"The record is not marked.","IS_MOST_COMPLETE":"The record is the most complete.","HAS_HIGHEST_MATCH_SCORE":"The record has the highest match score."}}},"components/schemas/ValueType":{"id":"components/schemas/ValueType","kind":"json-schema","title":"ValueType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TEXT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The value is a text."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The value is a date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The value is a number."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FLOATING_POINT_NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The value is a floating point number."},"children":[]}]}]}]}],"example":"TEXT"}},"components/schemas/DataMatchingDefinitionPage":{"id":"components/schemas/DataMatchingDefinitionPage","kind":"json-schema","title":"DataMatchingDefinitionPage","data":{"type":"object","description":"Page of DataMatchingDefinitions.","properties":{"page":{"$ref":"#/components/schemas/Page"},"pageSize":{"$ref":"#/components/schemas/PageSize"},"numberOfPages":{"type":"integer","format":"int32","description":"The number of pages available.","example":"3"},"total":{"$ref":"#/components/schemas/PageTotal"},"values":{"type":"array","description":"List of Data Matching Definitions.","items":{"$ref":"#/components/schemas/DataMatchingDefinition"}}}}},"components/schemas/MatchingReportType":{"id":"components/schemas/MatchingReportType","kind":"json-schema","title":"MatchingReportType","data":{"type":"string","description":"Type of the matching report file output.","example":"EXCEL","default":"EXCEL","enum":["EXCEL","CSV","JOB_RESULTS"],"x-enumDescriptions":{"EXCEL":"Excel file.","CSV":"CSV file.","JOB_RESULTS":"Job results."}}},"components/schemas/MatchingDukeProperties":{"id":"components/schemas/MatchingDukeProperties","kind":"json-schema","title":"MatchingDukeProperties","data":{"type":"object","description":"Allows setting the number of threads, batch size and profiling.","properties":{"threads":{"type":"integer","description":"Number of threads to be used for matching.","example":"4","default":1,"minimum":1,"maximum":10},"batchSize":{"type":"integer","description":"Number of records that are processed at once.","example":"1000","default":40000,"minimum":40000,"maximum":1000000},"profiling":{"type":"boolean","description":"If set to true, matching will be profiled.","example":"true","default":false}}}},"components/schemas/DuplicateMatchingJob":{"id":"components/schemas/DuplicateMatchingJob","kind":"json-schema","title":"DuplicateMatchingJob","data":{"type":"object","description":"Job to deduplicate Business Partners.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"dataMatchingDefinitionId":{"$ref":"#/components/schemas/DataMatchingDefinitionId"},"dataSourceIds":{"type":"array","description":"List of Data Source IDs.","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}},"decisionLogIds":{"type":"array","description":"If set, feedback from listed Matching Decision Logs will be considered.","items":{"type":"string","description":"ID of the Matching Decision Log.","example":"65dcb1d68f01e37c2cf9bbb2"}},"countryShortNames":{"type":"array","description":"List of country short names.","items":{"$ref":"#/components/schemas/CountryShortName"}},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"status":{"$ref":"#/components/schemas/JobStatus"},"progress":{"$ref":"#/components/schemas/JobProgress"}}}},"components/schemas/BusinessPartnersEntityResolutionComparisonResult":{"id":"components/schemas/BusinessPartnersEntityResolutionComparisonResult","kind":"json-schema","title":"BusinessPartnersEntityResolutionComparisonResult","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result of comparing values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the body below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"comparisonResults\": [\n    {\n      \"comparatorName\": \"DiceCoefficientComparator\",\n      \"similarity\": 1,\n      \"valueA\": \"CDQ AG\",\n      \"valueACleaned\": \"CDQ AG\",\n      \"valueB\": \"CDQ AG\",\n      \"valueBCleaned\": \"CDQ AG\"\n    }\n  ],\n  \"status\": {\n    \"details\": []\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"comparisonResults\": [\n    {\n      \"comparatorName\": \"DiceCoefficientComparator\",\n      \"similarity\": 1,\n      \"valueA\": \"CDQ AG\",\n      \"valueACleaned\": \"CDQ AG\",\n      \"valueB\": \"CDQ AG\",\n      \"valueBCleaned\": \"CDQ AG\"\n    }\n  ],\n  \"status\": {\n    \"details\": []\n  }\n}\n"},"children":[]}]}],"example":{"comparisonResults":[{"comparatorName":"DiceCoefficientComparator","valueA":"CDQ AG","valueB":"CDQ AG","valueACleaned":"CDQ AG","valueBCleaned":"CDQ AG","similarity":1}],"status":{"details":[]}},"properties":{"comparatorName":{"type":"string","description":"Technical key of the comparator that was used.","example":"Levenshtein"},"valueA":{"type":"string","description":"First value used for comparison.","example":"CDQ AG"},"valueB":{"type":"string","description":"Second value used for comparison.","example":"CDQ AG"},"valueACleaned":{"type":"string","description":"Form of Value A after all cleaners have been applied.","example":"cdq"},"valueBCleaned":{"type":"string","description":"Form of Value B after all cleaners have been applied.","example":"cdq"},"similarity":{"type":"number","description":"Double precision number representing the calculated similarity between the given values.","example":"0.8"}}}},"components/schemas/ExternalContextIdentifier":{"id":"components/schemas/ExternalContextIdentifier","kind":"json-schema","title":"ExternalContextIdentifier","data":{"type":"object","description":"Describe own identifiers of a record (others than just the external ID).","properties":{"value":{"$ref":"#/components/schemas/ExternalContextIdentifierValue"},"type":{"$ref":"#/components/schemas/ExternalContextIdentifierType"}}}},"components/schemas/ExternalContextIdentifierType":{"id":"components/schemas/ExternalContextIdentifierType","kind":"json-schema","title":"ExternalContextIdentifierType","data":{"type":"object","description":"External identifiers type associated with the Business Partner.","properties":{"technicalKey":{"$ref":"#/components/schemas/ExternalContextIdentifierTypeTechnicalKey"}}}},"components/schemas/IdentifierType":{"id":"components/schemas/IdentifierType","kind":"json-schema","title":"IdentifierType","data":{"type":"object","description":"Type of the identifier.","properties":{"url":{"$ref":"#/components/schemas/IdentifierTypeUrl"},"name":{"$ref":"#/components/schemas/IdentifierTypeName"},"technicalKey":{"$ref":"#/components/schemas/IdentifierTypeTechnicalKey"}}}},"components/schemas/Thoroughfare":{"id":"components/schemas/Thoroughfare","kind":"json-schema","title":"Thoroughfare","data":{"type":"object","description":"Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue, etc. This also includes canals or banks on which houses or boat houses are located where people live.","properties":{"type":{"$ref":"#/components/schemas/ThoroughfareType"},"shortName":{"$ref":"#/components/schemas/ThoroughfareShortName"},"number":{"$ref":"#/components/schemas/ThoroughfareNumber"},"direction":{"$ref":"#/components/schemas/ThoroughfareDirection"},"value":{"$ref":"#/components/schemas/ThoroughfareValue"}}}},"components/schemas/PostalDeliveryPoint":{"id":"components/schemas/PostalDeliveryPoint","kind":"json-schema","title":"PostalDeliveryPoint","data":{"type":"object","description":"A single mailbox or other place at which postal mail is delivered.","properties":{"type":{"$ref":"#/components/schemas/PostalDeliveryPointType"},"shortName":{"$ref":"#/components/schemas/PostalDeliveryPointShortName"},"number":{"$ref":"#/components/schemas/PostalDeliveryPointNumber"},"value":{"$ref":"#/components/schemas/PostalDeliveryPointValue"}}}},"components/schemas/Locality":{"id":"components/schemas/Locality","kind":"json-schema","title":"Locality","data":{"type":"object","description":"A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses. Many localities exist in an administrative area. A locality can also have several levels of sub localities.","properties":{"type":{"$ref":"#/components/schemas/LocalityType"},"shortName":{"$ref":"#/components/schemas/LocalityShortName"},"value":{"$ref":"#/components/schemas/LocalityValue"}}}},"components/schemas/ThoroughfareType":{"id":"components/schemas/ThoroughfareType","kind":"json-schema","title":"ThoroughfareType","data":{"type":"object","description":"Type of the Thoroughfare.","properties":{"name":{"$ref":"#/components/schemas/ThoroughfareTypeName"},"url":{"$ref":"#/components/schemas/ThoroughfareTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/ThoroughfareTypeTechnicalKey"}}}},"components/schemas/LocalityType":{"id":"components/schemas/LocalityType","kind":"json-schema","title":"LocalityType","data":{"type":"object","description":"Type of the locality.","properties":{"name":{"$ref":"#/components/schemas/LocalityTypeName"},"url":{"$ref":"#/components/schemas/LocalityTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/LocalityTypeTechnicalKey"}}}},"components/schemas/PremiseType":{"id":"components/schemas/PremiseType","kind":"json-schema","title":"PremiseType","data":{"type":"object","description":"Type of the Premise.","properties":{"name":{"$ref":"#/components/schemas/PremiseTypeName"},"url":{"$ref":"#/components/schemas/PremiseTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PremiseTypeTechnicalKey"}}}},"components/schemas/Premise":{"id":"components/schemas/Premise","kind":"json-schema","title":"Premise","data":{"type":"object","description":"A premise is a tract of land including its buildings. A premise may have several sublevels to precisely identify.","properties":{"value":{"$ref":"#/components/schemas/PremiseValue"},"shortName":{"$ref":"#/components/schemas/PremiseShortName"},"number":{"$ref":"#/components/schemas/PremiseNumber"},"type":{"$ref":"#/components/schemas/PremiseType"}}}},"components/schemas/AdministrativeArea":{"id":"components/schemas/AdministrativeArea","kind":"json-schema","title":"AdministrativeArea","data":{"type":"object","description":"A top-level geographical or political area division in a country.","properties":{"value":{"$ref":"#/components/schemas/AdministrativeAreaValue"},"shortName":{"$ref":"#/components/schemas/AdministrativeAreaShortName"},"type":{"$ref":"#/components/schemas/AdministrativeAreaType"}}}},"components/schemas/AdministrativeAreaType":{"id":"components/schemas/AdministrativeAreaType","kind":"json-schema","title":"AdministrativeAreaType","data":{"type":"object","description":"A top-level geographical or political area division in a country.","properties":{"name":{"$ref":"#/components/schemas/AdministrativeAreaTypeName"},"url":{"$ref":"#/components/schemas/AdministrativeAreaTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/AdministrativeAreaTypeTechnicalKey"}}}},"components/schemas/PostCode":{"id":"components/schemas/PostCode","kind":"json-schema","title":"PostCode","data":{"type":"object","description":"A country specific code for a certain address component or a combination of address components, e.g. locality.","properties":{"value":{"$ref":"#/components/schemas/PostCodeValue"},"type":{"$ref":"#/components/schemas/PostCodeType"}}}},"components/schemas/PostCodeType":{"id":"components/schemas/PostCodeType","kind":"json-schema","title":"PostCodeType","data":{"type":"object","description":"Type of the Post Code.","properties":{"name":{"$ref":"#/components/schemas/PostCodeTypeName"},"url":{"$ref":"#/components/schemas/PostCodeTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PostCodeTypeTechnicalKey"}}}},"components/schemas/PostalDeliveryPointType":{"id":"components/schemas/PostalDeliveryPointType","kind":"json-schema","title":"PostalDeliveryPointType","data":{"type":"object","description":"A single mailbox or other place at which postal mail is delivered.","properties":{"name":{"$ref":"#/components/schemas/PostalDeliveryPointTypeName"},"url":{"$ref":"#/components/schemas/PostalDeliveryPointTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PostalDeliveryPointTypeTechnicalKey"}}}},"components/schemas/Country":{"id":"components/schemas/Country","kind":"json-schema","title":"Country","data":{"type":"object","description":"Country consisting of the country name and country code (ISO 3166-1 alpha-2).","properties":{"shortName":{"$ref":"#/components/schemas/CountryShortName"},"value":{"$ref":"#/components/schemas/CountryValue"}}}},"components/schemas/ApiErrorWithStatus":{"id":"components/schemas/ApiErrorWithStatus","kind":"json-schema","title":"ApiErrorWithStatus","data":{"type":"object","description":"Detailed information about API errors.","properties":{"status":{"$ref":"#/components/schemas/Status"}}}},"components/schemas/Status":{"id":"components/schemas/Status","kind":"json-schema","title":"Status","data":{"type":"object","description":"Details about status or error of a service","required":["code","technicalKey","details"],"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"technicalKey":{"$ref":"#/components/schemas/HttpStatusTechnicalKey"},"details":{"type":"array","items":{"$ref":"#/components/schemas/StatusDetails"}},"path":{"$ref":"#/components/schemas/HttpPath"},"timestamp":{"$ref":"#/components/schemas/StatusTimestamp"}}}},"components/schemas/MatchingReportsRequest":{"id":"components/schemas/MatchingReportsRequest","kind":"json-schema","title":"MatchingReportsRequest","data":{"type":"object","description":"Request to create a new matching report.","properties":{"matchingJobId":{"$ref":"#/components/schemas/JobId"},"reportsConfiguration":{"$ref":"#/components/schemas/MatchingReportsConfiguration"}}}},"components/schemas/MatchingReports":{"id":"components/schemas/MatchingReports","kind":"json-schema","title":"MatchingReports","data":{"type":"object","description":"Represents details of a Data Matching report job.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"status":{"$ref":"#/components/schemas/schemas-JobStatus"},"statusMessage":{"$ref":"#/components/schemas/JobStatusMessage"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"finishedAt":{"type":"string","description":"ISO 8601 representation of the timestamp when the Matching Report was finished.","example":"2026-11-11T03:23:28Z"},"user":{"$ref":"#/components/schemas/UserId"},"attachments":{"type":"array","description":"List of attachments that are part of the report.","items":{"$ref":"#/components/schemas/Attachment"}},"progress":{"$ref":"#/components/schemas/JobProgress"},"reportsConfiguration":{"$ref":"#/components/schemas/MatchingReportsConfiguration"}}}},"components/schemas/Attachment":{"id":"components/schemas/Attachment","kind":"json-schema","title":"Attachment","data":{"type":"object","description":"Attachment generated in the report.","properties":{"name":{"type":"string","description":"Name of the attachment.","example":"filename.xlsx"},"type":{"type":"string","description":"Type of the attachment.","example":"REPORT_COLLECTION"},"url":{"type":"string","description":"URL/path to the attachment.","example":"cdl-runtime-data/folder/filename.xlsx"},"tags":{"type":"array","description":"List of tags","items":{"type":"string","description":"Tags of attachment.","example":"REPORT_FILE_12"}}}}},"components/schemas/MatchingDecisionLogCreateRequest":{"id":"components/schemas/MatchingDecisionLogCreateRequest","kind":"json-schema","title":"MatchingDecisionLogCreateRequest","data":{"type":"object","description":"Request to create a new matching decision log.","properties":{"name":{"type":"string","description":"Name of the matching decision log.","example":"decisionLogOne"}}}},"components/schemas/MatchingDecisionLogs":{"id":"components/schemas/MatchingDecisionLogs","kind":"json-schema","title":"MatchingDecisionLogs","data":{"type":"object","description":"List of matching decision logs.","properties":{"startAfter":{"$ref":"#/components/schemas/StartAfter"},"limit":{"$ref":"#/components/schemas/Limit"},"values":{"type":"array","description":"List of matching decision logs.","items":{"$ref":"#/components/schemas/MatchingDecisionLog"}},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"},"total":{"$ref":"#/components/schemas/PageTotal"}}}},"components/schemas/MatchingDecisionLog":{"id":"components/schemas/MatchingDecisionLog","kind":"json-schema","title":"MatchingDecisionLog","data":{"type":"object","description":"Decision Log made during data matching.","properties":{"id":{"type":"string","description":"Uniquely identifying ID of the decision log.","example":"65dcc3c60cecd503bcc88c92"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"name":{"type":"string","description":"Name of the decision log.","example":"decisionLogOne"},"organization":{"type":"string","description":"Uniquely identifying ID of the organization.","example":"12345678-1234-5678-1234-567812345678"}}}},"components/schemas/MatchingDecisionLogResult":{"id":"components/schemas/MatchingDecisionLogResult","kind":"json-schema","title":"MatchingDecisionLogResult","data":{"type":"object","description":"Result of the matching decision log creation.","properties":{"matchingDecisionLog":{"$ref":"#/components/schemas/MatchingDecisionLog"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Decision log has been fetched successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Decision log does not exist"},"children":[]}]}]}]}],"example":"OK"},"message":{"type":"string","description":"Message of the status.","example":"Decision log has been fetched successfully"}}}},"components/schemas/IdentityLinkCreateRequest":{"id":"components/schemas/IdentityLinkCreateRequest","kind":"json-schema","title":"IdentityLinkCreateRequest","data":{"type":"object","description":"Request to create identity links.","properties":{"links":{"type":"array","description":"List of identity links to be created.","minItems":1,"maxItems":1000,"items":{"$ref":"#/components/schemas/IdentityLinkCreate"}}},"required":["links"]}},"components/schemas/IdentityLinkCreate":{"id":"components/schemas/IdentityLinkCreate","kind":"json-schema","title":"IdentityLinkCreate","data":{"type":"object","description":"Identity link to be created between two Business Partners.","properties":{"entries":{"type":"array","description":"List of identity link entries.","minItems":2,"maxItems":2,"items":{"$ref":"#/components/schemas/IdentityLinkEntry"}}},"required":["entries"]}},"components/schemas/IdentityLinkEntry":{"id":"components/schemas/IdentityLinkEntry","kind":"json-schema","title":"IdentityLinkEntry","data":{"type":"object","description":"Entry of the identity link.","properties":{"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"businessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerId"}},"required":["storageId","dataSourceId","businessPartnerId"]}},"components/schemas/IdentityLink":{"id":"components/schemas/IdentityLink","kind":"json-schema","title":"IdentityLink","data":{"type":"object","description":"Represents relations between entities in a given storage.","properties":{"id":{"type":"string","description":"Uniquely identifying ID of the identity link.","example":"654477e4b930b62e0ceb4950"},"linkStorageId":{"type":"string","description":"Uniquely identifying ID of identity link's the storage.","example":"96f89e48aa7b331c82fb30c02d0f7154"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"linkStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the identity link."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INFERRED: The link has been inferred by the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASSERTED: The link has been asserted by the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETRACTED: The link has been retracted by the user."},"children":[]}]}]}]}],"example":"INFERRED"},"linkKind":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum indicating confidence of an identity link."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAME: The two entities are the same."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MAYBESAME: The two entities are likely the same."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIFFERENT: The two entities are different."},"children":[]}]}]}]}],"example":"SAME"},"entityA":{"$ref":"#/components/schemas/IdentityLinkEntry"},"entityB":{"$ref":"#/components/schemas/IdentityLinkEntry"}}}},"components/schemas/IdentityLinks":{"id":"components/schemas/IdentityLinks","kind":"json-schema","title":"IdentityLinks","data":{"type":"object","description":"List of identity links.","properties":{"startAfter":{"$ref":"#/components/schemas/StartAfter"},"limit":{"$ref":"#/components/schemas/Limit"},"values":{"type":"array","description":"List of identity links.","items":{"$ref":"#/components/schemas/IdentityLink"}},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"}}}},"components/schemas/IdentityLinkCreateResult":{"id":"components/schemas/IdentityLinkCreateResult","kind":"json-schema","title":"IdentityLinkCreateResult","data":{"type":"object","description":"Result of the identity link creation.","properties":{"values":{"type":"array","description":"List of identity links created.","items":{"$ref":"#/components/schemas/IdentityLinkCreateStatus"}}}}},"components/schemas/IdentityLinkCreateStatus":{"id":"components/schemas/IdentityLinkCreateStatus","kind":"json-schema","title":"IdentityLinkCreateStatus","data":{"type":"object","description":"Status of the identity link creation.","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Identity link has been created successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Identity link creation has failed"},"children":[]}]}]}]}],"example":"OK"},"message":{"type":"string","description":"Message of the status.","example":"Identity link has been created successfully"}}}},"components/schemas/MatchingDecisionImportJob":{"id":"components/schemas/MatchingDecisionImportJob","kind":"json-schema","title":"MatchingDecisionImportJob","data":{"type":"object","description":"Job to import matching decisions.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"domain":{"$ref":"#/components/schemas/WebsiteUrl"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"progress":{"$ref":"#/components/schemas/JobProgress"},"status":{"$ref":"#/components/schemas/schemas-JobStatus"},"statusMessage":{"$ref":"#/components/schemas/JobStatusMessage"},"decisionLogId":{"type":"string","description":"ID of the decision log.","example":"65dcb1d68f01e37c2cf9bbb2"},"result":{"$ref":"#/components/schemas/MatchingDecisionImportJobResult"}}}},"components/schemas/MatchingDecisionImportJobResult":{"id":"components/schemas/MatchingDecisionImportJobResult","kind":"json-schema","title":"MatchingDecisionImportJobResult","data":{"type":"object","description":"Result of the matching decision import job.","properties":{"statistics":{"$ref":"#/components/schemas/MatchingDecisionImportJobStatistics"}}}},"components/schemas/MatchingDecisionImportJobStatistics":{"id":"components/schemas/MatchingDecisionImportJobStatistics","kind":"json-schema","title":"MatchingDecisionImportJobStatistics","data":{"type":"object","description":"Statistics of the matching decision import job.","properties":{"numberOfInserts":{"type":"integer","format":"int32","description":"Number of inserted matching decisions.","example":"100"},"numberOfFailed":{"type":"integer","format":"int32","description":"Number of failed matching decisions.","example":"0"}}}},"components/schemas/DuplicateMonitorDeduplicateRequest":{"id":"components/schemas/DuplicateMonitorDeduplicateRequest","kind":"json-schema","title":"DuplicateMonitorDeduplicateRequest","data":{"type":"object","description":"Request for passing Business Partners for deduplication.","properties":{"storageId":{"type":"string","description":"Id of the storage","example":"123abcd68f01e37c2cf9bbb2"},"storageOrganizationId":{"type":"string","description":"Id of the organization owning the storage","example":"OrganizationName"},"configurationId":{"type":"string","description":"Id of the configuration","example":"123abcd68f01e37c2cf9bbb2"},"businessPartnerIds":{"type":"array","items":{"type":"string","description":"Id of a Business Partner","example":"123abcd68f01e37c2cf9bbb2"}},"dataSourceIds":{"type":"array","items":{"type":"string","description":"Id of a Data Source","example":"5f9fc1b97e1e490001fcfc9e"}},"dataMonitorId":{"type":"string","description":"Id of the Data Monitor","example":"123abcd68f01e37c2cf9bbb2"}}}},"components/schemas/IdentityLinkDecisionCreateWorkerRequest":{"id":"components/schemas/IdentityLinkDecisionCreateWorkerRequest","kind":"json-schema","title":"IdentityLinkDecisionCreateWorkerRequest","data":{"type":"object","description":"Request to create worker for identity links from a chunk of matching decisions.","allOf":[{"$ref":"#/components/schemas/IdentityLinkCreateRequest"},{"type":"object","description":"Decision log to be used for identity link creation.","properties":{"decisionLogId":{"type":"string","description":"ID of the decision log.","example":"65dcb1d68f01e37c2cf9bbb2"}}}]}},"components/schemas/IdentityLinkDecisionCreateResult":{"id":"components/schemas/IdentityLinkDecisionCreateResult","kind":"json-schema","title":"IdentityLinkDecisionCreateResult","data":{"type":"object","description":"Result of the identity link decision create task.","properties":{"numberOfProcessed":{"type":"integer","description":"Number of processed matching decisions.","example":"100"},"numberOfCreated":{"type":"integer","description":"Number of created identity links.","example":"100"},"numberOfFailed":{"type":"integer","description":"Number of failed identity links.","example":"0"},"failures":{"type":"array","description":"List of failed identity link creation.","items":{"$ref":"#/components/schemas/IdentityLinkDecisionCreateFailureLog"}}}}},"components/schemas/IdentityLinkDecisionCreateFailureLog":{"id":"components/schemas/IdentityLinkDecisionCreateFailureLog","kind":"json-schema","title":"IdentityLinkDecisionCreateFailureLog","data":{"type":"object","description":"Log of failed identity link creation.","properties":{"id":{"type":"string","description":"Failure log ID.","example":"567326478287468742"},"identityLink":{"$ref":"#/components/schemas/IdentityLinkEntry"},"message":{"type":"string","description":"Message of the failure.","example":"This record could not be stored due to timeout."}}}},"components/schemas/IdentityResolutionConfiguration":{"id":"components/schemas/IdentityResolutionConfiguration","kind":"json-schema","title":"IdentityResolutionConfiguration","data":{"type":"object","description":"Configuration for Identity Resolution","properties":{"candidateSearchConfiguration":{"$ref":"#/components/schemas/CandidateSearchConfiguration"},"generalMatchingConfiguration":{"$ref":"#/components/schemas/MatchingConfiguration"},"scopedMatchingConfigurations":{"$ref":"#/components/schemas/ScopedMatchingConfigurations"}}}},"components/schemas/CandidateSearchConfiguration":{"id":"components/schemas/CandidateSearchConfiguration","kind":"json-schema","title":"CandidateSearchConfiguration","data":{"type":"object","description":"Configuration for candidate search.\n","properties":{"maxCandidates":{"type":"integer","format":"int32","description":"Maximum number of candidates to return.","minimum":1,"maximum":200,"default":10,"example":10},"searchAttributes":{"type":"array","description":"List of attributes to use for candidate search.\n","items":{"$ref":"#/components/schemas/SearchAttribute"}}}}},"components/schemas/SearchAttribute":{"id":"components/schemas/SearchAttribute","kind":"json-schema","title":"SearchAttribute","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All JSONPath expressions must follow "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc9535"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC9535"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax. List of attributes can be obtained by dedicated endpoint."},"children":[]}]}]}],"properties":{"jsonPath":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC9535-compliant JSON path to the attribute."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers[?(@.type.technicalKey=='GS1_GLN')].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses[0].country.value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.record['Country']"},"children":[]}]}]}]}],"example":"$.externalId"}}}},"components/schemas/MatchingConfiguration":{"id":"components/schemas/MatchingConfiguration","kind":"json-schema","title":"MatchingConfiguration","data":{"type":"object","description":"Configuration for Matching","properties":{"threshold":{"type":"number","format":"double","description":"The threshold for the data matching.","example":"0.5","default":0,"minimum":0,"maximum":1},"thresholdMaybe":{"type":"number","format":"double","description":"Threshold for maybe matching.","example":"0.6","default":0,"minimum":0,"maximum":1},"matchingAttributes":{"type":"array","description":"List of attributes to use for matching.","items":{"$ref":"#/components/schemas/MatchingAttribute"}}}}},"components/schemas/ScopedMatchingConfigurations":{"id":"components/schemas/ScopedMatchingConfigurations","kind":"json-schema","title":"ScopedMatchingConfigurations","data":{"type":"array","description":"List of configurations for scoped matching","items":{"$ref":"#/components/schemas/ScopedMatchingConfiguration"}}},"components/schemas/ScopedMatchingConfiguration":{"id":"components/schemas/ScopedMatchingConfiguration","kind":"json-schema","title":"ScopedMatchingConfiguration","data":{"type":"object","description":"Configuration for scoped matching","properties":{"scope":{"$ref":"#/components/schemas/MatchingScope"},"matchingConfiguration":{"$ref":"#/components/schemas/MatchingConfiguration"}}}},"components/schemas/MatchingScope":{"id":"components/schemas/MatchingScope","kind":"json-schema","title":"MatchingScope","data":{"type":"object","description":"Scope definition","properties":{"jsonPath":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC9535-compliant JSON path to the attribute."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessPartner.identifiers[?(@.type.technicalKey=='GS1_GLN')].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessPartner.identifiers[0].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessPartner.record['Country']"},"children":[]}]}]}]}],"example":"businessPartner.addresses[0].country.shortName"},"matchingValues":{"type":"array","description":"List of values that trigger this scoped configuration when matched against the value extracted from the specified JSON path.","items":{"$ref":"#/components/schemas/MatchingScopeValue"},"example":["DE","CH","AT"]}}}},"components/schemas/MatchingScopeValue":{"id":"components/schemas/MatchingScopeValue","kind":"json-schema","title":"MatchingScopeValue","data":{"type":"string","description":"Value that trigger this scoped configuration when matched against the value extracted from the specified JSON path","example":"DE"}},"components/schemas/MatchingAttribute":{"id":"components/schemas/MatchingAttribute","kind":"json-schema","title":"MatchingAttribute","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All JSONPath expressions must follow "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc9535"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC9535"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax. List of attributes can be obtained by dedicated endpoint."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"Name of the attribute.","example":"Name"},"jsonPath":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC9535-compliant JSON path to the attribute."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessPartner.identifiers[?(@.type.technicalKey=='GS1_GLN')].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessPartner.identifiers[0].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record['Country']"},"children":[]}]}]}]}],"example":"businessPartner.identifiers[?(@.type.technicalKey=='GS1_GLN')].value"},"cleaners":{"type":"array","description":"List of cleaners to apply to the attribute.","items":{"$ref":"#/components/schemas/MatchingAttributeCleaner"}},"high":{"type":"number","format":"double","description":"High weight for the attribute.","example":0.6,"default":0,"minimum":0,"maximum":1},"low":{"type":"number","format":"double","description":"Low weight for the attribute.","example":0.5,"default":0,"minimum":0,"maximum":1},"comparator":{"$ref":"#/components/schemas/MatchingAttributeComparator"}}}},"components/schemas/MatchingAttributeCleaner":{"id":"components/schemas/MatchingAttributeCleaner","kind":"json-schema","title":"MatchingAttributeCleaner","data":{"type":"object","description":"Configuration for cleaning attributes","properties":{"name":{"type":"string","description":"Name of the attribute.","example":"LowerCaseNormalizeCleaner"},"parameters":{"type":"array","description":"Configuration for the cleaner.","items":{"$ref":"#/components/schemas/MatchingAttributeParameter"}}}}},"components/schemas/MatchingAttributeComparator":{"id":"components/schemas/MatchingAttributeComparator","kind":"json-schema","title":"MatchingAttributeComparator","data":{"type":"object","description":"Configuration for comparing attributes","properties":{"name":{"type":"string","description":"Name of the comparator.","example":"QGramComparator"},"parameters":{"type":"array","description":"Configuration for the comparator.","items":{"$ref":"#/components/schemas/MatchingAttributeParameter"}}}}},"components/schemas/MatchingAttributeParameter":{"id":"components/schemas/MatchingAttributeParameter","kind":"json-schema","title":"MatchingAttributeParameter","data":{"type":"object","description":"Defines a single parameter for a matching attribute comparator, consisting of a name and a value.","properties":{"name":{"type":"string","description":"The name of the parameter.","example":"formula"},"value":{"type":"object","description":"The value of the parameter.","example":"JACCARD"}}}},"components/schemas/DefaultWorkspaceConfiguration":{"id":"components/schemas/DefaultWorkspaceConfiguration","kind":"json-schema","title":"DefaultWorkspaceConfiguration","data":{"type":"boolean","description":"Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.","example":true}},"components/schemas/WorkspaceConfigurationResponsePage":{"id":"components/schemas/WorkspaceConfigurationResponsePage","kind":"json-schema","title":"WorkspaceConfigurationResponsePage","data":{"type":"object","description":"Page of workspace configurations.","properties":{"startAfter":{"$ref":"#/components/schemas/StartAfter"},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"},"total":{"$ref":"#/components/schemas/PageTotal"},"values":{"type":"array","description":"List of workspace configurations.","items":{"$ref":"#/components/schemas/WorkspaceConfigurationSearchResult"}}}}},"components/schemas/WorkspaceConfigurationSearchResult":{"id":"components/schemas/WorkspaceConfigurationSearchResult","kind":"json-schema","title":"WorkspaceConfigurationSearchResult","data":{"type":"object","description":"Workspace configuration search result.","properties":{"id":{"$ref":"#/components/schemas/ConfigurationId"},"name":{"$ref":"#/components/schemas/ConfigurationName"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"}}}},"components/schemas/WorkspaceConfigurationCopiedFrom":{"id":"components/schemas/WorkspaceConfigurationCopiedFrom","kind":"json-schema","title":"WorkspaceConfigurationCopiedFrom","data":{"type":"object","description":"The configuration from which the new configuration is copied.","required":["configurationId","workspaceId"],"properties":{"configurationId":{"$ref":"#/components/schemas/ConfigurationId"},"workspaceId":{"$ref":"#/components/schemas/WorkspaceId"}}}},"components/schemas/WorkspaceConfigurationResponse":{"id":"components/schemas/WorkspaceConfigurationResponse","kind":"json-schema","title":"WorkspaceConfigurationResponse","data":{"type":"object","description":"Contains the configuration and metadata.","properties":{"id":{"$ref":"#/components/schemas/ConfigurationId"},"name":{"$ref":"#/components/schemas/ConfigurationName"},"version":{"$ref":"#/components/schemas/ConfigurationVersionNumber"},"configuration":{"$ref":"#/components/schemas/IdentityResolutionConfiguration"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"defaultConfiguration":{"$ref":"#/components/schemas/DefaultWorkspaceConfiguration"},"transactionId":{"$ref":"#/components/schemas/TransactionId"}}}},"components/schemas/WorkspaceConfigurationVersionResponse":{"id":"components/schemas/WorkspaceConfigurationVersionResponse","kind":"json-schema","title":"WorkspaceConfigurationVersionResponse","data":{"type":"object","description":"Specific version of an identity resolution configuration.","properties":{"id":{"type":"string","description":"Unique identifier of the identity resolution configuration version. Not to be confused with the configuration ID.","example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"},"name":{"type":"string","description":"The name of the configuration","example":"Configuration Name"},"configurationId":{"$ref":"#/components/schemas/ConfigurationId"},"version":{"$ref":"#/components/schemas/ConfigurationVersionNumber"},"configuration":{"$ref":"#/components/schemas/IdentityResolutionConfiguration"},"createdAt":{"type":"string","description":"Date and time when the first version of the configuration was created (ISO 8601-compliant).","example":"2026-11-11T03:23:28Z"},"modifiedAt":{"type":"string","description":"Date and time when this version of the configuration was created (ISO 8601-compliant).","example":"2026-11-11T03:23:28Z"},"createdBy":{"type":"string","description":"User who created the first version of the configuration.","example":"69129435489347624"},"modifiedBy":{"type":"string","description":"User who created this version of the configuration.","example":"76248934691294444"},"defaultConfiguration":{"$ref":"#/components/schemas/DefaultWorkspaceConfiguration"}}}},"components/schemas/ConfigurationVersionNumber":{"id":"components/schemas/ConfigurationVersionNumber","kind":"json-schema","title":"ConfigurationVersionNumber","data":{"type":"integer","description":"Version number of the configuration.","example":1}},"components/schemas/Cleaner":{"id":"components/schemas/Cleaner","kind":"json-schema","title":"Cleaner","data":{"type":"object","description":"Cleaner used for cleaning the data.","properties":{"name":{"$ref":"#/components/schemas/CleanerName"},"technicalKey":{"$ref":"#/components/schemas/CleanerTechnicalKey"},"parameters":{"type":"array","description":"Configuration for the cleaner.","items":{"$ref":"#/components/schemas/CleanerParameter"}}}}},"components/schemas/CleanerName":{"id":"components/schemas/CleanerName","kind":"json-schema","title":"CleanerName","data":{"type":"string","description":"Name of the cleaner.","example":"Lower-case Normalization"}},"components/schemas/CleanerTechnicalKey":{"id":"components/schemas/CleanerTechnicalKey","kind":"json-schema","title":"CleanerTechnicalKey","data":{"type":"string","description":"Technical key of the cleaner.","example":"LowerCaseNormalizer"}},"components/schemas/CleanerParameter":{"id":"components/schemas/CleanerParameter","kind":"json-schema","title":"CleanerParameter","data":{"type":"object","description":"Parameter for the cleaner.","properties":{"name":{"type":"string","description":"Name of the cleaner.","example":"RegexpCleaner"},"description":{"type":"string","description":"Description of the cleaner.","example":"A regular expression to use on the attribute."}}}},"components/schemas/Comparator":{"id":"components/schemas/Comparator","kind":"json-schema","title":"Comparator","data":{"type":"object","description":"Comparator used for comparing the data.","properties":{"name":{"$ref":"#/components/schemas/ComparatorName"},"technicalKey":{"$ref":"#/components/schemas/ComparatorTechnicalKey"},"parameters":{"type":"array","description":"Configuration for the cleaner.","items":{"$ref":"#/components/schemas/ComparatorParameter"}}}}},"components/schemas/ComparatorName":{"id":"components/schemas/ComparatorName","kind":"json-schema","title":"ComparatorName","data":{"type":"string","description":"Name of the comparator","example":"QGram Comparator"}},"components/schemas/ComparatorTechnicalKey":{"id":"components/schemas/ComparatorTechnicalKey","kind":"json-schema","title":"ComparatorTechnicalKey","data":{"type":"string","description":"Technical key of the comparator.","example":"QGramComparator"}},"components/schemas/ComparatorParameter":{"id":"components/schemas/ComparatorParameter","kind":"json-schema","title":"ComparatorParameter","data":{"type":"object","description":"Parameter for the comparator.","properties":{"name":{"type":"string","description":"Name of the comparator.","example":"formula"},"description":{"type":"string","description":"Description of the comparator.","example":"A formula to use to compute the actual similarity"}}}},"components/schemas/RelatedConfiguration":{"id":"components/schemas/RelatedConfiguration","kind":"json-schema","title":"RelatedConfiguration","data":{"type":"object","description":"Id of the related configuration.","properties":{"id":{"$ref":"#/components/schemas/RelatedConfigurationId"},"owner":{"$ref":"#/components/schemas/RelatedConfigurationOwner"}}}},"components/schemas/RelatedConfigurationId":{"id":"components/schemas/RelatedConfigurationId","kind":"json-schema","title":"RelatedConfigurationId","data":{"type":"string","description":"Id of the related configuration.","example":"a0200062daa56952a8640005"}},"components/schemas/RelatedConfigurationOwner":{"id":"components/schemas/RelatedConfigurationOwner","kind":"json-schema","title":"RelatedConfigurationOwner","data":{"type":"object","description":"Configuration which relates to the root configuration.","properties":{"service":{"$ref":"#/components/schemas/RelatedConfigurationOwnerService"},"path":{"$ref":"#/components/schemas/RelatedConfigurationOwnerPath"}}}},"components/schemas/RelatedConfigurationOwnerService":{"id":"components/schemas/RelatedConfigurationOwnerService","kind":"json-schema","title":"RelatedConfigurationOwnerService","data":{"type":"string","description":"Name of the service that is the owner of the configuration.","example":"reference-data-api"}},"components/schemas/RelatedConfigurationOwnerPath":{"id":"components/schemas/RelatedConfigurationOwnerPath","kind":"json-schema","title":"RelatedConfigurationOwnerPath","data":{"type":"string","description":"Endpoint used to read the related configuration.","example":"/public/configurations/businesspartnerlookup"}},"components/schemas/TransactionFeature":{"id":"components/schemas/TransactionFeature","kind":"json-schema","title":"TransactionFeature","data":{"type":"string","description":"Feature used to control transaction process.","example":"CREATE_TRANSACTION"}},"components/schemas/AttributePathsResult":{"id":"components/schemas/AttributePathsResult","kind":"json-schema","title":"AttributePathsResult","data":{"type":"object","description":"Result of the attribute paths request.","properties":{"paths":{"type":"array","description":"List of attribute paths.","items":{"type":"string","description":"Attribute path.","example":"businessPartner.addresses[].country.shortName"}},"status":{"$ref":"#/components/schemas/Status"}}}},"components/schemas/CleanersResult":{"id":"components/schemas/CleanersResult","kind":"json-schema","title":"CleanersResult","data":{"type":"object","description":"Result of the cleaners request.","properties":{"cleaners":{"type":"array","description":"List of cleaners.","items":{"$ref":"#/components/schemas/Cleaner"}},"status":{"$ref":"#/components/schemas/Status"}}}},"components/schemas/ComparatorsResult":{"id":"components/schemas/ComparatorsResult","kind":"json-schema","title":"ComparatorsResult","data":{"type":"object","description":"Result of the comparators request.","properties":{"comparators":{"type":"array","description":"List of comparators.","items":{"$ref":"#/components/schemas/Comparator"}},"status":{"$ref":"#/components/schemas/Status"}}}},"components/schemas/SearchAttributeResult":{"id":"components/schemas/SearchAttributeResult","kind":"json-schema","title":"SearchAttributeResult","data":{"type":"object","description":"Result of the search attribute request.","properties":{"searchAttributes":{"type":"array","description":"List of search attributes.","items":{"description":"Search attribute","type":"string","example":"$.names[].type.technicalKey"}},"status":{"$ref":"#/components/schemas/Status"}}}},"components/schemas/BusinessPartnerId":{"id":"components/schemas/BusinessPartnerId","kind":"json-schema","title":"BusinessPartnerId","data":{"type":"string","description":"Technical identifier of a business partner record, unique within the CDQ.","example":"63e635235c06b7396330fe40"}},"components/schemas/NameShortName":{"id":"components/schemas/NameShortName","kind":"json-schema","title":"NameShortName","data":{"type":"string","description":"The abbreviated variant of a company's full name.","example":"CDQ AG"}},"components/schemas/NameTypeUrl":{"id":"components/schemas/NameTypeUrl","kind":"json-schema","title":"NameTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the name type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/NameTypeName":{"id":"components/schemas/NameTypeName","kind":"json-schema","title":"NameTypeName","data":{"type":"string","description":"Display label for the Name Type.","example":"Local Name"}},"components/schemas/NameTypeTechnicalKey":{"id":"components/schemas/NameTypeTechnicalKey","kind":"json-schema","title":"NameTypeTechnicalKey","data":{"type":"string","description":"Technical Keys of the Name Type.","example":"LOCAL"}},"components/schemas/schemas-NameType":{"id":"components/schemas/schemas-NameType","kind":"json-schema","title":"schemas-NameType","data":{"type":"object","description":"The type of the name, e.g. a locally used name or an international version.","properties":{"url":{"$ref":"#/components/schemas/NameTypeUrl"},"name":{"$ref":"#/components/schemas/NameTypeName"},"technicalKey":{"$ref":"#/components/schemas/NameTypeTechnicalKey"}}}},"components/schemas/NameValue":{"id":"components/schemas/NameValue","kind":"json-schema","title":"NameValue","data":{"type":"string","description":"The actual name.","example":"Corporate Data Quality AG"}},"components/schemas/LanguageName":{"id":"components/schemas/LanguageName","kind":"json-schema","title":"LanguageName","data":{"type":"string","description":"ISO 639-1 name of language.","example":"German"}},"components/schemas/LanguageTechnicalKey":{"id":"components/schemas/LanguageTechnicalKey","kind":"json-schema","title":"LanguageTechnicalKey","data":{"type":"string","description":"ISO 639-1 two-letter code of languages.","example":"DE"}},"components/schemas/Language":{"id":"components/schemas/Language","kind":"json-schema","title":"Language","data":{"type":"object","description":"Naming of a language according to ISO 639-1.","properties":{"name":{"$ref":"#/components/schemas/LanguageName"},"technicalKey":{"$ref":"#/components/schemas/LanguageTechnicalKey"}}}},"components/schemas/schemas-Name":{"id":"components/schemas/schemas-Name","kind":"json-schema","title":"schemas-Name","data":{"type":"object","description":"The name of a business partner.","properties":{"shortName":{"$ref":"#/components/schemas/NameShortName"},"type":{"$ref":"#/components/schemas/schemas-NameType"},"value":{"$ref":"#/components/schemas/NameValue"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/NormalizedName":{"id":"components/schemas/NormalizedName","kind":"json-schema","title":"NormalizedName","data":{"type":"string","description":"Normalized business partner name (without accents or special characters, all lower case).","example":"skoda auto as"}},"components/schemas/NameWithoutLegalForm":{"id":"components/schemas/NameWithoutLegalForm","kind":"json-schema","title":"NameWithoutLegalForm","data":{"type":"string","description":"Business partner name without legal form (if identified).","example":"skoda auto"}},"components/schemas/NameTermValue":{"id":"components/schemas/NameTermValue","kind":"json-schema","title":"NameTermValue","data":{"type":"string","description":"Value of the name term.","example":"Legal Form"}},"components/schemas/NameTermType":{"id":"components/schemas/NameTermType","kind":"json-schema","title":"NameTermType","data":{"type":"string","description":"Type of the term.","example":"LEGAL_FORM"}},"components/schemas/NameTerm":{"id":"components/schemas/NameTerm","kind":"json-schema","title":"NameTerm","data":{"type":"object","description":"Term which is used to calculate matching scores.","properties":{"value":{"$ref":"#/components/schemas/NameTermValue"},"type":{"$ref":"#/components/schemas/NameTermType"}}}},"components/schemas/NameValueClassification":{"id":"components/schemas/NameValueClassification","kind":"json-schema","title":"NameValueClassification","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The classified terms. e.g. For CDQ AG -> cdq -> ag->LEGAL_FORM."},"children":[]}]}]}],"properties":{"normalizedName":{"$ref":"#/components/schemas/NormalizedName"},"nameWithoutLegalForm":{"$ref":"#/components/schemas/NameWithoutLegalForm"},"terms":{"type":"array","items":{"$ref":"#/components/schemas/NameTerm"}}}}},"components/schemas/LegalFormName":{"id":"components/schemas/LegalFormName","kind":"json-schema","title":"LegalFormName","data":{"type":"string","description":"Display of the Legal Form.","example":"Aktiengesellschaft"}},"components/schemas/LegalFormMainAbbreviation":{"id":"components/schemas/LegalFormMainAbbreviation","kind":"json-schema","title":"LegalFormMainAbbreviation","data":{"type":"string","description":"The primary abbreviation of a legal form, i.e. the most commonly used abbreviation in a country.","example":"AG"}},"components/schemas/LegalFormCdlElfCode":{"id":"components/schemas/LegalFormCdlElfCode","kind":"json-schema","title":"LegalFormCdlElfCode","data":{"deprecated":true,"type":"string","description":"An unique identifier for CDL managed Legal Forms.","example":"AG"}},"components/schemas/LegalFormCategoryName":{"id":"components/schemas/LegalFormCategoryName","kind":"json-schema","title":"LegalFormCategoryName","data":{"type":"string","maxLength":40,"description":"Descriptive display name of the Legal Form Category.","example":"Limited Liability Company"}},"components/schemas/LegalFormCategoryShortName":{"id":"components/schemas/LegalFormCategoryShortName","kind":"json-schema","title":"LegalFormCategoryShortName","data":{"type":"string","maxLength":15,"description":"Short display name of the Legal Form Category.","example":"LLC"}},"components/schemas/LegalFormCategoryUrl":{"id":"components/schemas/LegalFormCategoryUrl","kind":"json-schema","title":"LegalFormCategoryUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the legal form category.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/LegalFormCategoryTechnicalKey":{"id":"components/schemas/LegalFormCategoryTechnicalKey","kind":"json-schema","title":"LegalFormCategoryTechnicalKey","data":{"type":"string","description":"Technical key of the legal form category.","example":"LIMITED"}},"components/schemas/LegalFormCategory":{"id":"components/schemas/LegalFormCategory","kind":"json-schema","title":"LegalFormCategory","data":{"type":"object","description":"The categorization of a Legal Form.","properties":{"name":{"$ref":"#/components/schemas/LegalFormCategoryName"},"shortName":{"$ref":"#/components/schemas/LegalFormCategoryShortName"},"url":{"$ref":"#/components/schemas/LegalFormCategoryUrl"},"technicalKey":{"$ref":"#/components/schemas/LegalFormCategoryTechnicalKey"}}}},"components/schemas/LegalFormUrl":{"id":"components/schemas/LegalFormUrl","kind":"json-schema","title":"LegalFormUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of legal form.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/LegalFormTechnicalKey":{"id":"components/schemas/LegalFormTechnicalKey","kind":"json-schema","title":"LegalFormTechnicalKey","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical Key of a Legal Form. Descriptions of below enums contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country Scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"International Name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Main Abraviation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"DE_9866"}},"components/schemas/schemas-LegalForm":{"id":"components/schemas/schemas-LegalForm","kind":"json-schema","title":"schemas-LegalForm","data":{"type":"object","description":"The legal form of a business partner/type/legal entity is the form it takes in the eyes of the law governing it. The legal form of a company is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the company's name (e.g. AG, Inc., LLC, S.A.).","properties":{"name":{"$ref":"#/components/schemas/LegalFormName"},"language":{"$ref":"#/components/schemas/Language"},"mainAbbreviation":{"$ref":"#/components/schemas/LegalFormMainAbbreviation"},"cdlElfCode":{"$ref":"#/components/schemas/LegalFormCdlElfCode"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/LegalFormCategory"}},"url":{"$ref":"#/components/schemas/LegalFormUrl"},"technicalKey":{"$ref":"#/components/schemas/LegalFormTechnicalKey"}}}},"components/schemas/IdentifierValue":{"id":"components/schemas/IdentifierValue","kind":"json-schema","title":"IdentifierValue","data":{"type":"string","description":"Value of the identifier.","example":"CHE-218.608.886 HR/MWST"}},"components/schemas/IdentifierTypeUrl":{"id":"components/schemas/IdentifierTypeUrl","kind":"json-schema","title":"IdentifierTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of an identifier.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/IdentifierTypeName":{"id":"components/schemas/IdentifierTypeName","kind":"json-schema","title":"IdentifierTypeName","data":{"type":"string","description":"Display label for the Identifier.","example":"CH_VAT_ID"}},"components/schemas/IdentifierTypeTechnicalKey":{"id":"components/schemas/IdentifierTypeTechnicalKey","kind":"json-schema","title":"IdentifierTypeTechnicalKey","data":{"type":"string","description":"Technical key of the type of the Identifier.","example":"CH_VAT_ID"}},"components/schemas/schemas-IdentifierType":{"id":"components/schemas/schemas-IdentifierType","kind":"json-schema","title":"schemas-IdentifierType","data":{"type":"object","description":"Type of the identifier.","properties":{"url":{"$ref":"#/components/schemas/IdentifierTypeUrl"},"name":{"$ref":"#/components/schemas/IdentifierTypeName"},"technicalKey":{"$ref":"#/components/schemas/IdentifierTypeTechnicalKey"}}}},"components/schemas/IdentifierStatusName":{"id":"components/schemas/IdentifierStatusName","kind":"json-schema","title":"IdentifierStatusName","data":{"type":"string","description":"Display label for the Identifier Status Name.","example":"ACTIVE"}},"components/schemas/IdentifierStatusTypeUrl":{"id":"components/schemas/IdentifierStatusTypeUrl","kind":"json-schema","title":"IdentifierStatusTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the identifier status.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/IdentifierStatusTechnicalKey":{"id":"components/schemas/IdentifierStatusTechnicalKey","kind":"json-schema","title":"IdentifierStatusTechnicalKey","data":{"type":"string","description":"Technical key of the Identifier Status.","example":"ACTIVE"}},"components/schemas/IdentifierStatus":{"id":"components/schemas/IdentifierStatus","kind":"json-schema","title":"IdentifierStatus","data":{"type":"object","description":"Identifier Status refers to the current state of a unique identification number.","properties":{"name":{"$ref":"#/components/schemas/IdentifierStatusName"},"url":{"$ref":"#/components/schemas/IdentifierStatusTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/IdentifierStatusTechnicalKey"}}}},"components/schemas/IssuingBodyName":{"id":"components/schemas/IssuingBodyName","kind":"json-schema","title":"IssuingBodyName","data":{"type":"string","description":"Preferred display label for an Issuing Body.","example":"Amtsgericht Aachen"}},"components/schemas/IssuingBodyShortName":{"id":"components/schemas/IssuingBodyShortName","kind":"json-schema","title":"IssuingBodyShortName","data":{"type":"string","description":"Preferred short display label for an Issuing Body.","maxLength":50,"example":"Amtsgericht Aachen"}},"components/schemas/IssuingBodyDescription":{"id":"components/schemas/IssuingBodyDescription","kind":"json-schema","title":"IssuingBodyDescription","data":{"type":"string","description":"Description for an Issuing Body.","example":"Amtsgericht Aachen"}},"components/schemas/IssuingBodyUrl":{"id":"components/schemas/IssuingBodyUrl","kind":"json-schema","title":"IssuingBodyUrl","data":{"description":"URL to the documentation which summarizes all details of an issuing body.","example":"https://meta.cdq.com/Public:CDQ_data_model","type":"string"}},"components/schemas/IssuingBodyTechnicalKey":{"id":"components/schemas/IssuingBodyTechnicalKey","kind":"json-schema","title":"IssuingBodyTechnicalKey","data":{"description":"Technical key of the Issuing Body.","example":"Amtsgericht Aachen","type":"string"}},"components/schemas/CountryShortName":{"id":"components/schemas/CountryShortName","kind":"json-schema","title":"CountryShortName","data":{"type":"string","description":"Country code (ISO 3166-1 alpha-2).","example":"CH"}},"components/schemas/CountryValue":{"id":"components/schemas/CountryValue","kind":"json-schema","title":"CountryValue","data":{"type":"string","description":"Country name (ISO 3166-1 alpha-2).","example":"Switzerland"}},"components/schemas/schemas-Country":{"id":"components/schemas/schemas-Country","kind":"json-schema","title":"schemas-Country","data":{"type":"object","description":"Country consisting of the country name and country code (ISO 3166-1 alpha-2).","properties":{"shortName":{"$ref":"#/components/schemas/CountryShortName"},"value":{"$ref":"#/components/schemas/CountryValue"}}}},"components/schemas/AdministrativeAreaValue":{"id":"components/schemas/AdministrativeAreaValue","kind":"json-schema","title":"AdministrativeAreaValue","data":{"type":"string","description":"Name of the administrative area.","example":"Sankt Gallen"}},"components/schemas/AdministrativeAreaShortName":{"id":"components/schemas/AdministrativeAreaShortName","kind":"json-schema","title":"AdministrativeAreaShortName","data":{"type":"string","description":"Abbreviation for the administrative area.","example":"SG"}},"components/schemas/AdministrativeAreaFipsCode":{"id":"components/schemas/AdministrativeAreaFipsCode","kind":"json-schema","title":"AdministrativeAreaFipsCode","data":{"type":"string","description":"FIPS codes are numbers which uniquely identify geographic areas. The number of digits in FIPS codes vary depending on the level of geography. State-level FIPS codes have two digits, county-level FIPS codes have five digits of which the first two are the FIPS code of the state to which the county belongs.","example":"SZ15"}},"components/schemas/AdministrativeAreaIsoCode":{"id":"components/schemas/AdministrativeAreaIsoCode","kind":"json-schema","title":"AdministrativeAreaIsoCode","data":{"type":"string","description":"ISO 3166-2 code which uniquely defines the names of countries and their subdivisions (e.g., provinces or states).","example":"CH-SG"}},"components/schemas/AdministrativeAreaTypeName":{"id":"components/schemas/AdministrativeAreaTypeName","kind":"json-schema","title":"AdministrativeAreaTypeName","data":{"type":"string","description":"Display label for the Administrative Area Type.","example":"COUNTY"}},"components/schemas/AdministrativeAreaTypeUrl":{"id":"components/schemas/AdministrativeAreaTypeUrl","kind":"json-schema","title":"AdministrativeAreaTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the administrative area type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/AdministrativeAreaTypeTechnicalKey":{"id":"components/schemas/AdministrativeAreaTypeTechnicalKey","kind":"json-schema","title":"AdministrativeAreaTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Administrative Area.","example":"COUNTY"}},"components/schemas/schemas-AdministrativeAreaType":{"id":"components/schemas/schemas-AdministrativeAreaType","kind":"json-schema","title":"schemas-AdministrativeAreaType","data":{"type":"object","description":"Type of the administrative area.","properties":{"name":{"$ref":"#/components/schemas/AdministrativeAreaTypeName"},"url":{"$ref":"#/components/schemas/AdministrativeAreaTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/AdministrativeAreaTypeTechnicalKey"}}}},"components/schemas/schemas-AdministrativeArea":{"id":"components/schemas/schemas-AdministrativeArea","kind":"json-schema","title":"schemas-AdministrativeArea","data":{"type":"object","description":"A top-level geographical or political area division in a country.","properties":{"value":{"$ref":"#/components/schemas/AdministrativeAreaValue"},"shortName":{"$ref":"#/components/schemas/AdministrativeAreaShortName"},"fipsCode":{"$ref":"#/components/schemas/AdministrativeAreaFipsCode"},"isoCode":{"$ref":"#/components/schemas/AdministrativeAreaIsoCode"},"type":{"$ref":"#/components/schemas/schemas-AdministrativeAreaType"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/Jurisdiction":{"id":"components/schemas/Jurisdiction","kind":"json-schema","title":"Jurisdiction","data":{"type":"object","description":"The authority of an official organization to make decisions and judgments in a particular administrative area.","required":["country"],"properties":{"country":{"$ref":"#/components/schemas/schemas-Country"},"administrativeAreas":{"type":"array","items":{"$ref":"#/components/schemas/schemas-AdministrativeArea"}}}}},"components/schemas/IssuingBodyGleifCode":{"id":"components/schemas/IssuingBodyGleifCode","kind":"json-schema","title":"IssuingBodyGleifCode","data":{"type":"string","description":"Code of Global Legal Entity Identifier Foundation (GLEIF)","example":"RA000004"}},"components/schemas/IssuingBodyLocalAuthorityCode":{"id":"components/schemas/IssuingBodyLocalAuthorityCode","kind":"json-schema","title":"IssuingBodyLocalAuthorityCode","data":{"type":"string","description":"Code of the local registration authority","example":"R3101"}},"components/schemas/IssuingBodyExternalUrl":{"id":"components/schemas/IssuingBodyExternalUrl","kind":"json-schema","title":"IssuingBodyExternalUrl","data":{"type":"string","description":"External url of the issuing body","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/IssuingBody":{"id":"components/schemas/IssuingBody","kind":"json-schema","title":"IssuingBody","data":{"type":"object","description":"An Issuing Body is an organization or government institution that is responsible for assigning unique identifiers to individuals, organizations, or objects.","properties":{"name":{"$ref":"#/components/schemas/IssuingBodyName"},"shortName":{"$ref":"#/components/schemas/IssuingBodyShortName"},"names":{"type":"array","items":{"$ref":"#/components/schemas/schemas-Name"}},"description":{"$ref":"#/components/schemas/IssuingBodyDescription"},"url":{"$ref":"#/components/schemas/IssuingBodyUrl"},"technicalKey":{"$ref":"#/components/schemas/IssuingBodyTechnicalKey"},"jurisdiction":{"$ref":"#/components/schemas/Jurisdiction"},"gleifCode":{"$ref":"#/components/schemas/IssuingBodyGleifCode"},"localAuthorityCode":{"$ref":"#/components/schemas/IssuingBodyLocalAuthorityCode"},"externalUrl":{"$ref":"#/components/schemas/IssuingBodyExternalUrl"}}}},"components/schemas/schemas-Identifier":{"id":"components/schemas/schemas-Identifier","kind":"json-schema","title":"schemas-Identifier","data":{"type":"object","description":"Identifies a business partner in a given context uniquely such as a VAT identification number.","properties":{"value":{"$ref":"#/components/schemas/IdentifierValue"},"type":{"$ref":"#/components/schemas/schemas-IdentifierType"},"status":{"$ref":"#/components/schemas/IdentifierStatus"},"issuingBody":{"$ref":"#/components/schemas/IssuingBody"}}}},"components/schemas/BusinessPartnerCategoryName":{"id":"components/schemas/BusinessPartnerCategoryName","kind":"json-schema","title":"BusinessPartnerCategoryName","data":{"type":"string","description":"Display name of the Business Partner Category Name.","example":"Hotel"}},"components/schemas/BusinessPartnerCategoryUrl":{"id":"components/schemas/BusinessPartnerCategoryUrl","kind":"json-schema","title":"BusinessPartnerCategoryUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the business partner category.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/BusinessPartnerCategoryTechnicalKey":{"id":"components/schemas/BusinessPartnerCategoryTechnicalKey","kind":"json-schema","title":"BusinessPartnerCategoryTechnicalKey","data":{"type":"string","description":"Technical Key of the Business Partner Category.","example":"HOTEL"}},"components/schemas/BusinessPartnerCategory":{"id":"components/schemas/BusinessPartnerCategory","kind":"json-schema","title":"BusinessPartnerCategory","data":{"type":"object","description":"A business partner category of a business partner groups similar business partners.","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerCategoryName"},"url":{"$ref":"#/components/schemas/BusinessPartnerCategoryUrl"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerCategoryTechnicalKey"}}}},"components/schemas/BusinessPartnerStatusOfficialDenotation":{"id":"components/schemas/BusinessPartnerStatusOfficialDenotation","kind":"json-schema","title":"BusinessPartnerStatusOfficialDenotation","data":{"type":"string","description":"The status as provided by an official register.","example":"Good Standing"}},"components/schemas/BusinessPartnerStatusValidFrom":{"id":"components/schemas/BusinessPartnerStatusValidFrom","kind":"json-schema","title":"BusinessPartnerStatusValidFrom","data":{"type":"string","description":"Describes since when a business partner turned or will turn into the provided status. If no official date is known, the date of changing the status in the CDQ Community Data Pool or an external data source is provided.","example":"2026-11-11T03:23:28Z"}},"components/schemas/BusinessPartnerStatusValidUntil":{"id":"components/schemas/BusinessPartnerStatusValidUntil","kind":"json-schema","title":"BusinessPartnerStatusValidUntil","data":{"type":"string","description":"Describes until when a business partner had a certain status. If no official date is known, the date of changing the status in the CDQ Community Data Pool or an external data source is provided.","example":"2026-11-11T03:23:28Z"}},"components/schemas/BusinessPartnerStatusTypeName":{"id":"components/schemas/BusinessPartnerStatusTypeName","kind":"json-schema","title":"BusinessPartnerStatusTypeName","data":{"type":"string","description":"Display name of the Business Partner Status.","example":"In Liquidation"}},"components/schemas/BusinessPartnerStatusTypeUrl":{"id":"components/schemas/BusinessPartnerStatusTypeUrl","kind":"json-schema","title":"BusinessPartnerStatusTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the business partner status.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/BusinessPartnerStatusTypeTechnicalKey":{"id":"components/schemas/BusinessPartnerStatusTypeTechnicalKey","kind":"json-schema","title":"BusinessPartnerStatusTypeTechnicalKey","data":{"type":"string","description":"Technical Key of the Business Parter Status.","example":"IN_LIQUIDATION"}},"components/schemas/BusinessPartnerStatusType":{"id":"components/schemas/BusinessPartnerStatusType","kind":"json-schema","title":"BusinessPartnerStatusType","data":{"type":"object","description":"The standardized status which the business partner currently has.","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerStatusTypeName"},"url":{"$ref":"#/components/schemas/BusinessPartnerStatusTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerStatusTypeTechnicalKey"}}}},"components/schemas/BusinessPartnerStatus":{"id":"components/schemas/BusinessPartnerStatus","kind":"json-schema","title":"BusinessPartnerStatus","data":{"type":"object","description":"Describes the status of a business partner with respect to its level of activity (e.g. out of business) or legally relevant conditions (e.g. in liquidation).","properties":{"officialDenotation":{"$ref":"#/components/schemas/BusinessPartnerStatusOfficialDenotation"},"validFrom":{"$ref":"#/components/schemas/BusinessPartnerStatusValidFrom"},"validUntil":{"$ref":"#/components/schemas/BusinessPartnerStatusValidUntil"},"type":{"$ref":"#/components/schemas/BusinessPartnerStatusType"}}}},"components/schemas/CharacterSetName":{"id":"components/schemas/CharacterSetName","kind":"json-schema","title":"CharacterSetName","data":{"type":"string","description":"Name of character set. Supported character sets can be found here.","example":"International"}},"components/schemas/CharacterSetTechnicalKey":{"id":"components/schemas/CharacterSetTechnicalKey","kind":"json-schema","title":"CharacterSetTechnicalKey","data":{"type":"string","description":"Technical key of character set. Supported character sets can be found here.","example":"INTERNATIONAL"}},"components/schemas/CharacterSet":{"id":"components/schemas/CharacterSet","kind":"json-schema","title":"CharacterSet","data":{"type":"object","description":"Character set.","properties":{"name":{"$ref":"#/components/schemas/CharacterSetName"},"technicalKey":{"$ref":"#/components/schemas/CharacterSetTechnicalKey"}}}},"components/schemas/AddressVersion":{"id":"components/schemas/AddressVersion","kind":"json-schema","title":"AddressVersion","data":{"type":"object","description":"CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language.","properties":{"characterSet":{"$ref":"#/components/schemas/CharacterSet"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/AddressIdentifyingNameValue":{"id":"components/schemas/AddressIdentifyingNameValue","kind":"json-schema","title":"AddressIdentifyingNameValue","data":{"type":"string","description":"An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent.","example":"John Doe"}},"components/schemas/AddressIdentifyingName":{"id":"components/schemas/AddressIdentifyingName","kind":"json-schema","title":"AddressIdentifyingName","data":{"type":"object","description":"An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent.","properties":{"value":{"$ref":"#/components/schemas/AddressIdentifyingNameValue"}}}},"components/schemas/AddressExternalId":{"id":"components/schemas/AddressExternalId","kind":"json-schema","title":"AddressExternalId","data":{"type":"string","description":"ID the address has in the external system where the record originates from.","example":"1"}},"components/schemas/ProvenanceName":{"id":"components/schemas/ProvenanceName","kind":"json-schema","title":"ProvenanceName","data":{"type":"string","description":"Display Name of the Provenance Name.","example":"VIES"}},"components/schemas/ProvenanceUrl":{"id":"components/schemas/ProvenanceUrl","kind":"json-schema","title":"ProvenanceUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the Provenance Name.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/ProvenanceTechnicalKey":{"id":"components/schemas/ProvenanceTechnicalKey","kind":"json-schema","title":"ProvenanceTechnicalKey","data":{"type":"string","description":"Technical Key of the Provenance Name.","example":"VIES"}},"components/schemas/ProvenanceCdqId":{"id":"components/schemas/ProvenanceCdqId","kind":"json-schema","title":"ProvenanceCdqId","data":{"type":"string","description":"The ID provided for a linkage with the source by CDQ.","example":"VIES:PL8660001429"}},"components/schemas/Provenance":{"id":"components/schemas/Provenance","kind":"json-schema","title":"Provenance","data":{"type":"object","description":"The source of the change or update. Could be the reference data source as VIES or Organization.","properties":{"name":{"$ref":"#/components/schemas/ProvenanceName"},"url":{"$ref":"#/components/schemas/ProvenanceUrl"},"technicalKey":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"},"cdqId":{"$ref":"#/components/schemas/ProvenanceCdqId"}}}},"components/schemas/AddressMetadata":{"id":"components/schemas/AddressMetadata","kind":"json-schema","title":"AddressMetadata","data":{"type":"object","description":"Specifies the language and primary data provenance.","properties":{"primaryProvenance":{"$ref":"#/components/schemas/Provenance"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/CareOfValue":{"id":"components/schemas/CareOfValue","kind":"json-schema","title":"CareOfValue","data":{"type":"string","description":"Value of the CareOf.","example":"CDQ GmbH c/o Product Department"}},"components/schemas/CareOf":{"id":"components/schemas/CareOf","kind":"json-schema","title":"CareOf","data":{"type":"object","description":"Signifies an intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example, when the addressee has no standard address, is under a corporate mail system, or is being manually forwarded mail sent to a more accessible location.","properties":{"value":{"$ref":"#/components/schemas/CareOfValue"}}}},"components/schemas/AddressContextValue":{"id":"components/schemas/AddressContextValue","kind":"json-schema","title":"AddressContextValue","data":{"type":"string","description":"Value of the Address Context.","example":"Production hall 7, Storage field 8."}},"components/schemas/AddressContext":{"id":"components/schemas/AddressContext","kind":"json-schema","title":"AddressContext","data":{"type":"object","description":"The address context provides us with some additional information about the usage or specific recipient information of the addresses. It may hold multiple information organized as \"tags\".","properties":{"value":{"$ref":"#/components/schemas/AddressContextValue"}}}},"components/schemas/PostCodeValue":{"id":"components/schemas/PostCodeValue","kind":"json-schema","title":"PostCodeValue","data":{"type":"string","description":"Effective post code.","example":"9000"}},"components/schemas/PostCodeTypeName":{"id":"components/schemas/PostCodeTypeName","kind":"json-schema","title":"PostCodeTypeName","data":{"type":"string","description":"Display label for the Post Code Type.","example":"Regular"}},"components/schemas/PostCodeTypeUrl":{"id":"components/schemas/PostCodeTypeUrl","kind":"json-schema","title":"PostCodeTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the administrative area.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/PostCodeTypeTechnicalKey":{"id":"components/schemas/PostCodeTypeTechnicalKey","kind":"json-schema","title":"PostCodeTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Post Code.","example":"REGULAR"}},"components/schemas/schemas-PostCodeType":{"id":"components/schemas/schemas-PostCodeType","kind":"json-schema","title":"schemas-PostCodeType","data":{"type":"object","description":"Type of the Post Code.","properties":{"name":{"$ref":"#/components/schemas/PostCodeTypeName"},"url":{"$ref":"#/components/schemas/PostCodeTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PostCodeTypeTechnicalKey"}}}},"components/schemas/schemas-PostCode":{"id":"components/schemas/schemas-PostCode","kind":"json-schema","title":"schemas-PostCode","data":{"type":"object","description":"A country specific code for a certain address component or an combination of address components, e.g. locality.","example":"9000","properties":{"value":{"$ref":"#/components/schemas/PostCodeValue"},"type":{"$ref":"#/components/schemas/schemas-PostCodeType"}}}},"components/schemas/LocalityTypeName":{"id":"components/schemas/LocalityTypeName","kind":"json-schema","title":"LocalityTypeName","data":{"type":"string","description":"Display label for the Locality Type.","example":"City"}},"components/schemas/LocalityTypeUrl":{"id":"components/schemas/LocalityTypeUrl","kind":"json-schema","title":"LocalityTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the locality type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/LocalityTypeTechnicalKey":{"id":"components/schemas/LocalityTypeTechnicalKey","kind":"json-schema","title":"LocalityTypeTechnicalKey","data":{"type":"string","description":"Technical Key of the Locality Type.","example":"CITY"}},"components/schemas/schemas-LocalityType":{"id":"components/schemas/schemas-LocalityType","kind":"json-schema","title":"schemas-LocalityType","data":{"type":"object","description":"Type of the locality.","properties":{"name":{"$ref":"#/components/schemas/LocalityTypeName"},"url":{"$ref":"#/components/schemas/LocalityTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/LocalityTypeTechnicalKey"}}}},"components/schemas/LocalityShortName":{"id":"components/schemas/LocalityShortName","kind":"json-schema","title":"LocalityShortName","data":{"type":"string","description":"Abbreviation of the locality.","example":"St. Gallen"}},"components/schemas/LocalityValue":{"id":"components/schemas/LocalityValue","kind":"json-schema","title":"LocalityValue","data":{"type":"string","description":"Name of the locality.","example":"Sankt Gallen"}},"components/schemas/schemas-Locality":{"id":"components/schemas/schemas-Locality","kind":"json-schema","title":"schemas-Locality","data":{"type":"object","description":"A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses. Many localities exist in an administrative area. A locality can also have several levels of sub localities.","properties":{"type":{"$ref":"#/components/schemas/schemas-LocalityType"},"shortName":{"$ref":"#/components/schemas/LocalityShortName"},"value":{"$ref":"#/components/schemas/LocalityValue"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/ThoroughfareTypeName":{"id":"components/schemas/ThoroughfareTypeName","kind":"json-schema","title":"ThoroughfareTypeName","data":{"type":"string","description":"Display label for the Thoroughfare Type Name.","example":"Industrial zone"}},"components/schemas/ThoroughfareTypeUrl":{"id":"components/schemas/ThoroughfareTypeUrl","kind":"json-schema","title":"ThoroughfareTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the thoroughfare type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/ThoroughfareTypeTechnicalKey":{"id":"components/schemas/ThoroughfareTypeTechnicalKey","kind":"json-schema","title":"ThoroughfareTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Thoroughfare Type.","example":"INDUSTRIAL_ZONE"}},"components/schemas/schemas-ThoroughfareType":{"id":"components/schemas/schemas-ThoroughfareType","kind":"json-schema","title":"schemas-ThoroughfareType","data":{"type":"object","description":"Type of the thoroughfare.","properties":{"name":{"$ref":"#/components/schemas/ThoroughfareTypeName"},"url":{"$ref":"#/components/schemas/ThoroughfareTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/ThoroughfareTypeTechnicalKey"}}}},"components/schemas/ThoroughfareShortName":{"id":"components/schemas/ThoroughfareShortName","kind":"json-schema","title":"ThoroughfareShortName","data":{"type":"string","description":"Abbreviation of the thoroughfare.","example":"Lukasstr. 4"}},"components/schemas/ThoroughfareNumber":{"id":"components/schemas/ThoroughfareNumber","kind":"json-schema","title":"ThoroughfareNumber","data":{"type":"string","description":"Number of the thoroughfare.","example":"4"}},"components/schemas/ThoroughfareValue":{"id":"components/schemas/ThoroughfareValue","kind":"json-schema","title":"ThoroughfareValue","data":{"type":"string","description":"Comprehensive designation of the thoroughfare including the thoroughfare type such as Street, or Rue.","example":"Lukasstraße 4"}},"components/schemas/ThoroughfareName":{"id":"components/schemas/ThoroughfareName","kind":"json-schema","title":"ThoroughfareName","data":{"type":"string","description":"Pure name of the thoroughfare not comprising the thoroughfare type such as Street, or Rue.","example":"Lukasstraße"}},"components/schemas/ThoroughfareDirection":{"id":"components/schemas/ThoroughfareDirection","kind":"json-schema","title":"ThoroughfareDirection","data":{"type":"string","description":"Direction of the thoroughfare.","example":"221-bis Baker Street, North"}},"components/schemas/schemas-Thoroughfare":{"id":"components/schemas/schemas-Thoroughfare","kind":"json-schema","title":"schemas-Thoroughfare","data":{"type":"object","description":"Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue, etc. This also includes canals or banks on which houses or boat houses are located where people live.","properties":{"type":{"$ref":"#/components/schemas/schemas-ThoroughfareType"},"shortName":{"$ref":"#/components/schemas/ThoroughfareShortName"},"number":{"$ref":"#/components/schemas/ThoroughfareNumber"},"value":{"$ref":"#/components/schemas/ThoroughfareValue"},"name":{"$ref":"#/components/schemas/ThoroughfareName"},"direction":{"$ref":"#/components/schemas/ThoroughfareDirection"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/PremiseValue":{"id":"components/schemas/PremiseValue","kind":"json-schema","title":"PremiseValue","data":{"type":"string","description":"The actual value of a Premise in the language of the address.","example":"Lukasstraße 4"}},"components/schemas/PremiseShortName":{"id":"components/schemas/PremiseShortName","kind":"json-schema","title":"PremiseShortName","data":{"type":"string","description":"Abbreviation of the Premise.","example":"Lukasstr. 4"}},"components/schemas/PremiseNumber":{"id":"components/schemas/PremiseNumber","kind":"json-schema","title":"PremiseNumber","data":{"type":"string","description":"Number of the Premise.","example":"4"}},"components/schemas/PremiseTypeName":{"id":"components/schemas/PremiseTypeName","kind":"json-schema","title":"PremiseTypeName","data":{"type":"string","description":"Display label for the Premise Type.","example":"Factory"}},"components/schemas/PremiseTypeUrl":{"id":"components/schemas/PremiseTypeUrl","kind":"json-schema","title":"PremiseTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the premise type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/PremiseTypeTechnicalKey":{"id":"components/schemas/PremiseTypeTechnicalKey","kind":"json-schema","title":"PremiseTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Premise Type.","example":"FACTORY"}},"components/schemas/schemas-PremiseType":{"id":"components/schemas/schemas-PremiseType","kind":"json-schema","title":"schemas-PremiseType","data":{"type":"object","description":"Type of the Premise.","properties":{"name":{"$ref":"#/components/schemas/PremiseTypeName"},"url":{"$ref":"#/components/schemas/PremiseTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PremiseTypeTechnicalKey"}}}},"components/schemas/schemas-Premise":{"id":"components/schemas/schemas-Premise","kind":"json-schema","title":"schemas-Premise","data":{"type":"object","description":"A premise is a tract of land including its buildings. A premise may have several sub-levels to precisely identify.","properties":{"value":{"$ref":"#/components/schemas/PremiseValue"},"shortName":{"$ref":"#/components/schemas/PremiseShortName"},"number":{"$ref":"#/components/schemas/PremiseNumber"},"type":{"$ref":"#/components/schemas/schemas-PremiseType"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/PostalDeliveryPointTypeName":{"id":"components/schemas/PostalDeliveryPointTypeName","kind":"json-schema","title":"PostalDeliveryPointTypeName","data":{"type":"string","description":"Display label for the Postal Delivery Point Type.","example":"Mailbox"}},"components/schemas/PostalDeliveryPointTypeUrl":{"id":"components/schemas/PostalDeliveryPointTypeUrl","kind":"json-schema","title":"PostalDeliveryPointTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the postal delivery point.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/PostalDeliveryPointTypeTechnicalKey":{"id":"components/schemas/PostalDeliveryPointTypeTechnicalKey","kind":"json-schema","title":"PostalDeliveryPointTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Postal Delivery Point.","example":"MAILBOX"}},"components/schemas/schemas-PostalDeliveryPointType":{"id":"components/schemas/schemas-PostalDeliveryPointType","kind":"json-schema","title":"schemas-PostalDeliveryPointType","data":{"type":"object","description":"A single mailbox or other place at which postal mail is delivered.","properties":{"name":{"$ref":"#/components/schemas/PostalDeliveryPointTypeName"},"url":{"$ref":"#/components/schemas/PostalDeliveryPointTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PostalDeliveryPointTypeTechnicalKey"}}}},"components/schemas/PostalDeliveryPointShortName":{"id":"components/schemas/PostalDeliveryPointShortName","kind":"json-schema","title":"PostalDeliveryPointShortName","data":{"type":"string","description":"Stort name of the postal delivery point.","example":"St Gallen, Postfach 460"}},"components/schemas/PostalDeliveryPointNumber":{"id":"components/schemas/PostalDeliveryPointNumber","kind":"json-schema","title":"PostalDeliveryPointNumber","data":{"type":"string","description":"Number of the postal delivery point.","example":"460"}},"components/schemas/PostalDeliveryPointValue":{"id":"components/schemas/PostalDeliveryPointValue","kind":"json-schema","title":"PostalDeliveryPointValue","data":{"type":"string","description":"Value of the postal delivery point.","example":"Postfach"}},"components/schemas/schemas-PostalDeliveryPoint":{"id":"components/schemas/schemas-PostalDeliveryPoint","kind":"json-schema","title":"schemas-PostalDeliveryPoint","data":{"type":"object","description":"A single mailbox or other place at which postal mail is delivered.","properties":{"type":{"$ref":"#/components/schemas/schemas-PostalDeliveryPointType"},"shortName":{"$ref":"#/components/schemas/PostalDeliveryPointShortName"},"number":{"$ref":"#/components/schemas/PostalDeliveryPointNumber"},"value":{"$ref":"#/components/schemas/PostalDeliveryPointValue"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/OpeningHour":{"id":"components/schemas/OpeningHour","kind":"json-schema","title":"OpeningHour","data":{"type":"object","description":"Time range in which the company is open.","properties":{"openingHour":{"type":"string","description":"Company openning hour.","example":"09:00 AM"},"closingHour":{"type":"string","description":"Company closing hour.","example":"05:00 PM"},"weekday":{"type":"string","description":"A day in the week in which the company is open.","example":"Monday"}}}},"components/schemas/GeographicCoordinatesLatitude":{"id":"components/schemas/GeographicCoordinatesLatitude","kind":"json-schema","title":"GeographicCoordinatesLatitude","data":{"description":"Plain on the earth's surface north or south of the equator.","example":"47.439549","type":"number","format":"double"}},"components/schemas/GeographicCoordinatesLongitude":{"id":"components/schemas/GeographicCoordinatesLongitude","kind":"json-schema","title":"GeographicCoordinatesLongitude","data":{"description":"Plain on the earth's surface east or west of a meridian.","example":"9.395275","type":"number","format":"double"}},"components/schemas/GeographicCoordinates":{"id":"components/schemas/GeographicCoordinates","kind":"json-schema","title":"GeographicCoordinates","data":{"type":"object","description":"Decimal geographic coordinates (WGS 84 - reference coordinate system).","properties":{"latitude":{"$ref":"#/components/schemas/GeographicCoordinatesLatitude"},"longitude":{"$ref":"#/components/schemas/GeographicCoordinatesLongitude"}}}},"components/schemas/AddressTypeName":{"id":"components/schemas/AddressTypeName","kind":"json-schema","title":"AddressTypeName","data":{"type":"string","description":"Display label for the Address Type.","example":"Legal Address"}},"components/schemas/AddressTypeUrl":{"id":"components/schemas/AddressTypeUrl","kind":"json-schema","title":"AddressTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the address type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/AddressTypeTechnicalKey":{"id":"components/schemas/AddressTypeTechnicalKey","kind":"json-schema","title":"AddressTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Address Type.","example":"LEGAL_ADDRESS"}},"components/schemas/AddressType":{"id":"components/schemas/AddressType","kind":"json-schema","title":"AddressType","data":{"type":"object","description":"An address type characterizes an address. The type of an address is a structural statement and provides a truth that is applicable to any user (e.g. a legal address is a fact, or that an address is a PO BOX address), other than address functions that may differ from user to user. Address functions determine the particular business context in which an address is in use.","properties":{"name":{"$ref":"#/components/schemas/AddressTypeName"},"url":{"$ref":"#/components/schemas/AddressTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/AddressTypeTechnicalKey"}}}},"components/schemas/FormattedAddressCountry":{"id":"components/schemas/FormattedAddressCountry","kind":"json-schema","title":"FormattedAddressCountry","data":{"type":"string","description":"Country name.","example":"Switzerland"}},"components/schemas/FormattedAddressAdministrativeArea":{"id":"components/schemas/FormattedAddressAdministrativeArea","kind":"json-schema","title":"FormattedAddressAdministrativeArea","data":{"type":"string","description":"A top-level geographical or political area division in a country.","example":"Sankt Gallen"}},"components/schemas/FormattedAddressRegion":{"id":"components/schemas/FormattedAddressRegion","kind":"json-schema","title":"FormattedAddressRegion","data":{"type":"string","description":"Top level subdivision of a country.","example":"Sankt Gallen"}},"components/schemas/FormattedAddressRegionCode":{"id":"components/schemas/FormattedAddressRegionCode","kind":"json-schema","title":"FormattedAddressRegionCode","data":{"type":"string","description":"A country specific code for a certain address in the region.","example":"9004"}},"components/schemas/FormattedAddressLocality":{"id":"components/schemas/FormattedAddressLocality","kind":"json-schema","title":"FormattedAddressLocality","data":{"type":"string","description":"A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses.","example":"Sankt Gallen"}},"components/schemas/FormattedAddressDistrict":{"id":"components/schemas/FormattedAddressDistrict","kind":"json-schema","title":"FormattedAddressDistrict","data":{"type":"string","description":"Type of administrative division that, in some countries, is managed by local government. Across the world, areas known as \"districts\" vary greatly in size, spanning regions or counties, several municipalities, subdivisions of municipalities, school district, or political district.","example":"City center"}},"components/schemas/FormattedAddressPostalCode":{"id":"components/schemas/FormattedAddressPostalCode","kind":"json-schema","title":"FormattedAddressPostalCode","data":{"type":"string","description":"A country specific code for a certain address.","example":"9000"}},"components/schemas/FormattedAddressThoroughfare":{"id":"components/schemas/FormattedAddressThoroughfare","kind":"json-schema","title":"FormattedAddressThoroughfare","data":{"type":"string","description":"Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue.","example":"Lukassstrasse"}},"components/schemas/FormattedAddressPremise":{"id":"components/schemas/FormattedAddressPremise","kind":"json-schema","title":"FormattedAddressPremise","data":{"type":"string","description":"A premise is a tract of land including its buildings. A premise may have several sub-levels to precisely identify.","example":"Lukasstraße 4, Building 2, Floor 3, Room 4"}},"components/schemas/FormattedAddressInterurbanDeliveryPoint":{"id":"components/schemas/FormattedAddressInterurbanDeliveryPoint","kind":"json-schema","title":"FormattedAddressInterurbanDeliveryPoint","data":{"type":"string","description":"A single mailbox or other place at which postal mail is delivered.","example":"Sankt Gallen, Postfach 460"}},"components/schemas/FormattedAddressMailbox":{"id":"components/schemas/FormattedAddressMailbox","kind":"json-schema","title":"FormattedAddressMailbox","data":{"type":"string","description":"A location at an address where the post is delivered to.","example":"Postfach 460"}},"components/schemas/FormattedAddressPostOfficeBox":{"id":"components/schemas/FormattedAddressPostOfficeBox","kind":"json-schema","title":"FormattedAddressPostOfficeBox","data":{"type":"string","description":"A uniquely addressable lockable box located on the premises of a post office station.","example":"Postfach 460"}},"components/schemas/FormattedAddress":{"id":"components/schemas/FormattedAddress","kind":"json-schema","title":"FormattedAddress","data":{"type":"object","description":"A formatted address is a structured address of VIES data source.","properties":{"country":{"$ref":"#/components/schemas/FormattedAddressCountry"},"administrativeArea":{"$ref":"#/components/schemas/FormattedAddressAdministrativeArea"},"region":{"$ref":"#/components/schemas/FormattedAddressRegion"},"regionCode":{"$ref":"#/components/schemas/FormattedAddressRegionCode"},"locality":{"$ref":"#/components/schemas/FormattedAddressLocality"},"district":{"$ref":"#/components/schemas/FormattedAddressDistrict"},"postalCode":{"$ref":"#/components/schemas/FormattedAddressPostalCode"},"thoroughfare":{"$ref":"#/components/schemas/FormattedAddressThoroughfare"},"premise":{"$ref":"#/components/schemas/FormattedAddressPremise"},"interurbanDeliveryPoint":{"$ref":"#/components/schemas/FormattedAddressInterurbanDeliveryPoint"},"mailbox":{"$ref":"#/components/schemas/FormattedAddressMailbox"},"postOfficeBox":{"$ref":"#/components/schemas/FormattedAddressPostOfficeBox"}}}},"components/schemas/schemas-Address":{"id":"components/schemas/schemas-Address","kind":"json-schema","title":"schemas-Address","data":{"type":"object","description":"An address provides information about the physical location of a business partner. It can be specialized in a certain context(e.g. delivery address or invoice address).","properties":{"version":{"$ref":"#/components/schemas/AddressVersion"},"identifyingName":{"$ref":"#/components/schemas/AddressIdentifyingName"},"externalId":{"$ref":"#/components/schemas/AddressExternalId"},"metadata":{"$ref":"#/components/schemas/AddressMetadata"},"careOf":{"$ref":"#/components/schemas/CareOf"},"contexts":{"type":"array","items":{"$ref":"#/components/schemas/AddressContext"}},"country":{"$ref":"#/components/schemas/schemas-Country"},"administrativeAreas":{"type":"array","items":{"$ref":"#/components/schemas/schemas-AdministrativeArea"}},"postCodes":{"type":"array","items":{"$ref":"#/components/schemas/schemas-PostCode"}},"localities":{"type":"array","items":{"$ref":"#/components/schemas/schemas-Locality"}},"thoroughfares":{"type":"array","items":{"$ref":"#/components/schemas/schemas-Thoroughfare"}},"premises":{"type":"array","items":{"$ref":"#/components/schemas/schemas-Premise"}},"postalDeliveryPoints":{"type":"array","items":{"$ref":"#/components/schemas/schemas-PostalDeliveryPoint"}},"openingHours":{"type":"array","items":{"$ref":"#/components/schemas/OpeningHour"}},"geographicCoordinates":{"$ref":"#/components/schemas/GeographicCoordinates"},"types":{"type":"array","items":{"$ref":"#/components/schemas/AddressType"}},"formattedAddress":{"$ref":"#/components/schemas/FormattedAddress"}}}},"components/schemas/ClassificationValue":{"id":"components/schemas/ClassificationValue","kind":"json-schema","title":"ClassificationValue","data":{"type":"string","description":"A textual description of the Classification.","example":"Manufacture of pesticides and other agrochemical products."}},"components/schemas/ClassificationCode":{"id":"components/schemas/ClassificationCode","kind":"json-schema","title":"ClassificationCode","data":{"type":"string","description":"Code that classifies the business partner.","example":"20.20Z"}},"components/schemas/ClassificationLevel":{"id":"components/schemas/ClassificationLevel","kind":"json-schema","title":"ClassificationLevel","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the hierarchy of classification codes. E.g. whether the industry code is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code."},"children":[]}]}]}],"example":"primary"}},"components/schemas/ClassificationTypeName":{"id":"components/schemas/ClassificationTypeName","kind":"json-schema","title":"ClassificationTypeName","data":{"type":"string","description":"Display label for the Classification Type.","example":"NAF 2003"}},"components/schemas/ClassificationTypeUrl":{"id":"components/schemas/ClassificationTypeUrl","kind":"json-schema","title":"ClassificationTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the classification type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/ClassificationTypeTechnicalKey":{"id":"components/schemas/ClassificationTypeTechnicalKey","kind":"json-schema","title":"ClassificationTypeTechnicalKey","data":{"type":"string","description":"TechnicalKey for the Classification Type.","example":"NAF_2003"}},"components/schemas/ClassificationType":{"id":"components/schemas/ClassificationType","kind":"json-schema","title":"ClassificationType","data":{"type":"object","description":"Type of classification such as NACE, SIC, NAF or other industry classification standards.","properties":{"name":{"$ref":"#/components/schemas/ClassificationTypeName"},"url":{"$ref":"#/components/schemas/ClassificationTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/ClassificationTypeTechnicalKey"}}}},"components/schemas/Classification":{"id":"components/schemas/Classification","kind":"json-schema","title":"Classification","data":{"type":"object","description":"A business industry or activity classification is a system of categorizing businesses and organizations into specific industries or activities based on their primary products or services, functions, or activities. These classifications are often used by governments, trade organizations, and other institutions to collect and analyze data on economic activity and to track trends and changes in various sectors.","properties":{"value":{"$ref":"#/components/schemas/ClassificationValue"},"code":{"$ref":"#/components/schemas/ClassificationCode"},"level":{"$ref":"#/components/schemas/ClassificationLevel"},"type":{"$ref":"#/components/schemas/ClassificationType"}}}},"components/schemas/ContactEmailValue":{"id":"components/schemas/ContactEmailValue","kind":"json-schema","title":"ContactEmailValue","data":{"type":"string","description":"Value of the email address of the Business Partner.","example":"developer-portal@cdq.com"}},"components/schemas/ContactEmail":{"id":"components/schemas/ContactEmail","kind":"json-schema","title":"ContactEmail","data":{"type":"object","description":"Actual email address of the Business Partner.","properties":{"value":{"$ref":"#/components/schemas/ContactEmailValue"}}}},"components/schemas/ProfessionTypeName":{"id":"components/schemas/ProfessionTypeName","kind":"json-schema","title":"ProfessionTypeName","data":{"type":"string","description":"Name of the profession type.","example":"Doctor"}},"components/schemas/ProfessionTypeUrl":{"id":"components/schemas/ProfessionTypeUrl","kind":"json-schema","title":"ProfessionTypeUrl","data":{"type":"string","description":"URL to the documentation of the Profession Type Technical Key.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/ProfessionTypeTechnicalKey":{"id":"components/schemas/ProfessionTypeTechnicalKey","kind":"json-schema","title":"ProfessionTypeTechnicalKey","data":{"type":"string","description":"Technical key of the profession type.","example":"DOCTOR"}},"components/schemas/ProfessionType":{"id":"components/schemas/ProfessionType","kind":"json-schema","title":"ProfessionType","data":{"type":"object","description":"The profession type of the Healthcare Professional.","properties":{"name":{"$ref":"#/components/schemas/ProfessionTypeName"},"url":{"$ref":"#/components/schemas/ProfessionTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/ProfessionTypeTechnicalKey"}}}},"components/schemas/LicenseStatusName":{"id":"components/schemas/LicenseStatusName","kind":"json-schema","title":"LicenseStatusName","data":{"type":"string","description":"Name of the license status.","example":"Granted"}},"components/schemas/LicenseStatusUrl":{"id":"components/schemas/LicenseStatusUrl","kind":"json-schema","title":"LicenseStatusUrl","data":{"type":"string","description":"URL to the documentation of the License Status Technical Key.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/LicenseStatusTechnicalKey":{"id":"components/schemas/LicenseStatusTechnicalKey","kind":"json-schema","title":"LicenseStatusTechnicalKey","data":{"type":"string","description":"Technical key of the license status.","example":"GRANTED"}},"components/schemas/LicenseStatus":{"id":"components/schemas/LicenseStatus","kind":"json-schema","title":"LicenseStatus","data":{"type":"object","description":"The license status of the Healthcare Professional.","properties":{"name":{"$ref":"#/components/schemas/LicenseStatusName"},"url":{"$ref":"#/components/schemas/LicenseStatusUrl"},"technicalKey":{"$ref":"#/components/schemas/LicenseStatusTechnicalKey"}}}},"components/schemas/GeneralLicense":{"id":"components/schemas/GeneralLicense","kind":"json-schema","title":"GeneralLicense","data":{"type":"object","description":"The general license of the Healthcare Professional.","properties":{"professionType":{"$ref":"#/components/schemas/ProfessionType"},"licenseStatus":{"$ref":"#/components/schemas/LicenseStatus"}}}},"components/schemas/PermissionStatusName":{"id":"components/schemas/PermissionStatusName","kind":"json-schema","title":"PermissionStatusName","data":{"type":"string","description":"Name of the permission status.","example":"Granted"}},"components/schemas/PermissionStatusUrl":{"id":"components/schemas/PermissionStatusUrl","kind":"json-schema","title":"PermissionStatusUrl","data":{"type":"string","description":"URL to the documentation of the Permission Status Technical Key.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/PermissionStatusTechnicalKey":{"id":"components/schemas/PermissionStatusTechnicalKey","kind":"json-schema","title":"PermissionStatusTechnicalKey","data":{"type":"string","description":"Technical key of the permission status.","example":"GRANTED"}},"components/schemas/PermissionStatus":{"id":"components/schemas/PermissionStatus","kind":"json-schema","title":"PermissionStatus","data":{"type":"object","description":"The permission status of the operational permission.","properties":{"name":{"$ref":"#/components/schemas/PermissionStatusName"},"url":{"$ref":"#/components/schemas/PermissionStatusUrl"},"technicalKey":{"$ref":"#/components/schemas/PermissionStatusTechnicalKey"}}}},"components/schemas/ActivityStatusName":{"id":"components/schemas/ActivityStatusName","kind":"json-schema","title":"ActivityStatusName","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the activity status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active - The operational permission is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inactive - The operational permission is inactive."},"children":[]}]}]}]}],"example":"Inactive"}},"components/schemas/ActivityStatusUrl":{"id":"components/schemas/ActivityStatusUrl","kind":"json-schema","title":"ActivityStatusUrl","data":{"type":"string","description":"URL to the documentation of the Activity Status Technical Key.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/ActivityStatusTechnicalKey":{"id":"components/schemas/ActivityStatusTechnicalKey","kind":"json-schema","title":"ActivityStatusTechnicalKey","data":{"type":"string","description":"Technical key of the activity status.","example":"INACTIVE"}},"components/schemas/ActivityStatus":{"id":"components/schemas/ActivityStatus","kind":"json-schema","title":"ActivityStatus","data":{"type":"object","description":"The activity status of the operational permission.","properties":{"name":{"$ref":"#/components/schemas/ActivityStatusName"},"url":{"$ref":"#/components/schemas/ActivityStatusUrl"},"technicalKey":{"$ref":"#/components/schemas/ActivityStatusTechnicalKey"}}}},"components/schemas/SelfDispensationStatusName":{"id":"components/schemas/SelfDispensationStatusName","kind":"json-schema","title":"SelfDispensationStatusName","data":{"type":"string","description":"Name of the self-dispensation status.","example":"No"}},"components/schemas/SelfDispensationStatusUrl":{"id":"components/schemas/SelfDispensationStatusUrl","kind":"json-schema","title":"SelfDispensationStatusUrl","data":{"type":"string","description":"URL to the documentation of the Self Dispensation Status Technical Key.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/SelfDispensationStatusTechnicalKey":{"id":"components/schemas/SelfDispensationStatusTechnicalKey","kind":"json-schema","title":"SelfDispensationStatusTechnicalKey","data":{"type":"string","description":"Technical key of the self-dispensation status.","example":"NO"}},"components/schemas/SelfDispensationStatus":{"id":"components/schemas/SelfDispensationStatus","kind":"json-schema","title":"SelfDispensationStatus","data":{"type":"object","description":"The self-dispensation status of the Healthcare Professional.","properties":{"name":{"$ref":"#/components/schemas/SelfDispensationStatusName"},"url":{"$ref":"#/components/schemas/SelfDispensationStatusUrl"},"technicalKey":{"$ref":"#/components/schemas/SelfDispensationStatusTechnicalKey"}}}},"components/schemas/ControlledSubstancePurchasePermissionName":{"id":"components/schemas/ControlledSubstancePurchasePermissionName","kind":"json-schema","title":"ControlledSubstancePurchasePermissionName","data":{"type":"string","description":"Name of the controlled substance purchase permission.","example":"Yes"}},"components/schemas/ControlledSubstancePurchasePermissionUrl":{"id":"components/schemas/ControlledSubstancePurchasePermissionUrl","kind":"json-schema","title":"ControlledSubstancePurchasePermissionUrl","data":{"type":"string","description":"URL to the documentation of the Controlled Substance Purchase Permission Technical Key.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/ControlledSubstancePurchasePermissionTechnicalKey":{"id":"components/schemas/ControlledSubstancePurchasePermissionTechnicalKey","kind":"json-schema","title":"ControlledSubstancePurchasePermissionTechnicalKey","data":{"type":"string","description":"Technical key of the controlled substance purchase permission.","example":"YES"}},"components/schemas/ControlledSubstancePurchasePermission":{"id":"components/schemas/ControlledSubstancePurchasePermission","kind":"json-schema","title":"ControlledSubstancePurchasePermission","data":{"type":"object","description":"The controlled substance purchase permission of the Healthcare Professional.","properties":{"name":{"$ref":"#/components/schemas/ControlledSubstancePurchasePermissionName"},"url":{"$ref":"#/components/schemas/ControlledSubstancePurchasePermissionUrl"},"technicalKey":{"$ref":"#/components/schemas/ControlledSubstancePurchasePermissionTechnicalKey"}}}},"components/schemas/PracticeLocation":{"id":"components/schemas/PracticeLocation","kind":"json-schema","title":"PracticeLocation","data":{"type":"object","description":"The practice location of the Healthcare Professional.","properties":{"practiceName":{"type":"string","description":"The practice location of the Healthcare Professional.","example":"VIVOMED AG"},"selfDispensationStatus":{"$ref":"#/components/schemas/SelfDispensationStatus"},"controlledSubstancePurchasePermission":{"$ref":"#/components/schemas/ControlledSubstancePurchasePermission"}}}},"components/schemas/OperationalPermission":{"id":"components/schemas/OperationalPermission","kind":"json-schema","title":"OperationalPermission","data":{"type":"object","description":"The operational permission of the Healthcare Professional.","properties":{"issuingAuthority":{"type":"string","description":"The issuing authority of the operational permission.","example":"Swiss Medical Association"},"permissionStatus":{"$ref":"#/components/schemas/PermissionStatus"},"activityStatus":{"$ref":"#/components/schemas/ActivityStatus"},"practiceLocations":{"type":"array","description":"Practice locations of the Healthcare Professional.","items":{"$ref":"#/components/schemas/PracticeLocation"}}}}},"components/schemas/HcpProfile":{"id":"components/schemas/HcpProfile","kind":"json-schema","title":"HcpProfile","data":{"type":"object","description":"Healthcare Professional Profile informs about the status, licenses, and location of a natural person who is a member \nof the medical, dental, pharmacy, or nursing professions or any other person who, in the course of his/her professional \nactivities, may prescribe, purchase, supply, recommend or administer a Medicinal Product and whose primary practice, \nprincipal professional address or place of incorporation is in Europe.\n","properties":{"generalLicense":{"$ref":"#/components/schemas/GeneralLicense"},"operationalPermissions":{"type":"array","description":"Operational permissions of the Healthcare Professional.","items":{"$ref":"#/components/schemas/OperationalPermission"}}}}},"components/schemas/MinorityIndicatorValue":{"id":"components/schemas/MinorityIndicatorValue","kind":"json-schema","title":"MinorityIndicatorValue","data":{"type":"string","description":"The actual value of the minority indicator, representing the minority group.","example":"Social enterprise"}},"components/schemas/MinorityIndicator":{"id":"components/schemas/MinorityIndicator","kind":"json-schema","title":"MinorityIndicator","data":{"description":"The minority indicator determines the minority group to which a vendor belongs. Usually, the minority indicator is only relevant in the United States and it is used for reporting purposes only. There is a corresponding SAP field in the vendor master for maintaining the minority indicator.\n\nThis feature is as of today dependent on data provided by a US based company: SupplierGateway.\n","type":"object","properties":{"value":{"$ref":"#/components/schemas/MinorityIndicatorValue"}}}},"components/schemas/PhoneNumberCountryPrefix":{"id":"components/schemas/PhoneNumberCountryPrefix","kind":"json-schema","title":"PhoneNumberCountryPrefix","data":{"type":"string","description":"The country prefix of a phone number.","example":"+41"}},"components/schemas/PhoneNumberNumber":{"id":"components/schemas/PhoneNumberNumber","kind":"json-schema","title":"PhoneNumberNumber","data":{"type":"string","description":"The complete phone number without any country prefixes.","example":"71 571 10 40"}},"components/schemas/PhoneNumberTypeName":{"id":"components/schemas/PhoneNumberTypeName","kind":"json-schema","title":"PhoneNumberTypeName","data":{"type":"string","description":"Display label for a Phone Number Type Name.","example":"FAX"}},"components/schemas/PhoneNumberTypeUrl":{"id":"components/schemas/PhoneNumberTypeUrl","kind":"json-schema","title":"PhoneNumberTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of the phone number type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/PhoneNumberTypeTechnicalKey":{"id":"components/schemas/PhoneNumberTypeTechnicalKey","kind":"json-schema","title":"PhoneNumberTypeTechnicalKey","data":{"type":"string","description":"Technical Keys of the PhoneNumber.","example":"FAX"}},"components/schemas/PhoneNumberType":{"id":"components/schemas/PhoneNumberType","kind":"json-schema","title":"PhoneNumberType","data":{"type":"object","description":"The type of a phone number such as mobile phone or fixed line.","properties":{"name":{"$ref":"#/components/schemas/PhoneNumberTypeName"},"url":{"$ref":"#/components/schemas/PhoneNumberTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/PhoneNumberTypeTechnicalKey"}}}},"components/schemas/PhoneNumberValue":{"id":"components/schemas/PhoneNumberValue","kind":"json-schema","title":"PhoneNumberValue","data":{"type":"string","description":"The actual complete phone number incl. country prefix.","example":"+41 71 571 10 40"}},"components/schemas/PhoneNumber":{"id":"components/schemas/PhoneNumber","kind":"json-schema","title":"PhoneNumber","data":{"type":"object","description":"The main phone number of a business partner, usually some info-line of the headquarter.","properties":{"countryPrefix":{"$ref":"#/components/schemas/PhoneNumberCountryPrefix"},"number":{"$ref":"#/components/schemas/PhoneNumberNumber"},"type":{"$ref":"#/components/schemas/PhoneNumberType"},"value":{"$ref":"#/components/schemas/PhoneNumberValue"}}}},"components/schemas/TagValue":{"id":"components/schemas/TagValue","kind":"json-schema","title":"TagValue","data":{"type":"string","description":"Value of the tag.","example":"Warehouse"}},"components/schemas/TagTypeTechnicalKey":{"id":"components/schemas/TagTypeTechnicalKey","kind":"json-schema","title":"TagTypeTechnicalKey","data":{"type":"string","description":"Technical Key of the Tag.","example":"WAREHOUSE"}},"components/schemas/TagType":{"id":"components/schemas/TagType","kind":"json-schema","title":"TagType","data":{"description":"A type that specifies the nature of the tag.","type":"object","properties":{"technicalKey":{"$ref":"#/components/schemas/TagTypeTechnicalKey"}}}},"components/schemas/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"type":"object","description":"Describing and identifying a resource. Custom information about the resource in form of a tag.","properties":{"value":{"$ref":"#/components/schemas/TagValue"},"type":{"$ref":"#/components/schemas/TagType"}}}},"components/schemas/Tags":{"id":"components/schemas/Tags","kind":"json-schema","title":"Tags","data":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},"components/schemas/VatPayerStatusPublicationDate":{"id":"components/schemas/VatPayerStatusPublicationDate","kind":"json-schema","title":"VatPayerStatusPublicationDate","data":{"type":"string","description":"Date of publication","example":"2026-11-11T03:23:28Z"}},"components/schemas/PayerStatusName":{"id":"components/schemas/PayerStatusName","kind":"json-schema","title":"PayerStatusName","data":{"type":"string","description":"Name of Vat payer status. Available values RELIABLE and UNRELIABLE","example":"RELIABLE"}},"components/schemas/PayerStatusTechnicalKey":{"id":"components/schemas/PayerStatusTechnicalKey","kind":"json-schema","title":"PayerStatusTechnicalKey","data":{"type":"string","description":"Technical key of Vat payer status","example":"RELIABLE"}},"components/schemas/PayerStatus":{"id":"components/schemas/PayerStatus","kind":"json-schema","title":"PayerStatus","data":{"description":"Information about payer status.","type":"object","properties":{"name":{"$ref":"#/components/schemas/PayerStatusName"},"technicalKey":{"$ref":"#/components/schemas/PayerStatusTechnicalKey"}}}},"components/schemas/RegistrationAuthorityId":{"id":"components/schemas/RegistrationAuthorityId","kind":"json-schema","title":"RegistrationAuthorityId","data":{"type":"string","description":"The reference code of the registration authority, taken from the Registration Authorities Code List maintained by GLEIF.","example":"RA000009"}},"components/schemas/RegistrationAuthorityEntityId":{"id":"components/schemas/RegistrationAuthorityEntityId","kind":"json-schema","title":"RegistrationAuthorityEntityId","data":{"type":"string","description":"The identifier of the Entity at the indicated registration authority.","example":"RA000009"}},"components/schemas/OtherRegistrationAuthorityId":{"id":"components/schemas/OtherRegistrationAuthorityId","kind":"json-schema","title":"OtherRegistrationAuthorityId","data":{"type":"string","description":"A legacy / historical reference code of a registration authority.","example":"RA000009"}},"components/schemas/RegistrationAuthority":{"id":"components/schemas/RegistrationAuthority","kind":"json-schema","title":"RegistrationAuthority","data":{"description":"Additional information about registration authority.","type":"object","properties":{"registrationAuthorityId":{"$ref":"#/components/schemas/RegistrationAuthorityId"},"registrationAuthorityEntityId":{"$ref":"#/components/schemas/RegistrationAuthorityEntityId"},"otherRegistrationAuthorityId":{"$ref":"#/components/schemas/OtherRegistrationAuthorityId"}}}},"components/schemas/VatPayerStatus":{"id":"components/schemas/VatPayerStatus","kind":"json-schema","title":"VatPayerStatus","data":{"description":"Information about VAT status including publication date and registration authority.","type":"object","properties":{"publicationDate":{"$ref":"#/components/schemas/VatPayerStatusPublicationDate"},"status":{"$ref":"#/components/schemas/PayerStatus"},"registrationAuthority":{"$ref":"#/components/schemas/RegistrationAuthority"}}}},"components/schemas/WebsiteUrl":{"id":"components/schemas/WebsiteUrl","kind":"json-schema","title":"WebsiteUrl","data":{"type":"string","description":"The actual company website URL.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/WebsiteTypeName":{"id":"components/schemas/WebsiteTypeName","kind":"json-schema","title":"WebsiteTypeName","data":{"type":"string","description":"Display label for a Website Type Name","example":"Corporate Website"}},"components/schemas/WebsiteTypeUrl":{"id":"components/schemas/WebsiteTypeUrl","kind":"json-schema","title":"WebsiteTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes website type name.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/WebsiteTypeTechnicalKey":{"id":"components/schemas/WebsiteTypeTechnicalKey","kind":"json-schema","title":"WebsiteTypeTechnicalKey","data":{"type":"string","description":"Technical Keys of the Website Type Name.","example":"WEBSITE_TYPE_CORPORATE"}},"components/schemas/WebsiteType":{"id":"components/schemas/WebsiteType","kind":"json-schema","title":"WebsiteType","data":{"type":"object","description":"Describes the type of website of a business partner, e.g. corporate website, official LinkedIn profile, etc.","properties":{"name":{"$ref":"#/components/schemas/WebsiteTypeName"},"url":{"$ref":"#/components/schemas/WebsiteTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/WebsiteTypeTechnicalKey"}}}},"components/schemas/Website":{"id":"components/schemas/Website","kind":"json-schema","title":"Website","data":{"type":"object","description":"Webpages related to the business partner, e.g. the main corporate website as also provided by some company registers.","properties":{"url":{"$ref":"#/components/schemas/WebsiteUrl"},"type":{"$ref":"#/components/schemas/WebsiteType"}}}},"components/schemas/PartnerProfile":{"id":"components/schemas/PartnerProfile","kind":"json-schema","title":"PartnerProfile","data":{"description":"A business partner profile contains important information about a company, such as its classification, tags, contact details, or minority indicator.","type":"object","properties":{"classifications":{"type":"array","items":{"$ref":"#/components/schemas/Classification"}},"contactEmails":{"type":"array","items":{"$ref":"#/components/schemas/ContactEmail"}},"hcpProfile":{"$ref":"#/components/schemas/HcpProfile"},"minorityIndicator":{"$ref":"#/components/schemas/MinorityIndicator"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}},"tags":{"$ref":"#/components/schemas/Tags"},"vatPayerStatus":{"$ref":"#/components/schemas/VatPayerStatus"},"websites":{"type":"array","items":{"$ref":"#/components/schemas/Website"}}}}},"components/schemas/FormattedSapRecordName1":{"id":"components/schemas/FormattedSapRecordName1","kind":"json-schema","title":"FormattedSapRecordName1","data":{"type":"string","description":"A name1 filed of a business partner name.","example":"CDQ AG"}},"components/schemas/FormattedSapRecordName2":{"id":"components/schemas/FormattedSapRecordName2","kind":"json-schema","title":"FormattedSapRecordName2","data":{"type":"string","description":"A name2 filed of a business partner name.","example":"CDQ AG"}},"components/schemas/FormattedSapRecordName3":{"id":"components/schemas/FormattedSapRecordName3","kind":"json-schema","title":"FormattedSapRecordName3","data":{"type":"string","description":"A name3 filed of a business partner name.","example":"CDQ AG"}},"components/schemas/FormattedSapRecordName4":{"id":"components/schemas/FormattedSapRecordName4","kind":"json-schema","title":"FormattedSapRecordName4","data":{"type":"string","description":"A name4 filed of a business partner name.","example":"CDQ AG"}},"components/schemas/FormattedSapRecordNameCo":{"id":"components/schemas/FormattedSapRecordNameCo","kind":"json-schema","title":"FormattedSapRecordNameCo","data":{"type":"string","description":"The legal form name of a Legal Form.","example":"Aktiengesellschaft"}},"components/schemas/FormattedSapRecordLegalEntity":{"id":"components/schemas/FormattedSapRecordLegalEntity","kind":"json-schema","title":"FormattedSapRecordLegalEntity","data":{"type":"string","description":"The legal entity of a Legal Form.","example":"Aktiengesellschaft"}},"components/schemas/FormattedSapRecordLegalForm":{"id":"components/schemas/FormattedSapRecordLegalForm","kind":"json-schema","title":"FormattedSapRecordLegalForm","data":{"type":"string","description":"The legal form of a Legal Form.","example":"Aktiengesellschaft"}},"components/schemas/FormattedSapRecordIndSector":{"id":"components/schemas/FormattedSapRecordIndSector","kind":"json-schema","title":"FormattedSapRecordIndSector","data":{"type":"string","description":"A business industry or activity classification is a system of categorizing businesses and organizations into specific industries or activities based on their primary products or services, functions, or activities. These classifications are often used by governments, trade organizations, and other institutions to collect and analyze data on economic activity and to track trends and changes in various sectors.","example":"NAF"}},"components/schemas/FormattedSapRecordIndSectorCode":{"id":"components/schemas/FormattedSapRecordIndSectorCode","kind":"json-schema","title":"FormattedSapRecordIndSectorCode","data":{"type":"string","description":"A code of business industry or activity classification is a system of categorizing businesses and organizations into specific industries or activities based on their primary products or services, functions, or activities. These classifications are often used by governments, trade organizations, and other institutions to collect and analyze data on economic activity and to track trends and changes in various sectors.","example":"NAF"}},"components/schemas/FormattedSapRecordEmailAddress":{"id":"components/schemas/FormattedSapRecordEmailAddress","kind":"json-schema","title":"FormattedSapRecordEmailAddress","data":{"type":"string","description":"Email address of the Business Partner.","example":"bp@gmail.com"}},"components/schemas/FormattedSapRecordNarp":{"id":"components/schemas/FormattedSapRecordNarp","kind":"json-schema","title":"FormattedSapRecordNarp","data":{"type":"string","description":"An individual person, i.e. not an organization. An individual has no identifiers and has no legal form in its name.","example":"Friedrich Nietzsche"}},"components/schemas/FormattedSapRecordStceg":{"id":"components/schemas/FormattedSapRecordStceg","kind":"json-schema","title":"FormattedSapRecordStceg","data":{"type":"string","description":"VAT registration number.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordStcd1":{"id":"components/schemas/FormattedSapRecordStcd1","kind":"json-schema","title":"FormattedSapRecordStcd1","data":{"type":"string","description":"Standard tax number field1.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordStcd2":{"id":"components/schemas/FormattedSapRecordStcd2","kind":"json-schema","title":"FormattedSapRecordStcd2","data":{"type":"string","description":"Standard tax number field2.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordStcd3":{"id":"components/schemas/FormattedSapRecordStcd3","kind":"json-schema","title":"FormattedSapRecordStcd3","data":{"type":"string","description":"Standard tax number field3.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordStcd4":{"id":"components/schemas/FormattedSapRecordStcd4","kind":"json-schema","title":"FormattedSapRecordStcd4","data":{"type":"string","description":"Standard tax number field4.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordStcd5":{"id":"components/schemas/FormattedSapRecordStcd5","kind":"json-schema","title":"FormattedSapRecordStcd5","data":{"type":"string","description":"Standard tax number field5.","example":"CHE-218.608.88"}},"components/schemas/FormattedSapRecordUrl":{"id":"components/schemas/FormattedSapRecordUrl","kind":"json-schema","title":"FormattedSapRecordUrl","data":{"type":"string","description":"Webpages related to the business partner, e.g. the main corporate website as also provided by some company registers.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/FormattedSapRecordTelNumber":{"id":"components/schemas/FormattedSapRecordTelNumber","kind":"json-schema","title":"FormattedSapRecordTelNumber","data":{"type":"string","description":"The main phone number of a business partner, usually some info-line of the headquarter.","example":"+41 71 571 10 40"}},"components/schemas/FormattedSapRecordCountry":{"id":"components/schemas/FormattedSapRecordCountry","kind":"json-schema","title":"FormattedSapRecordCountry","data":{"type":"string","description":"Country name.","example":"Switzerland"}},"components/schemas/FormattedSapRecordCountryCode":{"id":"components/schemas/FormattedSapRecordCountryCode","kind":"json-schema","title":"FormattedSapRecordCountryCode","data":{"type":"string","description":"Country code (ISO 3166-1 alpha-2)","example":"CH"}},"components/schemas/FormattedSapRecordRegion":{"id":"components/schemas/FormattedSapRecordRegion","kind":"json-schema","title":"FormattedSapRecordRegion","data":{"type":"string","description":"A top-level geographical or political area division in a country.","example":"Sankt Gallen"}},"components/schemas/FormattedSapRecordRegionCodeSap":{"id":"components/schemas/FormattedSapRecordRegionCodeSap","kind":"json-schema","title":"FormattedSapRecordRegionCodeSap","data":{"type":"string","description":"A Region specific code for a certain address.","example":"9004"}},"components/schemas/FormattedSapRecordRegionCode":{"id":"components/schemas/FormattedSapRecordRegionCode","kind":"json-schema","title":"FormattedSapRecordRegionCode","data":{"type":"string","description":"A country specific code for a certain address in the region.","example":"9004"}},"components/schemas/FormattedSapRecordRegionFipsCode":{"id":"components/schemas/FormattedSapRecordRegionFipsCode","kind":"json-schema","title":"FormattedSapRecordRegionFipsCode","data":{"type":"string","description":"A country specific fips code for a certain address in the region.","example":"34"}},"components/schemas/FormattedSapRecordCounty":{"id":"components/schemas/FormattedSapRecordCounty","kind":"json-schema","title":"FormattedSapRecordCounty","data":{"type":"string","description":"A sub-level geographical or political area division in a country.","example":"Sankt Gallen"}},"components/schemas/FormattedSapRecordCountyCode":{"id":"components/schemas/FormattedSapRecordCountyCode","kind":"json-schema","title":"FormattedSapRecordCountyCode","data":{"type":"string","description":"A county specific code for a certain address in the region.","example":"9004"}},"components/schemas/FormattedSapRecordCountyFipsCode":{"id":"components/schemas/FormattedSapRecordCountyFipsCode","kind":"json-schema","title":"FormattedSapRecordCountyFipsCode","data":{"type":"string","description":"A county specific fips code for a certain address in the region.","example":"34015"}},"components/schemas/FormattedSapRecordTownship":{"id":"components/schemas/FormattedSapRecordTownship","kind":"json-schema","title":"FormattedSapRecordTownship","data":{"type":"string","description":"A sub-level geographical or political area division in a country.","example":"Sankt Gallen"}},"components/schemas/FormattedSapRecordTownshipCode":{"id":"components/schemas/FormattedSapRecordTownshipCode","kind":"json-schema","title":"FormattedSapRecordTownshipCode","data":{"type":"string","description":"A township specific code for a certain address in the region.","example":"9004"}},"components/schemas/FormattedSapRecordCity":{"id":"components/schemas/FormattedSapRecordCity","kind":"json-schema","title":"FormattedSapRecordCity","data":{"type":"string","description":"A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses. Many localities exist in an administrative area. A locality can also have several levels of sub localities.","example":"Sankt Gallen"}},"components/schemas/FormattedSapRecordDistrict":{"id":"components/schemas/FormattedSapRecordDistrict","kind":"json-schema","title":"FormattedSapRecordDistrict","data":{"type":"string","description":"Area of a country or city.","example":"St. Georgen"}},"components/schemas/FormattedSapRecordPostalCode":{"id":"components/schemas/FormattedSapRecordPostalCode","kind":"json-schema","title":"FormattedSapRecordPostalCode","data":{"type":"string","description":"A country specific code for a certain address.","example":"9000"}},"components/schemas/FormattedSapRecordPostalCode3":{"id":"components/schemas/FormattedSapRecordPostalCode3","kind":"json-schema","title":"FormattedSapRecordPostalCode3","data":{"type":"string","description":"A country specific code for a certain address.","example":"9000"}},"components/schemas/FormattedSapRecordStreet1":{"id":"components/schemas/FormattedSapRecordStreet1","kind":"json-schema","title":"FormattedSapRecordStreet1","data":{"type":"string","description":"Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue, etc. This also includes canals or banks on which houses or boat houses are located where people live.","example":"Lukasstraße 4"}},"components/schemas/FormattedSapRecordStreet2":{"id":"components/schemas/FormattedSapRecordStreet2","kind":"json-schema","title":"FormattedSapRecordStreet2","data":{"type":"string","description":"Additional street filed.","example":"Lukasstraße 4"}},"components/schemas/FormattedSapRecordStreet5":{"id":"components/schemas/FormattedSapRecordStreet5","kind":"json-schema","title":"FormattedSapRecordStreet5","data":{"type":"string","description":"Additional street filed.","example":"Lukasstraße 4"}},"components/schemas/FormattedSapRecordHouseNum":{"id":"components/schemas/FormattedSapRecordHouseNum","kind":"json-schema","title":"FormattedSapRecordHouseNum","data":{"type":"string","description":"Number of the Thoroughfare.","example":"4"}},"components/schemas/FormattedSapRecordHouseNum2":{"id":"components/schemas/FormattedSapRecordHouseNum2","kind":"json-schema","title":"FormattedSapRecordHouseNum2","data":{"type":"string","description":"Additional number filed.","example":"4"}},"components/schemas/FormattedSapRecordBuilding":{"id":"components/schemas/FormattedSapRecordBuilding","kind":"json-schema","title":"FormattedSapRecordBuilding","data":{"type":"string","description":"A structure (such as a house, hospital, school, etc.) with a roof and walls that is used as a place for people to live, work, do activities, store things, etc.","example":"Office 2"}},"components/schemas/FormattedSapRecordFloor":{"id":"components/schemas/FormattedSapRecordFloor","kind":"json-schema","title":"FormattedSapRecordFloor","data":{"type":"string","description":"The floor/story of the building.","example":"2"}},"components/schemas/FormattedSapRecordRoomnumber":{"id":"components/schemas/FormattedSapRecordRoomnumber","kind":"json-schema","title":"FormattedSapRecordRoomnumber","data":{"type":"string","description":"A distinct room in a building.","example":"123"}},"components/schemas/FormattedSapRecordPoBoxCountry":{"id":"components/schemas/FormattedSapRecordPoBoxCountry","kind":"json-schema","title":"FormattedSapRecordPoBoxCountry","data":{"type":"string","description":"A location at an address where the post is delivered to.","example":"9000"}},"components/schemas/FormattedSapRecordPoBoxCity":{"id":"components/schemas/FormattedSapRecordPoBoxCity","kind":"json-schema","title":"FormattedSapRecordPoBoxCity","data":{"type":"string","description":"A location at an address where the post is delivered to.","example":"9000"}},"components/schemas/FormattedSapRecordPoBoxPostalCode":{"id":"components/schemas/FormattedSapRecordPoBoxPostalCode","kind":"json-schema","title":"FormattedSapRecordPoBoxPostalCode","data":{"type":"string","description":"A location at an address where the post is delivered to.","example":"9000"}},"components/schemas/FormattedSapRecordPoBox":{"id":"components/schemas/FormattedSapRecordPoBox","kind":"json-schema","title":"FormattedSapRecordPoBox","data":{"type":"string","description":"Des","example":"9000"}},"components/schemas/FormattedSapRecordLatitude":{"id":"components/schemas/FormattedSapRecordLatitude","kind":"json-schema","title":"FormattedSapRecordLatitude","data":{"type":"string","description":"Plain on the earth's surface north or south of the equator.","example":"47.439549"}},"components/schemas/FormattedSapRecordLongitude":{"id":"components/schemas/FormattedSapRecordLongitude","kind":"json-schema","title":"FormattedSapRecordLongitude","data":{"type":"string","description":"Plain on the earth's surface east or west of a meridian.","example":"9.395275"}},"components/schemas/FormattedSapRecord":{"id":"components/schemas/FormattedSapRecord","kind":"json-schema","title":"FormattedSapRecord","data":{"description":"Provides business partner and address information in a data structure similar to SAP Business Partner table BUT000 and SAP Business Address Services table ADRC. Field names are equal or very similar to SAP field names in order to simplify field mapping. Data for name and street fields is already split into chunks of max. 35 characters.","type":"object","properties":{"name1":{"$ref":"#/components/schemas/FormattedSapRecordName1"},"name2":{"$ref":"#/components/schemas/FormattedSapRecordName2"},"name3":{"$ref":"#/components/schemas/FormattedSapRecordName3"},"name4":{"$ref":"#/components/schemas/FormattedSapRecordName4"},"nameCo":{"$ref":"#/components/schemas/FormattedSapRecordNameCo"},"legalEntity":{"$ref":"#/components/schemas/FormattedSapRecordLegalEntity"},"legalForm":{"$ref":"#/components/schemas/FormattedSapRecordLegalForm"},"indSector":{"$ref":"#/components/schemas/FormattedSapRecordIndSector"},"indSectorCode":{"$ref":"#/components/schemas/FormattedSapRecordIndSectorCode"},"emailAddress":{"$ref":"#/components/schemas/FormattedSapRecordEmailAddress"},"narp":{"$ref":"#/components/schemas/FormattedSapRecordNarp"},"stceg":{"$ref":"#/components/schemas/FormattedSapRecordStceg"},"stcd1":{"$ref":"#/components/schemas/FormattedSapRecordStcd1"},"stcd2":{"$ref":"#/components/schemas/FormattedSapRecordStcd2"},"stcd3":{"$ref":"#/components/schemas/FormattedSapRecordStcd3"},"stcd4":{"$ref":"#/components/schemas/FormattedSapRecordStcd4"},"stcd5":{"$ref":"#/components/schemas/FormattedSapRecordStcd5"},"url":{"$ref":"#/components/schemas/FormattedSapRecordUrl"},"telNumber":{"$ref":"#/components/schemas/FormattedSapRecordTelNumber"},"country":{"$ref":"#/components/schemas/FormattedSapRecordCountry"},"countryCode":{"$ref":"#/components/schemas/FormattedSapRecordCountryCode"},"region":{"$ref":"#/components/schemas/FormattedSapRecordRegion"},"regionCodeSap":{"$ref":"#/components/schemas/FormattedSapRecordRegionCodeSap"},"regionCode":{"$ref":"#/components/schemas/FormattedSapRecordRegionCode"},"regionFipsCode":{"$ref":"#/components/schemas/FormattedSapRecordRegionFipsCode"},"county":{"$ref":"#/components/schemas/FormattedSapRecordCounty"},"countyCode":{"$ref":"#/components/schemas/FormattedSapRecordCountyCode"},"countyFipsCode":{"$ref":"#/components/schemas/FormattedSapRecordCountyFipsCode"},"township":{"$ref":"#/components/schemas/FormattedSapRecordTownship"},"townshipCode":{"$ref":"#/components/schemas/FormattedSapRecordTownshipCode"},"city":{"$ref":"#/components/schemas/FormattedSapRecordCity"},"district":{"$ref":"#/components/schemas/FormattedSapRecordDistrict"},"postalCode":{"$ref":"#/components/schemas/FormattedSapRecordPostalCode"},"postalCode3":{"$ref":"#/components/schemas/FormattedSapRecordPostalCode3"},"street1":{"$ref":"#/components/schemas/FormattedSapRecordStreet1"},"street2":{"$ref":"#/components/schemas/FormattedSapRecordStreet2"},"street5":{"$ref":"#/components/schemas/FormattedSapRecordStreet5"},"houseNum":{"$ref":"#/components/schemas/FormattedSapRecordHouseNum"},"houseNum2":{"$ref":"#/components/schemas/FormattedSapRecordHouseNum2"},"building":{"$ref":"#/components/schemas/FormattedSapRecordBuilding"},"floor":{"$ref":"#/components/schemas/FormattedSapRecordFloor"},"roomnumber":{"$ref":"#/components/schemas/FormattedSapRecordRoomnumber"},"poBoxCountry":{"$ref":"#/components/schemas/FormattedSapRecordPoBoxCountry"},"poBoxCity":{"$ref":"#/components/schemas/FormattedSapRecordPoBoxCity"},"poBoxPostalCode":{"$ref":"#/components/schemas/FormattedSapRecordPoBoxPostalCode"},"poBox":{"$ref":"#/components/schemas/FormattedSapRecordPoBox"},"latitude":{"$ref":"#/components/schemas/FormattedSapRecordLatitude"},"longitude":{"$ref":"#/components/schemas/FormattedSapRecordLongitude"}}}},"components/schemas/BusinessPartnerRelationStartedAt":{"id":"components/schemas/BusinessPartnerRelationStartedAt","kind":"json-schema","title":"BusinessPartnerRelationStartedAt","data":{"type":"string","description":"Describe when this relationship was first established.","example":"2026-11-11T03:23:28Z"}},"components/schemas/BusinessPartnerRelationEndedAt":{"id":"components/schemas/BusinessPartnerRelationEndedAt","kind":"json-schema","title":"BusinessPartnerRelationEndedAt","data":{"type":"string","description":"Describe when this relationship ended.","example":"2026-11-11T03:23:28Z"}},"components/schemas/BusinessPartnerRelationTypeName":{"id":"components/schemas/BusinessPartnerRelationTypeName","kind":"json-schema","title":"BusinessPartnerRelationTypeName","data":{"type":"string","description":"Display name of the Business Partner Relation Type.","example":"Commercial ultimate"}},"components/schemas/BusinessPartnerRelationTypeUrl":{"id":"components/schemas/BusinessPartnerRelationTypeUrl","kind":"json-schema","title":"BusinessPartnerRelationTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of a business partner relation type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/BusinessPartnerRelationTypeTechnicalKey":{"id":"components/schemas/BusinessPartnerRelationTypeTechnicalKey","kind":"json-schema","title":"BusinessPartnerRelationTypeTechnicalKey","data":{"type":"string","description":"Technical Key of the Business Partner Relation Type.","example":"COMMERCIAL_ULTIMATE"}},"components/schemas/BusinessPartnerRelationType":{"id":"components/schemas/BusinessPartnerRelationType","kind":"json-schema","title":"BusinessPartnerRelationType","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides information about the type of the relationship between two Business Partners like:\\ direct parent/child, ultimate parent, branch."},"children":[]}]}]}],"properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerRelationTypeName"},"url":{"$ref":"#/components/schemas/BusinessPartnerRelationTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerRelationTypeTechnicalKey"}}}},"components/schemas/BusinessPartnerRelationClassName":{"id":"components/schemas/BusinessPartnerRelationClassName","kind":"json-schema","title":"BusinessPartnerRelationClassName","data":{"type":"string","description":"Display name of the Business Partner Relation Class.","example":"CDQ Hierarchy"}},"components/schemas/BusinessPartnerRelationClassUrl":{"id":"components/schemas/BusinessPartnerRelationClassUrl","kind":"json-schema","title":"BusinessPartnerRelationClassUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of a business partner relation class.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/BusinessPartnerRelationClassTechnicalKey":{"id":"components/schemas/BusinessPartnerRelationClassTechnicalKey","kind":"json-schema","title":"BusinessPartnerRelationClassTechnicalKey","data":{"type":"string","description":"Technical Key of the Business Partner Relation Class.","example":"BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"}},"components/schemas/BusinessPartnerRelationClass":{"id":"components/schemas/BusinessPartnerRelationClass","kind":"json-schema","title":"BusinessPartnerRelationClass","data":{"type":"object","description":"Provides information about the classification of the relation.","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerRelationClassName"},"url":{"$ref":"#/components/schemas/BusinessPartnerRelationClassUrl"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerRelationClassTechnicalKey"}}}},"components/schemas/BusinessPartnerRelationStartNode":{"id":"components/schemas/BusinessPartnerRelationStartNode","kind":"json-schema","title":"BusinessPartnerRelationStartNode","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's a number of the business partner that plays a superior role over the other business partner. In means that, the company is parent of the second company (child) and has one of the relationship type like:\\ Domestic Ultimate Legal entity or Direct Legal entity."},"children":[]}]}]}],"example":"FR.RC:5664645"}},"components/schemas/BusinessPartnerRelationEndNode":{"id":"components/schemas/BusinessPartnerRelationEndNode","kind":"json-schema","title":"BusinessPartnerRelationEndNode","data":{"type":"string","description":"It's a number of the business partner that plays a subordinate role over the other business partner. In means that, the company is chile of the second company (parent) and has one of the special relationship types.","example":"FR.RC:5664645"}},"components/schemas/BusinessPartnerRelation":{"id":"components/schemas/BusinessPartnerRelation","kind":"json-schema","title":"BusinessPartnerRelation","data":{"type":"object","description":"Business Partner hierarchy, or any other kind of relation between two Business Partner entities. The data about relationships between companies come from official, external data sources.","properties":{"startedAt":{"$ref":"#/components/schemas/BusinessPartnerRelationStartedAt"},"endedAt":{"$ref":"#/components/schemas/BusinessPartnerRelationEndedAt"},"type":{"$ref":"#/components/schemas/BusinessPartnerRelationType"},"class":{"$ref":"#/components/schemas/BusinessPartnerRelationClass"},"startNode":{"$ref":"#/components/schemas/BusinessPartnerRelationStartNode"},"endNode":{"$ref":"#/components/schemas/BusinessPartnerRelationEndNode"}}}},"components/schemas/InternationalBankAccountIdentifier":{"id":"components/schemas/InternationalBankAccountIdentifier","kind":"json-schema","title":"InternationalBankAccountIdentifier","data":{"type":"string","description":"The IBAN of a bank account.","example":"CH8800781619278412000"}},"components/schemas/InternationalBankIdentifier":{"id":"components/schemas/InternationalBankIdentifier","kind":"json-schema","title":"InternationalBankIdentifier","data":{"type":"string","description":"(BIC/SWIFT) Bank identifier which is globally unique.","example":"KBSGCH22XXX"}},"components/schemas/NationalBankAccountIdentifier":{"id":"components/schemas/NationalBankAccountIdentifier","kind":"json-schema","title":"NationalBankAccountIdentifier","data":{"type":"string","description":"Identifier of a bank account in a national context, i.e. for a country.","example":"619278412000"}},"components/schemas/NationalBankIdentifier":{"id":"components/schemas/NationalBankIdentifier","kind":"json-schema","title":"NationalBankIdentifier","data":{"type":"string","description":"Bank identifier which is unique in a national context, i.e. for a country.","example":"00781"}},"components/schemas/BankName":{"id":"components/schemas/BankName","kind":"json-schema","title":"BankName","data":{"description":"The name of a bank.","type":"string","example":"Sparda Bank"}},"components/schemas/BankBranch":{"id":"components/schemas/BankBranch","kind":"json-schema","title":"BankBranch","data":{"description":"The branch of a bank.","type":"string","example":"Filiale München"}},"components/schemas/BankAddress":{"id":"components/schemas/BankAddress","kind":"json-schema","title":"BankAddress","data":{"type":"object","description":"The address where a bank resides.","properties":{"localities":{"type":"array","items":{"$ref":"#/components/schemas/schemas-Locality"}},"country":{"$ref":"#/components/schemas/schemas-Country"},"administrativeAreas":{"type":"array","items":{"$ref":"#/components/schemas/schemas-AdministrativeArea"}},"postCodes":{"type":"array","items":{"$ref":"#/components/schemas/schemas-PostCode"}},"thoroughfares":{"type":"array","items":{"$ref":"#/components/schemas/schemas-Thoroughfare"}}}}},"components/schemas/Bank":{"id":"components/schemas/Bank","kind":"json-schema","title":"Bank","data":{"type":"object","description":"Financial institution that accepts deposits, facilitates withdrawals and transfers, and provides various financial services such as loans, investments, and currency exchange.","properties":{"name":{"$ref":"#/components/schemas/BankName"},"branch":{"$ref":"#/components/schemas/BankBranch"},"address":{"$ref":"#/components/schemas/BankAddress"}}}},"components/schemas/BankAccount":{"id":"components/schemas/BankAccount","kind":"json-schema","title":"BankAccount","data":{"type":"object","description":"A bank account record holds information that universally describes a registered bank account.","properties":{"internationalBankAccountIdentifier":{"$ref":"#/components/schemas/InternationalBankAccountIdentifier"},"internationalBankIdentifier":{"$ref":"#/components/schemas/InternationalBankIdentifier"},"nationalBankAccountIdentifier":{"$ref":"#/components/schemas/NationalBankAccountIdentifier"},"nationalBankIdentifier":{"$ref":"#/components/schemas/NationalBankIdentifier"},"bank":{"$ref":"#/components/schemas/Bank"}}}},"components/schemas/BusinessPartnerTypeName":{"id":"components/schemas/BusinessPartnerTypeName","kind":"json-schema","title":"BusinessPartnerTypeName","data":{"type":"string","description":"Display name of the Business Partner Type Name.","example":"Legal Entity"}},"components/schemas/BusinessPartnerTypeUrl":{"id":"components/schemas/BusinessPartnerTypeUrl","kind":"json-schema","title":"BusinessPartnerTypeUrl","data":{"type":"string","description":"URL to the documentation which summarizes all details of a business partner type.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/BusinessPartnerTypeTechnicalKey":{"id":"components/schemas/BusinessPartnerTypeTechnicalKey","kind":"json-schema","title":"BusinessPartnerTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Business Partner Type.","example":"LEGAL_ENTITY"}},"components/schemas/BusinessPartnerType":{"id":"components/schemas/BusinessPartnerType","kind":"json-schema","title":"BusinessPartnerType","data":{"type":"object","description":"A distinct type a business partner is assigned to. It determines the business context a business partner is involved in. In the Corporate Data League, most business partners are legal entities.","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerTypeName"},"url":{"$ref":"#/components/schemas/BusinessPartnerTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerTypeTechnicalKey"}}}},"components/schemas/BusinessPartnerStorageDataSourceName":{"id":"components/schemas/BusinessPartnerStorageDataSourceName","kind":"json-schema","title":"BusinessPartnerStorageDataSourceName","data":{"type":"string","description":"Name of a data source of a storage.","example":"Internal customers"}},"components/schemas/DataMatchingDefinitionId":{"id":"components/schemas/DataMatchingDefinitionId","kind":"json-schema","title":"DataMatchingDefinitionId","data":{"type":"string","description":"Id of the data matching definition.","example":"6461e6113b1865304b3038b6"}},"components/schemas/HttpStatus":{"id":"components/schemas/HttpStatus","kind":"json-schema","title":"HttpStatus","data":{"type":"integer","description":"RFC 7231 status code for this error.","example":"400","deprecated":true}},"components/schemas/HttpPath":{"id":"components/schemas/HttpPath","kind":"json-schema","title":"HttpPath","data":{"type":"string","description":"Requested path which caused this error.","example":"/v2/businesspartners/lookup"}},"components/schemas/ApiErrorTimestamp":{"id":"components/schemas/ApiErrorTimestamp","kind":"json-schema","title":"ApiErrorTimestamp","data":{"type":"string","deprecated":true,"description":"ISO 8601 representation of the timestamp.","example":"2026-11-11T03:23:28Z"}},"components/schemas/HttpError":{"id":"components/schemas/HttpError","kind":"json-schema","title":"HttpError","data":{"type":"string","description":"RFC 7231 error which belongs to the status code.","example":"BAD_REQUEST","deprecated":true}},"components/schemas/ApiErrorMessage":{"id":"components/schemas/ApiErrorMessage","kind":"json-schema","title":"ApiErrorMessage","data":{"type":"string","deprecated":true,"description":"Details about the error.","example":"This user is not allowed to access this service."}},"components/schemas/BusinessPartnerStorageId":{"id":"components/schemas/BusinessPartnerStorageId","kind":"json-schema","title":"BusinessPartnerStorageId","data":{"type":"string","description":"Unique identifier of the Storage.","example":"72d6900fce6b326088f5d9d91049e3e6"}},"components/schemas/BusinessPartnerStorageDataSourceId":{"id":"components/schemas/BusinessPartnerStorageDataSourceId","kind":"json-schema","title":"BusinessPartnerStorageDataSourceId","data":{"type":"string","description":"Unique identifier for a Data Source of the Storage.","example":"648824a691d8d2503d65103e"}},"components/schemas/BuildToggle":{"id":"components/schemas/BuildToggle","kind":"json-schema","title":"BuildToggle","data":{"type":"boolean","description":"Enable to generate this report.","example":"false","default":false}},"components/schemas/DuplicateMatchingIncludeSingles":{"id":"components/schemas/DuplicateMatchingIncludeSingles","kind":"json-schema","title":"DuplicateMatchingIncludeSingles","data":{"type":"boolean","description":"Enables singles (non duplicated records) for the duplicate matching report.","example":"false","default":false}},"components/schemas/DuplicateMatchingReportConfiguration":{"id":"components/schemas/DuplicateMatchingReportConfiguration","kind":"json-schema","title":"DuplicateMatchingReportConfiguration","data":{"type":"object","description":"Generates a data matching report that doesn't include artificial golden records on top of each matching group. Optionally IncludeSingles feature can be set to true.","properties":{"build":{"$ref":"#/components/schemas/BuildToggle"},"includeSingles":{"$ref":"#/components/schemas/DuplicateMatchingIncludeSingles"}}}},"components/schemas/DuplicateConsolidationIncludeSingles":{"id":"components/schemas/DuplicateConsolidationIncludeSingles","kind":"json-schema","title":"DuplicateConsolidationIncludeSingles","data":{"type":"boolean","description":"Enables singles (non duplicated records) for the duplicate consolidation report.","example":"false","default":false}},"components/schemas/DuplicateConsolidationReportConfiguration":{"id":"components/schemas/DuplicateConsolidationReportConfiguration","kind":"json-schema","title":"DuplicateConsolidationReportConfiguration","data":{"type":"object","description":"Generates a data matching report that includes artificial golden records on top of each matching group. Optionally IncludeSingles feature can be set to true.","properties":{"build":{"$ref":"#/components/schemas/BuildToggle"},"includeSingles":{"$ref":"#/components/schemas/DuplicateConsolidationIncludeSingles"}}}},"components/schemas/JobId":{"id":"components/schemas/JobId","kind":"json-schema","title":"JobId","data":{"type":"string","description":"Unique identifier of a job.","example":"35f23c03-1c22-45fe-9484-3ffe769325de"}},"components/schemas/CreatedAt":{"id":"components/schemas/CreatedAt","kind":"json-schema","title":"CreatedAt","data":{"type":"string","description":"Date of creation (ISO 8601-compliant).","example":"2026-11-11T03:23:28Z"}},"components/schemas/CreatedBy":{"id":"components/schemas/CreatedBy","kind":"json-schema","title":"CreatedBy","data":{"type":"string","description":"Creator of a resource.","example":"76248934691294444"}},"components/schemas/JobProgress":{"id":"components/schemas/JobProgress","kind":"json-schema","title":"JobProgress","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Progress (%) of the job."},"children":[]}]}]}],"example":"77","maximum":100,"minimum":0}},"components/schemas/StartAfter":{"id":"components/schemas/StartAfter","kind":"json-schema","title":"StartAfter","data":{"type":"string","description":"The ID which is used to read the page.","example":"5712566172571652"}},"components/schemas/ModifiedAt":{"id":"components/schemas/ModifiedAt","kind":"json-schema","title":"ModifiedAt","data":{"type":"string","description":"Date of modification (ISO 8601-compliant).","example":"2026-11-11T03:23:28Z"}},"components/schemas/OrganizationId":{"id":"components/schemas/OrganizationId","kind":"json-schema","title":"OrganizationId","data":{"type":"string","description":"Uniquely identifying ID of the organization.","example":"cdq_monitor"}},"components/schemas/WorkspaceId":{"id":"components/schemas/WorkspaceId","kind":"json-schema","title":"WorkspaceId","data":{"type":"string","description":"Uniquely identifying ID of the workspace.","example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"}},"components/schemas/NextStartAfter":{"id":"components/schemas/NextStartAfter","kind":"json-schema","title":"NextStartAfter","data":{"type":"string","description":"Provides a value to be used as a startAfter in next page request.","example":"5712566172571652"}},"components/schemas/LinkageIncludeSingles":{"id":"components/schemas/LinkageIncludeSingles","kind":"json-schema","title":"LinkageIncludeSingles","data":{"type":"boolean","description":"Enables singles (non linked records) for the linkage report.","example":"false","default":false}},"components/schemas/LinkageReportConfiguration":{"id":"components/schemas/LinkageReportConfiguration","kind":"json-schema","title":"LinkageReportConfiguration","data":{"type":"object","description":"Generates a linkage report. Optionally IncludeSingles feature can be set to true.","properties":{"build":{"$ref":"#/components/schemas/BuildToggle"},"includeSingles":{"$ref":"#/components/schemas/LinkageIncludeSingles"}}}},"components/schemas/MatchingReportsConfiguration":{"id":"components/schemas/MatchingReportsConfiguration","kind":"json-schema","title":"MatchingReportsConfiguration","data":{"type":"object","description":"Configuration for generating matching reports.","properties":{"duplicateMatching":{"$ref":"#/components/schemas/DuplicateMatchingReportConfiguration"},"duplicateConsolidation":{"$ref":"#/components/schemas/DuplicateConsolidationReportConfiguration"},"linkage":{"$ref":"#/components/schemas/LinkageReportConfiguration"}}}},"components/schemas/schemas-JobStatus":{"id":"components/schemas/schemas-JobStatus","kind":"json-schema","title":"schemas-JobStatus","data":{"type":"string","description":"Job execution status.","example":"RUNNING"}},"components/schemas/JobStatusMessage":{"id":"components/schemas/JobStatusMessage","kind":"json-schema","title":"JobStatusMessage","data":{"type":"string","description":"Additional information to explain the status.","example":"The job failed because storage is empty."}},"components/schemas/UserId":{"id":"components/schemas/UserId","kind":"json-schema","title":"UserId","data":{"type":"string","description":"Unique ID of a user.","example":"johndoe"}},"components/schemas/Page":{"id":"components/schemas/Page","kind":"json-schema","title":"Page","data":{"type":"integer","description":"Current page number.","example":"1","default":0,"minimum":0}},"components/schemas/PageSize":{"id":"components/schemas/PageSize","kind":"json-schema","title":"PageSize","data":{"type":"integer","description":"Number of items per page.","example":"100","default":10,"minimum":1,"maximum":1000}},"components/schemas/PageTotal":{"id":"components/schemas/PageTotal","kind":"json-schema","title":"PageTotal","data":{"description":"Total number of items which can be paged.","example":"67","type":"integer"}},"components/schemas/Limit":{"id":"components/schemas/Limit","kind":"json-schema","title":"Limit","data":{"type":"integer","description":"Number of items per page.","example":"100"}},"components/schemas/ConfigurationId":{"id":"components/schemas/ConfigurationId","kind":"json-schema","title":"ConfigurationId","data":{"type":"string","description":"Uniquely identifies a configuration.","example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"}},"components/schemas/ConfigurationName":{"id":"components/schemas/ConfigurationName","kind":"json-schema","title":"ConfigurationName","data":{"type":"string","description":"Display name for a configuration.","example":"Client configuration."}},"components/schemas/HttpStatusCode":{"id":"components/schemas/HttpStatusCode","kind":"json-schema","title":"HttpStatusCode","data":{"type":"integer","description":"RFC 7231 status code for this error.","example":"200"}},"components/schemas/HttpStatusTechnicalKey":{"id":"components/schemas/HttpStatusTechnicalKey","kind":"json-schema","title":"HttpStatusTechnicalKey","data":{"type":"string","description":"Technical key describing the status or error","example":"OK"}},"components/schemas/StatusDetailsMessageId":{"id":"components/schemas/StatusDetailsMessageId","kind":"json-schema","title":"StatusDetailsMessageId","data":{"type":"integer","description":"9-digit code which is uniquely identifying a message","example":200000004}},"components/schemas/StatusDetailsMessage":{"id":"components/schemas/StatusDetailsMessage","kind":"json-schema","title":"StatusDetailsMessage","data":{"type":"string","description":"Human-readable message which may also be presented in user interface.","example":"The job came to an end and finished successfully."}},"components/schemas/StatusDetailsTechnicalKey":{"id":"components/schemas/StatusDetailsTechnicalKey","kind":"json-schema","title":"StatusDetailsTechnicalKey","data":{"type":"string","description":"Technical key to uniquely identify a message.","example":"JOB_FINISHED"}},"components/schemas/JsonPath":{"id":"components/schemas/JsonPath","kind":"json-schema","title":"JsonPath","data":{"type":"string","description":"JSONPath as specified by the IETF standard","example":"$.businessPartner.names[0].value"}},"components/schemas/JsonObject":{"id":"components/schemas/JsonObject","kind":"json-schema","title":"JsonObject","data":{"type":"string","description":"Object provided in plain JSON format.","example":"{ \"key\" : \"value\"}","additionalProperties":true}},"components/schemas/StatusDetails":{"id":"components/schemas/StatusDetails","kind":"json-schema","title":"StatusDetails","data":{"type":"object","description":"Details about this status or error","required":["id","message"],"properties":{"id":{"$ref":"#/components/schemas/StatusDetailsMessageId"},"message":{"$ref":"#/components/schemas/StatusDetailsMessage"},"technicalKey":{"$ref":"#/components/schemas/StatusDetailsTechnicalKey"},"jsonPath":{"$ref":"#/components/schemas/JsonPath"},"jsonRecord":{"$ref":"#/components/schemas/JsonObject"}}}},"components/schemas/StatusTimestamp":{"id":"components/schemas/StatusTimestamp","kind":"json-schema","title":"StatusTimestamp","data":{"type":"string","description":"ISO 8601 representation of the timestamp.","example":"2026-11-11T03:23:28Z"}},"components/schemas/ModifiedBy":{"id":"components/schemas/ModifiedBy","kind":"json-schema","title":"ModifiedBy","data":{"type":"string","description":"User or Client UUID which modified the resource.","example":"76248934691294444"}},"components/schemas/CorrelationId":{"id":"components/schemas/CorrelationId","kind":"json-schema","title":"CorrelationId","data":{"type":"string","description":"ID which uniquely chains a set of request()s and or task(s).","example":"123e4567-e89b-12d3-a456-426614174000"}},"components/schemas/Task":{"id":"components/schemas/Task","kind":"json-schema","title":"Task","data":{"type":"object","description":"A task is a unit of work.","properties":{"correlationId":{"$ref":"#/components/schemas/CorrelationId"},"userId":{"$ref":"#/components/schemas/UserId"},"jobId":{"$ref":"#/components/schemas/JobId"}}}},"components/schemas/ExternalContextIdentifierValue":{"id":"components/schemas/ExternalContextIdentifierValue","kind":"json-schema","title":"ExternalContextIdentifierValue","data":{"type":"string","description":"Value of own identifiers of a record.","example":"7250017031"}},"components/schemas/ExternalContextIdentifierTypeTechnicalKey":{"id":"components/schemas/ExternalContextIdentifierTypeTechnicalKey","kind":"json-schema","title":"ExternalContextIdentifierTypeTechnicalKey","data":{"type":"string","description":"Technical key for the External Context Identifier Type.","example":"KUNNR"}},"components/schemas/schemas-ExternalContextIdentifierType":{"id":"components/schemas/schemas-ExternalContextIdentifierType","kind":"json-schema","title":"schemas-ExternalContextIdentifierType","data":{"type":"object","description":"Type of own identifiers of a record.","properties":{"technicalKey":{"$ref":"#/components/schemas/ExternalContextIdentifierTypeTechnicalKey"}}}},"components/schemas/schemas-ExternalContextIdentifier":{"id":"components/schemas/schemas-ExternalContextIdentifier","kind":"json-schema","title":"schemas-ExternalContextIdentifier","data":{"type":"object","description":"Describe own identifiers of a record (others than just the external Id).","properties":{"value":{"$ref":"#/components/schemas/ExternalContextIdentifierValue"},"type":{"$ref":"#/components/schemas/schemas-ExternalContextIdentifierType"}}}},"components/schemas/schemas-ExternalContext":{"id":"components/schemas/schemas-ExternalContext","kind":"json-schema","title":"schemas-ExternalContext","data":{"type":"object","description":"Describe own identifiers of a record (others than just the external Id).","properties":{"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/schemas-ExternalContextIdentifier"}}}}},"components/schemas/schemas-BusinessPartner":{"id":"components/schemas/schemas-BusinessPartner","kind":"json-schema","title":"schemas-BusinessPartner","data":{"type":"object","description":"An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner.","properties":{"names":{"type":"array","items":{"$ref":"#/components/schemas/schemas-Name"}},"legalForm":{"$ref":"#/components/schemas/schemas-LegalForm"},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/schemas-Identifier"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/BusinessPartnerCategory"}},"status":{"$ref":"#/components/schemas/BusinessPartnerStatus"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/schemas-Address"}},"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"profile":{"$ref":"#/components/schemas/PartnerProfile"},"formattedSapRecord":{"$ref":"#/components/schemas/FormattedSapRecord"},"relations":{"type":"array","items":{"$ref":"#/components/schemas/BusinessPartnerRelation"}},"bankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/BankAccount"}},"types":{"type":"array","items":{"$ref":"#/components/schemas/BusinessPartnerType"}},"externalContext":{"$ref":"#/components/schemas/schemas-ExternalContext"}}}},"components/schemas/ReplyQueue":{"id":"components/schemas/ReplyQueue","kind":"json-schema","title":"ReplyQueue","data":{"type":"string","description":"Technical descriptor of reply queue where workers should put back the result.","example":"647328648329632-34890742-3432"}},"components/schemas/Worker":{"id":"components/schemas/Worker","kind":"json-schema","title":"Worker","data":{"type":"string","description":"Worker which generated the result.","example":"pod-647328648329632-34890742-3432"}},"components/schemas/TaskStatus":{"id":"components/schemas/TaskStatus","kind":"json-schema","title":"TaskStatus","data":{"type":"string","description":"Task status.","example":"OK"}},"components/schemas/TaskMessage":{"id":"components/schemas/TaskMessage","kind":"json-schema","title":"TaskMessage","data":{"type":"string","description":"Details task status.","example":"The validation was successful."}},"components/schemas/TaskResult":{"id":"components/schemas/TaskResult","kind":"json-schema","title":"TaskResult","data":{"type":"object","description":"Result or outcome of a task.","properties":{"worker":{"$ref":"#/components/schemas/Worker"},"correlationId":{"$ref":"#/components/schemas/CorrelationId"},"status":{"$ref":"#/components/schemas/TaskStatus"},"message":{"$ref":"#/components/schemas/TaskMessage"}}}},"schema_0":{"kind":"json-schema","data":{"type":"string","example":"65dcc3c60cecd503bcc88c92"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"integer","format":"int32","example":"1","minimum":0,"default":0},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"integer","format":"int32","example":"20","minimum":1,"default":20},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"$ref":"#/components/schemas/MatchingTypeParam"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"$ref":"#/components/schemas/WorkspaceId"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DataMatchingDefinitionId"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","description":"Matching Decision Import Job.","properties":{"file":{"type":"string","format":"binary","description":"XLSX or CSV file to be uploaded (SOAP currently only supports CSV).","example":"file.xlsx"},"decisionLogId":{"type":"string","description":"Target MatchingDecisionLog ID for this import.","example":"5e60dfdbd5fa2d000166ab4a"}},"required":["decisionLogId","file"]},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"$ref":"#/components/schemas/StartAfter"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"integer","format":"int32","example":"100","minimum":1,"default":20},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/UserfeedbacksFeatureEnum"}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","example":"9cfa14e7-51f5-4490-88e4-667501575b41"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"string","example":"72d6900fce6b326088f5d9d91049e3e6"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerId"},"id":"schema_14"},"schema_18":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Limit"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"boolean","example":true,"default":null},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","description":"API Key ID or Client ID. When present returns only configurations assigned to the given API key.","example":"12345678-1234-5678-1234-567812345678"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string","example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"},"id":"schema_21"},"schema_24":{"kind":"json-schema","data":{"type":"integer","example":1},"id":"schema_24"},"schema_27":{"kind":"json-schema","data":{"type":"number","format":"double","default":0.8,"minimum":0,"maximum":1,"example":0.8},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"array","description":"List of Business Partner IDs.","maxItems":500,"items":{"$ref":"#/components/schemas/BusinessPartnerId"}},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EntityLinkStatusParam"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"integer","format":"int32","example":"100","minimum":1,"maximum":250,"default":20},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EntityMatchingLinksReadFeatureEnum"}},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"string","format":"string","example":"2026-11-11T03:23:28Z"},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"array","description":"List of Business Partner externalIDs.","maxItems":100,"items":{"$ref":"#/components/schemas/BusinessPartnerExternalId"}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EntityMatchingStatusParam"},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"string","default":"-matchingScore","example":"-matchingScore"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EntityMatchingLinkId"},"id":"schema_36"}},"exampleStore":{"paths/~1entityresolution~1cleaners/get/responses/200/content/application~1json/examples/cleaners":{"value":{"cleaners":[{"name":"lower case normalizer","technicalkey":"lowercasenormalizer"},{"name":"legal form cleaner","technicalkey":"legalformcleaner","parameters":[{"name":"configproperty","description":"json path referencing the country shortname of the businesspartner"}]}],"status":{"code":200,"technicalkey":"ok","details":[{"id":200000000,"message":"successful request.","technicalkey":"default_ok"}]}},"key":"cleaners","summary":"List of available cleaners","id":"paths/~1entityresolution~1cleaners/get/responses/200/content/application~1json/examples/cleaners"},"paths/~1configurations~1entityresolution/get/responses/200/content/application~1json/examples/identityResolutionConfigurations":{"value":{"startAfter":"0","nextStartAfter":"1","total":2,"values":[{"name":"demo config","id":"63a1d4a07c855600fa769329","createdAt":"2022-12-20T15:28:32.684Z","modifiedAt":"2022-12-20T15:28:32.684Z","createdBy":"demo"},{"name":"demo config","id":"63a1d5a13b5faf2f613164c0","createdAt":"2022-12-20T15:32:49.579Z","modifiedAt":"2022-12-20T15:32:49.579Z","createdBy":"demo"}]},"key":"identityResolutionConfigurations","summary":"Page of identity resolution configurations","id":"paths/~1configurations~1entityresolution/get/responses/200/content/application~1json/examples/identityResolutionConfigurations"},"paths/~1configurations~1entityresolution~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration":{"value":{"name":"Demo config","configuration":{"candidateSearchConfiguration":{"maxCandidates":10,"searchAttributes":[{"jsonPath":"$.names[0].value"},{"jsonPath":"$.addresses[0].country.shortName"},{"jsonPath":"$.addresses[0].thoroughfares[0].value"}]},"generalMatchingConfiguration":{"threshold":0.85,"thresholdMaybe":0.65,"matchingAttributes":[{"name":"Matching Business Partner attribute - name","jsonPath":"businessPartner.names[0].value","cleaners":[{"name":"LowerCaseNormalizer"},{"name":"PunctuationsCleaner"},{"name":"LegalFormCleaner","parameters":[{"name":"configProperty","value":"$.addresses[0].country.shortName"}]}],"high":0.8,"low":0.3,"comparator":{"name":"QGramComparator","parameters":[{"name":"tokenizer","value":"BASIC"},{"name":"formula","value":"DICE"},{"name":"q","value":"3"}]}},{"name":"Matching Business Partner attribute - country","jsonPath":"businessPartner.addresses[0].country.shortName","cleaners":[{"name":"LowerCaseNormalizer"}],"high":0.5,"low":0,"comparator":{"name":"ExactComparator"}},{"name":"Matching Business Partner attribute - city","jsonPath":"businessPartner.addresses[0].localities[0].value","cleaners":[{"name":"LowerCaseNormalizer"},{"name":"PunctuationsCleaner"}],"high":0.6,"low":0.2,"comparator":{"name":"Levenshtein"}},{"name":"Matching Business Partner attribute - street","jsonPath":"businessPartner.addresses[0].thoroughfares[0].value","cleaners":[{"name":"LowerCaseNormalizer"},{"name":"PunctuationsCleaner"}],"high":0.7,"low":0.3,"comparator":{"name":"Levenshtein"}},{"name":"Matching Business Partner attribute - postal code","jsonPath":"businessPartner.addresses[0].postCodes[0].value","cleaners":[{"name":"DigitsOnlyCleaner"}],"high":0.6,"low":0.3,"comparator":{"name":"ExactComparator"}}]}},"version":1,"id":"69301d590929bb0d54010cf7","createdAt":"2025-12-03T11:22:01.336Z","createdBy":"demo","defaultConfiguration":false,"relatedConfigurations":[]},"key":"getConfiguration","summary":"Showcase response of identity resolution configuration","id":"paths/~1configurations~1entityresolution~1{configurationId}/get/responses/200/content/application~1json/examples/getConfiguration"},"paths/~1configurations~1entityresolution~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationInGivenVersion":{"value":{"id":"6930280e0929bb0d54010cfe","name":"Demo config","configurationId":"693027fa0929bb0d54010cfc","version":2,"configuration":{"candidateSearchConfiguration":{"maxCandidates":25,"searchAttributes":[{"jsonPath":"$.names[0].value"},{"jsonPath":"$.addresses[0].country.shortName"},{"jsonPath":"$.addresses[0].thoroughfares[0].value"}]},"generalMatchingConfiguration":{"threshold":0.85,"thresholdMaybe":0.65,"matchingAttributes":[{"name":"Matching Business Partner attribute - name","jsonPath":"businessPartner.names[0].value","cleaners":[{"name":"LowerCaseNormalizer"},{"name":"PunctuationsCleaner"},{"name":"LegalFormCleaner","parameters":[{"name":"configProperty","value":"$.addresses[0].country.shortName"}]}],"high":0.8,"low":0.3,"comparator":{"name":"QGramComparator","parameters":[{"name":"tokenizer","value":"BASIC"},{"name":"formula","value":"DICE"},{"name":"q","value":"3"}]}},{"name":"Matching Business Partner attribute - country","jsonPath":"businessPartner.addresses[0].country.shortName","cleaners":[{"name":"LowerCaseNormalizer"}],"high":0.5,"low":0,"comparator":{"name":"ExactComparator"}},{"name":"Matching Business Partner attribute - city","jsonPath":"businessPartner.addresses[0].localities[0].value","cleaners":[{"name":"LowerCaseNormalizer"},{"name":"PunctuationsCleaner"}],"high":0.6,"low":0.2,"comparator":{"name":"Levenshtein"}},{"name":"Matching Business Partner attribute - street","jsonPath":"businessPartner.addresses[0].thoroughfares[0].value","cleaners":[{"name":"LowerCaseNormalizer"},{"name":"PunctuationsCleaner"}],"high":0.7,"low":0.3,"comparator":{"name":"Levenshtein"}},{"name":"Matching Business Partner attribute - postal code","jsonPath":"businessPartner.addresses[0].postCodes[0].value","cleaners":[{"name":"DigitsOnlyCleaner"}],"high":0.6,"low":0.3,"comparator":{"name":"ExactComparator"}}]}},"createdAt":"2025-12-03T12:07:22.383Z","createdBy":"demo","modifiedAt":"2025-12-03T12:07:42.272Z","modifiedBy":"demo","defaultConfiguration":false},"key":"getConfigurationInGivenVersion","summary":"Showcase response of identity resolution configuration in given version","id":"paths/~1configurations~1entityresolution~1{configurationId}~1versions~1{version}/get/responses/200/content/application~1json/examples/getConfigurationInGivenVersion"},"paths/~1entityresolution~1entitymatchinglinks/get/responses/200/content/application~1json/examples/default":{"value":{"limit":20,"total":125,"startAfter":"aXhcYWdlIjoxLCJzaXplIjoyMH0=","nextStartAfter":"eyJwYWdlIjoyLCJzaXplIjoyMH0=","values":[{"storageId":"72d6900fce6b326088f5d9d91099e3e6","createdAt":"2024-02-15T10:30:00Z","createdBy":"system","modifiedAt":"2024-02-15T10:30:00Z","modifiedBy":"system","entityA":{"dataSourceId":"SAD_ERP","businessPartnerId":"BP000001"},"entityB":{"dataSourceId":"SAD_ERP","businessPartnerId":"BP000002"},"confidence":{"overallScore":0.95,"status":"MATCH","explanation":{"attributeMatchingExplanation":[{"jsonPath":"businessPartner.name","valueA":"Acme Corporation GmbH","valueB":"ACME Corp. GmbH","similarity":0.92},{"jsonPath":"businessPartner.address.street","valueA":"123 Main Street","valueB":"123 Main St.","similarity":0.98}]}},"linkStatus":"INFERRED"}]},"key":"default","summary":"default","id":"paths/~1entityresolution~1entitymatchinglinks/get/responses/200/content/application~1json/examples/default"},"paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/retract_link":{"value":{"linkStatus":"RETRACTED","linkStatusUserComment":"Small Update - completely wrong duplicate"},"key":"retract_link","summary":"Retract a matching link","id":"paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/retract_link"},"paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/assert_link":{"value":{"linkStatus":"ASSERTED","linkStatusUserComment":"Verified as correct match"},"key":"assert_link","summary":"Assert a matching link","id":"paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/assert_link"},"paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/no_comment":{"value":{"linkStatus":"RETRACTED"},"key":"no_comment","summary":"Update without comment","id":"paths/~1entityresolution~1entitymatchinglinks~1{id}/patch/requestBody/content/application~1json/examples/no_comment"}},"securitySchemeStore":{"apiKey":{"id":"apiKey","type":"apiKey","in":"header","paramName":"X-API-KEY"}},"servers":[{"url":"https://api.cdq.com/data-matching/rest","description":"Production"}],"specType":"openapi"},"options":{"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"curl","label":"cURL"},{"lang":"Java","label":"Java"},{"lang":"JavaScript","label":"JavaScript"},{"lang":"Python","label":"Python"},{"lang":"Node.js","label":"Node.js"}]},"feedback":{"type":"sentiment","settings":{"label":"Share the feedback!","submitText":"Thank you for sharing!","reasons":{"component":"checkbox","label":"Tell us more about your experience.","items":["Content covered the topic well.","The content has great examples.","The content is thoroughly detailed.","The content is easy to understand."]},"comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"}}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/data-matching-api/@data-matching-api-v2/api-v2.json?download"},{"url":"/_bundle/apis/data-matching-api/@data-matching-api-v2/api-v2.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Data Matching API","description":"This API provides services for maintaining matching definitions used as configuration\nfor matching jobs, as well as services for matching data with a job.\n"}},"baseSlug":"/apis/data-matching-api/api-v2","routesMapping":{}}