{"items":[{"type":"link","label":"Data Exchange API","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4","content":{"contentType":"overview","meta":{"name":"Data Exchange API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api-v4.json","url":"/_bundle/apis/data-exchange-api/@data-exchange-api-v4/api-v4.json?download"},{"kind":"download","label":"api-v4.yaml","url":"/_bundle/apis/data-exchange-api/@data-exchange-api-v4/api-v4.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-exchange/rest","x-cdq-soap-url":"https://api.corporate-data-league.ch/data-exchange/soap/v4"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Data Exchange API (4)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This API provides services to upload, manipulate and download businesspartner data in the CDL Cloud."}],"sectionId":"/apis/data-exchange-api/data-exchange-api-v4/api-v4"}],"sectionId":"/apis/data-exchange-api/data-exchange-api-v4/api-v4"}]}]}},{"type":"group","label":"Relations","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/relations","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/relations","items":[{"label":"Initialize Storage relations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/relations/paths/~1v4~1storages~1{storageid}~1relations/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/relations/paths/~1v4~1storages~1{storageid}~1relations/post","metadata":{"seo":{"title":"Initialize Storage relations","description":"Initialize relations in a Business Partner Storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Initialize Storage relations","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1relations/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initialize Storage relations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initialize relations in a Business Partner Storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1relations/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/storages/{storageId}/relations","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/v4/storages/{storageId}/relations","href":"relations/paths/~1v4~1storages~1{storageid}~1relations/post","summary":"Initialize Storage relations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1relations/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relations/paths/~1v4~1storages~1{storageid}~1relations/post"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/relations"},{"label":"List Relations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/relations/paths/~1v4~1storages~1{storageid}~1relations/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/relations/paths/~1v4~1storages~1{storageid}~1relations/get","metadata":{"seo":{"title":"List Relations","description":"Read a page of relations from a Business Partner Storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Relations","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1relations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Relations","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 relations from a Business Partner Storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1relations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startAfter","in":"query","schemaId":"schema_1","description":"Only items with an ID greater than the given one will be retrieved.\n\nWhen nextStartAfter provided in the response, should be used instead of the ID\nas an indicator for a next page.\n"},{"name":"limit","in":"query","schemaId":"schema_2","description":"Number of items to be returned on the page."},{"name":"featureOn","in":"query","schemaId":"schema_3","description":"Features to be activated during Relations read."},{"name":"featureOff","in":"query","schemaId":"schema_4","description":"Features to be deactivated during Relations read."},{"name":"externalId","in":"query","schemaId":"schema_5","description":"Business Partner externalIDs."},{"name":"dataSource","in":"query","schemaId":"schema_6","description":"Data Source (name or ID) used to filter the result of Business Partner Relations returned."},{"name":"type","in":"query","schemaId":"schema_7","description":"Filter by type."},{"name":"classTechnicalKey","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by class technical key. List of available "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataModel:CDQ/Business_Partner/Business_Partner_Relation/Business_Partner_Relation_Class"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"classes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"endedAfter","in":"query","schemaId":"schema_9","description":"Find relations which endedAt is after given date."},{"name":"endedBefore","in":"query","schemaId":"schema_9","description":"Find relations which endedAt is before given date."},{"name":"startedAfter","in":"query","schemaId":"schema_9","description":"Find relations which startedAt is after given date."},{"name":"startedBefore","in":"query","schemaId":"schema_9","description":"Find relations which startedAt is before given date"},{"name":"acting","in":"query","schemaId":"schema_10","description":"Find relations that are ACTIVE or INACTIVE."}],"pointer":"/paths/~1v4~1storages~1{storageId}~1relations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/storages/{storageId}/relations","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"schema_2"},{"name":"featureOn","in":"query","required":false,"schemaId":"schema_3"},{"name":"featureOff","in":"query","required":false,"schemaId":"schema_4"},{"name":"externalId","in":"query","required":false,"example":"The ID managed in the customer's SAP systems.","schemaId":"components/schemas/BusinessPartnerExternalId"},{"name":"dataSource","in":"query","required":false,"example":"\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"","schemaId":"components/schemas/BusinessPartnerDataSource"},{"name":"type","in":"query","required":false,"example":"COMMERCIAL_ULTIMATE","schemaId":"components/schemas/BusinessPartnerRelationTypeTechnicalKey"},{"name":"classTechnicalKey","in":"query","required":false,"example":"BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY","schemaId":"components/schemas/BusinessPartnerRelationClassTechnicalKey"},{"name":"endedAfter","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"endedBefore","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"startedAfter","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"startedBefore","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"acting","in":"query","required":false,"example":"ACTIVE","schemaId":"components/schemas/RelationsReadActingParam"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/storages/{storageId}/relations","href":"relations/paths/~1v4~1storages~1{storageid}~1relations/get","summary":"List Relations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/BusinessPartnerRelationsPage"}},"schemaId":"components/schemas/BusinessPartnerRelationsPage"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1relations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerRelationsPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerRelationsPage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relations/paths/~1v4~1storages~1{storageid}~1relations/get"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/relations"},{"label":"Upsert Business Partner Relations","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/relations/paths/~1v4~1storages~1{storageid}~1relations/put","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/relations/paths/~1v4~1storages~1{storageid}~1relations/put","metadata":{"seo":{"title":"Upsert Business Partner Relations","description":"Insert or update Business Partner Relations. Relations that are not listed in the request are not modified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upsert Business Partner Relations","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1relations/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert Business Partner Relations","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":"Insert or update Business Partner Relations. Relations that are not listed in the request are not modified."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In D&B storages, not-listed relations of class "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_PARTNER_RELATION_CLASS_DNB_HIERARCHY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMMERCIAL_ULTIMATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOMESTIC_COMMERCIAL_ULTIMATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are marked as INACTIVE."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the wiki's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataModel:CDQ/Business_Partner/Business_Partner_Relation/Business_Partner_Relation_Class"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Relation Class"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataModel:CDQ/Business_Partner/Business_Partner_Relation/Business_Partner_Relation_Type"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Relation Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details about the mentioned types and classes."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1relations/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RelationsUpsertRequest"}},"schemaId":"components/schemas/RelationsUpsertRequest","pointer":"/paths/~1v4~1storages~1{storageId}~1relations/put/requestBody","description":"Parameters for Relations Upsert Request."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/storages/{storageId}/relations","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RelationsUpsertRequest"}},"responseCodes":["200","400","401"],"pointer":"/v4/storages/{storageId}/relations","href":"relations/paths/~1v4~1storages~1{storageid}~1relations/put","summary":"Upsert Business Partner Relations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/RelationsUpsertRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RelationsUpsertRequest"}},"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/RelationsUpsertResult"}},"schemaId":"components/schemas/RelationsUpsertResult"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1relations/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RelationsUpsertResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelationsUpsertResult"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relations/paths/~1v4~1storages~1{storageid}~1relations/put"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/relations"},{"label":"Delete relations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/relations/paths/~1v4~1storages~1{storageid}~1relations~1delete/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/relations/paths/~1v4~1storages~1{storageid}~1relations~1delete/post","metadata":{"seo":{"title":"Delete relations","description":"Delete relations from a storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete relations","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1relations~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete relations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete relations from a storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1relations~1delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerRelationsDeleteRequest"}},"schemaId":"components/schemas/BusinessPartnerRelationsDeleteRequest","pointer":"/paths/~1v4~1storages~1{storageId}~1relations~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/storages/{storageId}/relations/delete","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnerRelationsDeleteRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v4/storages/{storageId}/relations/delete","href":"relations/paths/~1v4~1storages~1{storageid}~1relations~1delete/post","summary":"Delete relations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnerRelationsDeleteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerRelationsDeleteRequest"}},"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/BusinessPartnerRelationsDeleteResult"}},"schemaId":"components/schemas/BusinessPartnerRelationsDeleteResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1relations~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerRelationsDeleteResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerRelationsDeleteResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relations/paths/~1v4~1storages~1{storageid}~1relations~1delete/post"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/relations/delete"}],"content":{"contentType":"group","meta":{"name":"Relations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Relations","showPageActions":true},{"nodeType":"markdoc","content":"Manages relationships between Business Partners."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/storages/{storageId}/relations","summary":"Initialize Storage relations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/relations/paths/~1v4~1storages~1{storageid}~1relations/post","deprecated":false},{"title":"/v4/storages/{storageId}/relations","summary":"List Relations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/relations/paths/~1v4~1storages~1{storageid}~1relations/get","deprecated":false},{"title":"/v4/storages/{storageId}/relations","summary":"Upsert Business Partner Relations","prefix":{"name":"put","color":"put"},"badges":[],"link":"/relations/paths/~1v4~1storages~1{storageid}~1relations/put","deprecated":false},{"title":"/v4/storages/{storageId}/relations/delete","summary":"Delete relations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/relations/paths/~1v4~1storages~1{storageid}~1relations~1delete/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriptions","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/subscriptions","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/subscriptions","items":[{"label":"List Links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/subscriptions/paths/~1v4~1businesspartners~1identitylinks/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/subscriptions/paths/~1v4~1businesspartners~1identitylinks/get","metadata":{"seo":{"title":"List Links","description":"Reads a page of links of the Business Partners starting from the 'startAfter' and with a size of 'limit'."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Links","isWebhook":false,"pointer":"/paths/~1v4~1businesspartners~1identitylinks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reads a page of links of the Business Partners starting from the 'startAfter' and with a size of 'limit'."},{"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_1","description":"Only items with an ID greater than the given one will be retrieved.\n\nWhen nextStartAfter provided in the response, should be used instead of the ID\nas an indicator for a next page.\n"},{"name":"limit","in":"query","schemaId":"schema_2","description":"Number of items to be returned on the page."},{"name":"storageId","in":"query","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true},{"name":"referenceDataSource","in":"query","schemaId":"schema_11","description":"Reference data source as ALEI prefix of the linked Business Partner."},{"name":"businessPartnerId","in":"query","schemaId":"schema_12","description":"Business Partner IDs which should be filtered."},{"name":"externalId","in":"query","schemaId":"schema_13","description":"Business Partner externalIDs."},{"name":"dataSourceId","in":"query","schemaId":"schema_14","description":"Filter by specified Data Source ID."},{"name":"cdqIds","in":"query","schemaId":"schema_15","description":"CDQ IDs which should be filtered."},{"name":"featuresOn","in":"query","schemaId":"schema_19","description":"Features to be activated."},{"name":"featuresOff","in":"query","schemaId":"schema_20","description":"Features to be deactivated."}],"pointer":"/paths/~1v4~1businesspartners~1identitylinks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/businesspartners/identitylinks","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"schema_2"},{"name":"storageId","in":"query","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"referenceDataSource","in":"query","required":false,"schemaId":"schema_11"},{"name":"businessPartnerId","in":"query","required":false,"schemaId":"schema_12"},{"name":"externalId","in":"query","required":false,"schemaId":"schema_13"},{"name":"dataSourceId","in":"query","required":false,"schemaId":"schema_14"},{"name":"cdqIds","in":"query","required":false,"schemaId":"schema_15"},{"name":"linkageStatuses","in":"query","required":false,"schemaId":"schema_16"},{"name":"statusRetry","in":"query","required":false,"example":true,"schemaId":"components/schemas/LinkRetryValue"},{"name":"sort","in":"query","required":false,"example":"+id","schemaId":"schema_18"},{"name":"featuresOn","in":"query","schemaId":"schema_19"},{"name":"featuresOff","in":"query","schemaId":"schema_20"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/businesspartners/identitylinks","href":"subscriptions/paths/~1v4~1businesspartners~1identitylinks/get","summary":"List Links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/BusinessPartnerIdentityLinkPage"}},"schemaId":"components/schemas/BusinessPartnerIdentityLinkPage"}],"pointer":"/paths/~1v4~1businesspartners~1identitylinks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerIdentityLinkPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerIdentityLinkPage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/paths/~1v4~1businesspartners~1identitylinks/get"}],"panels":[]}]},"httpPath":"/v4/businesspartners/identitylinks"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for managing subscriptions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/businesspartners/identitylinks","summary":"List Links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/paths/~1v4~1businesspartners~1identitylinks/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Business Partner Storages","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages","items":[{"label":"Update Storage","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}/put","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}/put","metadata":{"seo":{"title":"Update Storage","description":"Update a Business Partner Storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Storage","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Storage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a Business Partner Storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique ID of a Business Partner Storage.","required":true}],"pointer":"/paths/~1storages~1{storageId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerStorageMetadataUpdate"}},"schemaId":"components/schemas/BusinessPartnerStorageMetadataUpdate","pointer":"/paths/~1storages~1{storageId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/storages/{storageId}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnerStorageMetadataUpdate"}},"responseCodes":["200"],"pointer":"/storages/{storageId}","href":"business-partner-storages/paths/~1storages~1{storageid}/put","summary":"Update Storage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnerStorageMetadataUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerStorageMetadataUpdate"}},"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/BusinessPartnerStorageMetadata"}},"schemaId":"components/schemas/BusinessPartnerStorageMetadata"}],"pointer":"/paths/~1storages~1{storageId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerStorageMetadata","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerStorageMetadata"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1storages~1{storageid}/put"}],"panels":[]}]},"httpPath":"/storages/{storageId}"},{"label":"Delete Storage","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}/delete","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}/delete","metadata":{"seo":{"title":"Delete Storage","description":"Delete a Business Partner Storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete Storage","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Storage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a Business Partner Storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique ID of a Business Partner Storage.","required":true}],"pointer":"/paths/~1storages~1{storageId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[],"pointer":"/paths/~1storages~1{storageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/storages/{storageId}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[{"name":"featuresOn","in":"query","required":false,"schemaId":"schema_21"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/storages/{storageId}","href":"business-partner-storages/paths/~1storages~1{storageid}/delete","summary":"Delete Storage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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"}],"pointer":"/paths/~1storages~1{storageId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1storages~1{storageid}/delete"}],"panels":[]}]},"httpPath":"/storages/{storageId}"},{"label":"Roll Event Store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1v2~1storages~1{storageid}~1eventstore~1roll/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1v2~1storages~1{storageid}~1eventstore~1roll/post","metadata":{"seo":{"title":"Roll Event Store","description":"Roll Event Store for Business Partner Storage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Roll Event Store","isWebhook":false,"pointer":"/paths/~1v2~1storages~1{storageId}~1eventstore~1roll/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roll Event Store","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roll Event Store for Business Partner Storage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint facilitates the transition to a new event store for Business Partner Storage. The process involves several key steps:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Ensure that the collection associated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previousEventStoreId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not exist. If it does, rolling to a new event store is prohibited."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Establish a new collection intended to store events for the Business Partner Storage's event store."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Backup:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Safeguard the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventStoreId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by storing it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previousEventStoreId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the Business Partner Storage Metadata."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assignment:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Update the Business Partner Storage Metadata by setting the new collection ID as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventStoreId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preservation:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previousEventStoreId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without dropping it, as it is now prepared for backup."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint ensures a smooth transition while maintaining the integrity and accessibility of historical event data."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v2~1storages~1{storageId}~1eventstore~1roll/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerEventStoreRollRequest"}},"schemaId":"components/schemas/BusinessPartnerEventStoreRollRequest","pointer":"/paths/~1v2~1storages~1{storageId}~1eventstore~1roll/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/storages/{storageId}/eventstore/roll","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnerEventStoreRollRequest"}},"responseCodes":["200","400"],"pointer":"/v2/storages/{storageId}/eventstore/roll","href":"business-partner-storages/paths/~1v2~1storages~1{storageid}~1eventstore~1roll/post","summary":"Roll Event Store"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnerEventStoreRollRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerEventStoreRollRequest"}},"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/BusinessPartnerEventStoreRollResult"}},"schemaId":"components/schemas/BusinessPartnerEventStoreRollResult"},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v2~1storages~1{storageId}~1eventstore~1roll/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerEventStoreRollResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerEventStoreRollResult"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1v2~1storages~1{storageid}~1eventstore~1roll/post"}],"panels":[]}]},"httpPath":"/v2/storages/{storageId}/eventstore/roll"},{"label":"List Sharing Scopes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/get","metadata":{"seo":{"title":"List Sharing Scopes","description":"List all sharing scopes of the give storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Sharing Scopes","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Sharing Scopes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all sharing scopes of the give storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startAfter","in":"query","schemaId":"schema_1","description":"Only items with an ID greater than the given one will be retrieved.\n\nWhen nextStartAfter provided in the response, should be used instead of the ID\nas an indicator for a next page.\n"},{"name":"limit","in":"query","schemaId":"schema_2","description":"Number of items to be returned on the page."},{"name":"featuresOn","in":"query","schemaId":"schema_23","description":"Features to be activated."}],"pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/storages/{storageId}/sharingscopes","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"schema_2"},{"name":"featuresOn","in":"query","required":false,"schemaId":"schema_23"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/storages/{storageId}/sharingscopes","href":"business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/get","summary":"List Sharing Scopes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/SharingScopesPage"}},"schemaId":"components/schemas/SharingScopesPage"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SharingScopesPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharingScopesPage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/get"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/sharingscopes"},{"label":"Create Sharing Scope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/post","metadata":{"seo":{"title":"Create Sharing Scope","description":"Create a new sharing scope. Max 100 sharing scopes are allowed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create Sharing Scope","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Sharing Scope","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 sharing scope. Max 100 sharing scopes are allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating sharing scope, all Business Partners from selection scope which are covered become disclosed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following table presents the source for disclosed field."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mapping disclosure"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sharing Scope matches"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source for disclosed"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mapping disclosure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mapping disclosure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sharing Scope"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default: false, otherwise from API request up to V4"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When source for disclosed field is Sharing Scope, the value is determined only during"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the creation of a Sharing Scope or Business Partner. Any new update of Business Partner"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"doesn't overwrite the value of disclosed in the Business Partner. To change the disclosure"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of a concrete Business Partner, it has to be "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/business-partners/paths/~1v3~1storages~1%7Bstorageid%7D~1businesspartners~1updatedisclosure/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requested directly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/post/request/note","deepLinkHash":"/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/post#business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/post/request/note"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partners with the Business Partner profile tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MARKED_FOR_DELETION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are excluded from sharing and are not considered during Sharing Scope processing."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharingScopeCreate"}},"schemaId":"components/schemas/SharingScopeCreate","pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/storages/{storageId}/sharingscopes","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SharingScopeCreate"}},"responseCodes":["200","400"],"pointer":"/v4/storages/{storageId}/sharingscopes","href":"business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/post","summary":"Create Sharing Scope"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/SharingScopeCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharingScopeCreate"}},"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/SharingScope","exampleIds":["paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example1","paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example2"]}},"schemaId":"components/schemas/SharingScope","exampleIds":["paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example1","paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example2"]},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SharingScope","exampleIds":["paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example1","paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharingScope","exampleIds":["paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example1","paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example2"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/post"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/sharingscopes"},{"label":"Delete Sharing Scopes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes~1delete/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes~1delete/post","metadata":{"seo":{"title":"Delete Sharing Scopes","description":"Delete sharing scopes. When deleting sharing scope, all Business Partners from selection scope who are not included in any other sharing scopes, become undisclosed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete Sharing Scopes","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Sharing Scopes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete sharing scopes. When deleting sharing scope, all Business Partners from selection scope who are not included in any other sharing scopes, become undisclosed."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes~1delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharingScopeDeletes"}},"schemaId":"components/schemas/SharingScopeDeletes","pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/storages/{storageId}/sharingscopes/delete","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SharingScopeDeletes"}},"responseCodes":["200"],"pointer":"/v4/storages/{storageId}/sharingscopes/delete","href":"business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes~1delete/post","summary":"Delete Sharing Scopes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/SharingScopeDeletes","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharingScopeDeletes"}},"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/SharingScopeDeleteResults"}},"schemaId":"components/schemas/SharingScopeDeleteResults"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1sharingscopes~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SharingScopeDeleteResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharingScopeDeleteResults"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes~1delete/post"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/sharingscopes/delete"},{"label":"Clear Storage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1clear/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1clear/post","metadata":{"seo":{"title":"Clear Storage","description":"Remove all Business Partners from given Business Partner Storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Clear Storage","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}~1clear/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear Storage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove all Business Partners from given Business Partner Storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique ID of a Business Partner Storage.","required":true}],"pointer":"/paths/~1storages~1{storageId}~1clear/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/storages/{storageId}/clear","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/storages/{storageId}/clear","href":"business-partner-storages/paths/~1storages~1{storageid}~1clear/post","summary":"Clear Storage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/BusinessPartnersClearResult"}},"schemaId":"components/schemas/BusinessPartnersClearResult"}],"pointer":"/paths/~1storages~1{storageId}~1clear/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnersClearResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnersClearResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1storages~1{storageid}~1clear/post"}],"panels":[]}]},"httpPath":"/storages/{storageId}/clear"},{"label":"Create Data Source","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources/post","metadata":{"seo":{"title":"Create Data Source","description":"Create a new data source. Max 100 data sources are allowed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create Data Source","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}~1datasources/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Data Source","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 source. Max 100 data sources are allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warn: If you have an integration with one data source, please check if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data source id is included in the upsert request before adding a new data source."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, adding new data source may lead to upsert failures visible as bad request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"containing message \"No DataSource was provided for the given Business Partners"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the storage has more than one attached to it.\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case data source is created within DATA_MIRROR and does not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataMapperDefinitionId"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataTransformationDefinitionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filled, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataMapperDefinitionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique ID of Business Partner storage.","required":true}],"pointer":"/paths/~1storages~1{storageId}~1datasources/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataSourceCreate"}},"schemaId":"components/schemas/DataSourceCreate","pointer":"/paths/~1storages~1{storageId}~1datasources/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/storages/{storageId}/datasources","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataSourceCreate"}},"responseCodes":["200","400"],"pointer":"/storages/{storageId}/datasources","href":"business-partner-storages/paths/~1storages~1{storageid}~1datasources/post","summary":"Create Data Source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/DataSourceCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataSourceCreate"}},"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/DataSourceParam"}},"schemaId":"components/schemas/DataSourceParam"},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1storages~1{storageId}~1datasources/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceParam","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceParam"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources/post"}],"panels":[]}]},"httpPath":"/storages/{storageId}/datasources"},{"label":"Update Data Source","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}/put","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}/put","metadata":{"seo":{"title":"Update Data Source","description":"Update a Data Source."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Data Source","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Data Source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a Data Source."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique ID of the Business Partner storage.","required":true},{"name":"dataSourceId","in":"path","schemaId":"schema_27","description":"Filter by specified Data Source ID.","required":true}],"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataSourceUpdate"}},"schemaId":"components/schemas/DataSourceUpdate","pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/storages/{storageId}/datasources/{dataSourceId}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"dataSourceId","in":"path","required":true,"example":"648824a691d8d2503d65103e","schemaId":"components/schemas/BusinessPartnerStorageDataSourceId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataSourceUpdate"}},"responseCodes":["200","400"],"pointer":"/storages/{storageId}/datasources/{dataSourceId}","href":"business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}/put","summary":"Update Data Source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/DataSourceUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataSourceUpdate"}},"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/DataSourceUpdateResult"}},"schemaId":"components/schemas/DataSourceUpdateResult"},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceUpdateResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceUpdateResult"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}/put"}],"panels":[]}]},"httpPath":"/storages/{storageId}/datasources/{dataSourceId}"},{"label":"Delete Data Source","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}/delete","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}/delete","metadata":{"seo":{"title":"Delete Data Source","description":"Delete a data source and its dependencies:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete Data Source","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Data Source","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":"Delete a data source and its dependencies:"},"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":"Business Partners from a storage,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update monitors, data monitors and sharing scopes for that data source are adjusted (data source is removed from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the data sources list of a resource and resource is removed if data source was the only one assigned)."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique ID of the Business Partner storage.","required":true},{"name":"dataSourceId","in":"path","schemaId":"schema_27","description":"Filter by specified Data Source ID.","required":true}],"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[],"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/storages/{storageId}/datasources/{dataSourceId}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"dataSourceId","in":"path","required":true,"example":"648824a691d8d2503d65103e","schemaId":"components/schemas/BusinessPartnerStorageDataSourceId"}],"query":[{"name":"featuresOn","in":"query","required":false,"schemaId":"schema_28"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/storages/{storageId}/datasources/{dataSourceId}","href":"business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}/delete","summary":"Delete Data Source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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"}],"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}/delete"}],"panels":[]}]},"httpPath":"/storages/{storageId}/datasources/{dataSourceId}"},{"label":"Clear Data Source","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1clear/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1clear/post","metadata":{"seo":{"title":"Clear Data Source","description":"Clear all Business Partners of a data source."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Clear Data Source","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}~1clear/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear Data Source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Clear all Business Partners of a data source."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true},{"name":"dataSourceId","in":"path","schemaId":"schema_27","description":"Unique identifier for a Data Source of the Storage.","required":true}],"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}~1clear/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/storages/{storageId}/datasources/{dataSourceId}/clear","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"dataSourceId","in":"path","required":true,"example":"648824a691d8d2503d65103e","schemaId":"components/schemas/BusinessPartnerStorageDataSourceId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/storages/{storageId}/datasources/{dataSourceId}/clear","href":"business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1clear/post","summary":"Clear Data Source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/BusinessPartnersDeleteResult"}},"schemaId":"components/schemas/BusinessPartnersDeleteResult"}],"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}~1clear/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnersDeleteResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnersDeleteResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1clear/post"}],"panels":[]}]},"httpPath":"/storages/{storageId}/datasources/{dataSourceId}/clear"},{"label":"Copy Data Source","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1copy/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1copy/post","metadata":{"seo":{"title":"Copy Data Source","description":"Copy a data source between storages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Copy Data Source","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}~1copy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy Data Source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Copy a data source between storages."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true},{"name":"dataSourceId","in":"path","schemaId":"schema_27","description":"Unique identifier for a Data Source of the Storage.","required":true}],"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}~1copy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnersCopyJobCreate"}},"schemaId":"components/schemas/BusinessPartnersCopyJobCreate","pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}~1copy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/storages/{storageId}/datasources/{dataSourceId}/copy","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"dataSourceId","in":"path","required":true,"example":"648824a691d8d2503d65103e","schemaId":"components/schemas/BusinessPartnerStorageDataSourceId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnersCopyJobCreate"}},"responseCodes":["200"],"pointer":"/storages/{storageId}/datasources/{dataSourceId}/copy","href":"business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1copy/post","summary":"Copy Data Source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnersCopyJobCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnersCopyJobCreate"}},"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/BusinessPartnersCopyJob"}},"schemaId":"components/schemas/BusinessPartnersCopyJob"}],"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnersCopyJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnersCopyJob"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1copy/post"}],"panels":[]}]},"httpPath":"/storages/{storageId}/datasources/{dataSourceId}/copy"},{"label":"Poll Copy Data Source Job Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1copy~1{jobid}/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1copy~1{jobid}/get","metadata":{"seo":{"title":"Poll Copy Data Source Job Status","description":"Allows polling the status of copy data source job"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Poll Copy Data Source Job Status","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}~1copy~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll Copy Data Source Job Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows polling the status of copy data source 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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true},{"name":"dataSourceId","in":"path","schemaId":"schema_27","description":"Unique identifier for a Data Source of the Storage.","required":true},{"name":"jobId","in":"path","schemaId":"schema_29","description":"Unique identifier of a Job.","required":true}],"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}~1copy~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/storages/{storageId}/datasources/{dataSourceId}/copy/{jobId}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"dataSourceId","in":"path","required":true,"example":"648824a691d8d2503d65103e","schemaId":"components/schemas/BusinessPartnerStorageDataSourceId"},{"name":"jobId","in":"path","required":true,"example":"35f23c03-1c22-45fe-9484-3ffe769325de","schemaId":"components/schemas/JobId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/storages/{storageId}/datasources/{dataSourceId}/copy/{jobId}","href":"business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1copy~1{jobid}/get","summary":"Poll Copy Data Source Job Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/BusinessPartnersCopyJob"}},"schemaId":"components/schemas/BusinessPartnersCopyJob"}],"pointer":"/paths/~1storages~1{storageId}~1datasources~1{dataSourceId}~1copy~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnersCopyJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnersCopyJob"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1copy~1{jobid}/get"}],"panels":[]}]},"httpPath":"/storages/{storageId}/datasources/{dataSourceId}/copy/{jobId}"},{"label":"List Update Monitors' Data Sources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1v2~1updatemonitors~1referencedatasources/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1v2~1updatemonitors~1referencedatasources/get","metadata":{"seo":{"title":"List Update Monitors' Data Sources","description":"List all data sources available for update monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Update Monitors' Data Sources","isWebhook":false,"pointer":"/paths/~1v2~1updatemonitors~1referencedatasources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Update Monitors' Data Sources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all data sources available for update monitoring."},{"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":"featuresOn","in":"query","schemaId":"schema_30","description":"Features to be activated."}],"pointer":"/paths/~1v2~1updatemonitors~1referencedatasources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/updatemonitors/referencedatasources","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"featuresOn","in":"query","required":false,"schemaId":"schema_30"},{"name":"organizationId","in":"query","required":false,"example":"cdq_monitor","schemaId":"components/schemas/OrganizationId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/updatemonitors/referencedatasources","href":"business-partner-storages/paths/~1v2~1updatemonitors~1referencedatasources/get","summary":"List Update Monitors' Data Sources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/UpdateMonitorReferenceDataSourcesResult"}},"schemaId":"components/schemas/UpdateMonitorReferenceDataSourcesResult"}],"pointer":"/paths/~1v2~1updatemonitors~1referencedatasources/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateMonitorReferenceDataSourcesResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateMonitorReferenceDataSourcesResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1v2~1updatemonitors~1referencedatasources/get"}],"panels":[]}]},"httpPath":"/v2/updatemonitors/referencedatasources"},{"label":"Update Data Sources","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources/put","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1storages~1{storageid}~1datasources/put","metadata":{"seo":{"title":"Update Data Sources","description":"This endpoint is deprecated. Please use"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Data Sources","deprecated":true,"isWebhook":false,"pointer":"/paths/~1storages~1{storageId}~1datasources/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Data Sources","isWebhook":false,"deprecated":true,"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":"This endpoint is deprecated. Please use"},"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":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/business-partner-storages/paths/~1storages~1%7Bstorageid%7D~1datasources/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create data source"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a new data source,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/business-partner-storages/paths/~1storages~1%7Bstorageid%7D~1datasources~1%7Bdatasourceid%7D/put"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update data source"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update existing data source,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/business-partner-storages/paths/~1storages~1%7Bstorageid%7D~1datasources~1%7Bdatasourceid%7D/delete"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delete data source"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to delete existing data source."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update all data sources of a given storage."},"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":"When a new data source without id is added to the list, it is created. In case data source is created within DATA_MIRROR and does not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataMapperDefinitionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataTransformationDefinitionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filled, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataMapperDefinitionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When existing data source is provided on a list with id included, it is updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When data source identified by id is not included in a list, it is deleted with all its related Business Partners,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data monitors and sharing scopes for that data source are adjusted (data source is removed from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the data sources list of a resource and resource is removed if data source was the only one assigned)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: all data sources that are expected to remain in the storage must be included on a list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warn: If you have an integration with one data source, please check if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data source id is included in the upsert request before adding a new data source."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, adding new data source may lead to upsert failures visible as bad request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"containing message \"No DataSource was provided for the given Business Partners"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the storage has more than one attached to it.\"."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique ID of Business Partner storage.","required":true}],"pointer":"/paths/~1storages~1{storageId}~1datasources/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataSourceUpserts"}},"schemaId":"components/schemas/DataSourceUpserts","pointer":"/paths/~1storages~1{storageId}~1datasources/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/storages/{storageId}/datasources","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataSourceUpserts"}},"responseCodes":["200"],"pointer":"/storages/{storageId}/datasources","href":"business-partner-storages/paths/~1storages~1{storageid}~1datasources/put","summary":"Update Data Sources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/DataSourceUpserts","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataSourceUpserts"}},"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/DataSourceUpsertsResult"}},"schemaId":"components/schemas/DataSourceUpsertsResult"}],"pointer":"/paths/~1storages~1{storageId}~1datasources/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceUpsertsResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceUpsertsResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources/put"}],"panels":[]}]},"httpPath":"/storages/{storageId}/datasources"},{"label":"List Update Monitors' Data Sources","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1updatemonitors~1datasources/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages/paths/~1updatemonitors~1datasources/get","metadata":{"seo":{"title":"List Update Monitors' Data Sources","description":"List all data sources available for update monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Update Monitors' Data Sources","deprecated":true,"isWebhook":false,"pointer":"/paths/~1updatemonitors~1datasources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Update Monitors' Data Sources","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all data sources available for update monitoring."},{"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":"/updatemonitors/datasources","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/updatemonitors/datasources","href":"business-partner-storages/paths/~1updatemonitors~1datasources/get","summary":"List Update Monitors' Data Sources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/UpdateMonitorDataSourcesResult"}},"schemaId":"components/schemas/UpdateMonitorDataSourcesResult"}],"pointer":"/paths/~1updatemonitors~1datasources/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateMonitorDataSourcesResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateMonitorDataSourcesResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partner-storages/paths/~1updatemonitors~1datasources/get"}],"panels":[]}]},"httpPath":"/updatemonitors/datasources"}],"content":{"contentType":"group","meta":{"name":"Business Partner Storages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Business Partner Storages","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for creating, retrieving, updating and deleting Business Partner storage, as well as managing \nassociated data sources and data monitors."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/storages/{storageId}","summary":"Update Storage","prefix":{"name":"put","color":"put"},"badges":[],"link":"/business-partner-storages/paths/~1storages~1{storageid}/put","deprecated":false},{"title":"/storages/{storageId}","summary":"Delete Storage","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/business-partner-storages/paths/~1storages~1{storageid}/delete","deprecated":false},{"title":"/v2/storages/{storageId}/eventstore/roll","summary":"Roll Event Store","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partner-storages/paths/~1v2~1storages~1{storageid}~1eventstore~1roll/post","deprecated":false},{"title":"/v4/storages/{storageId}/sharingscopes","summary":"List Sharing Scopes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/get","deprecated":false},{"title":"/v4/storages/{storageId}/sharingscopes","summary":"Create Sharing Scope","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes/post","deprecated":false},{"title":"/v4/storages/{storageId}/sharingscopes/delete","summary":"Delete Sharing Scopes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partner-storages/paths/~1v4~1storages~1{storageid}~1sharingscopes~1delete/post","deprecated":false},{"title":"/storages/{storageId}/clear","summary":"Clear Storage","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partner-storages/paths/~1storages~1{storageid}~1clear/post","deprecated":false},{"title":"/storages/{storageId}/datasources","summary":"Create Data Source","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources/post","deprecated":false},{"title":"/storages/{storageId}/datasources/{dataSourceId}","summary":"Update Data Source","prefix":{"name":"put","color":"put"},"badges":[],"link":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}/put","deprecated":false},{"title":"/storages/{storageId}/datasources/{dataSourceId}","summary":"Delete Data Source","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}/delete","deprecated":false},{"title":"/storages/{storageId}/datasources/{dataSourceId}/clear","summary":"Clear Data Source","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1clear/post","deprecated":false},{"title":"/storages/{storageId}/datasources/{dataSourceId}/copy","summary":"Copy Data Source","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1copy/post","deprecated":false},{"title":"/storages/{storageId}/datasources/{dataSourceId}/copy/{jobId}","summary":"Poll Copy Data Source Job Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources~1{datasourceid}~1copy~1{jobid}/get","deprecated":false},{"title":"/v2/updatemonitors/referencedatasources","summary":"List Update Monitors' Data Sources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-partner-storages/paths/~1v2~1updatemonitors~1referencedatasources/get","deprecated":false},{"title":"/storages/{storageId}/datasources","summary":"Update Data Sources","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/business-partner-storages/paths/~1storages~1{storageid}~1datasources/put","deprecated":true},{"title":"/updatemonitors/datasources","summary":"List Update Monitors' Data Sources","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/business-partner-storages/paths/~1updatemonitors~1datasources/get","deprecated":true}]}]}]}]}},{"type":"group","label":"Business Partners","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners","items":[{"label":"List Business Partners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners/get","metadata":{"seo":{"title":"List Business Partners","description":"Read a page of business partners from the storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Business Partners","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Business Partners","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 business partners from the storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startAfter","in":"query","schemaId":"schema_1","description":"Only items with an ID greater than the given one will be retrieved.\n\nWhen nextStartAfter provided in the response, should be used instead of the ID\nas an indicator for a next page.\n"},{"name":"limit","in":"query","schemaId":"schema_2","description":"Number of items to be returned on the page."},{"name":"dataSource","in":"query","schemaId":"schema_33","description":"Data Source (name or ID) used to filter the result of Business Partners returned."},{"name":"countryCode","in":"query","schemaId":"schema_34","description":"Country code (ISO 3166-1 alpha-2) used to filter the result of business partners returned."},{"name":"hasRawData","in":"query","schemaId":"schema_35","description":"Flag to filter result of business partners based on the existence of the record attribute (raw data)."},{"name":"updateMonitoring","in":"query","schemaId":"schema_36","description":"Flag to filter business partners by the value of updateMonitoring attribute."},{"name":"modifiedBefore","in":"query","schemaId":"schema_9","description":"Return entries which were modified before given data. The given date should support ISO-8601 representation."},{"name":"modifiedAfter","in":"query","schemaId":"schema_9","description":"Return entries which were modified after given data. The given date should support ISO-8601 representation."},{"name":"businessPartnerId","in":"query","schemaId":"schema_12","description":"Business Partner IDs which should be filtered."},{"name":"externalId","in":"query","schemaId":"schema_37","description":"Business Partner externalIDs."},{"name":"sharingStatus","in":"query","schemaId":"schema_38","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Sharing Status which should be filtered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sharing Statuses which can be filtered out:"},"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":"UNDER_CONSIDERATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNDISCLOSED_RECORD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MISSING_INFORMATION_FOR_LINKAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERRONEOUS_INFORMATION_FOR_LINKAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERRONEOUS_RECORD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_LINKAGE_DECISION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESS_ISSUE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHARED_WITH_NO_MATCH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHARED_WITH_CONFIDENT_MATCH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHARED_WITH_NO_MATCH_BY_REVIEW"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHARED_BY_REVIEW"},"children":[]}]}]}]}]},{"name":"featuresOn","in":"query","schemaId":"schema_39","description":"Features to be activated."},{"name":"featuresOff","in":"query","schemaId":"schema_40","description":"Features to be deactivated."},{"name":"validationLogResultStatus","in":"query","schemaId":"schema_41","description":"Violation level of validation result."},{"name":"validationSharingLogResultStatus","in":"query","schemaId":"schema_41","description":"Violation level of sharing validation result."},{"name":"curationLogResultStatus","in":"query","schemaId":"schema_42","description":"Curation log of curation result."},{"name":"reviewStatus","in":"query","schemaId":"schema_44","description":"Review status used for filtering the result data."},{"name":"fromJobProcessedAt","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the results which have one of the log result status -> jobProcessedAt after given date. The given date should support ISO-8601 representation."},"children":[]}]}]}]},{"name":"toJobProcessedAt","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the results which have one of the log result status -> jobProcessedAt before given date. The given date should support ISO-8601 representation."},"children":[]}]}]}]},{"name":"fromTriggerProcessedAt","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the results which have one of the log result status -> triggerProcessedAt after given date. The given date should support ISO-8601 representation."},"children":[]}]}]}]},{"name":"toTriggerProcessedAt","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the results which have one of the log result status -> triggerProcessedAt before given date. The given date should support ISO-8601 representation."},"children":[]}]}]}]},{"name":"fromProcessedAt","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the results which have one of the log result status -> processedAt after given date. The given date should support ISO-8601 representation."},"children":[]}]}]}]},{"name":"toProcessedAt","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the results which have one of the log result status -> processedAt before given date. The given date should support ISO-8601 representation."},"children":[]}]}]}]},{"name":"logResultTriggerType","in":"query","schemaId":"schema_45","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger type used for filtering the result which should match with at least one of any log result status -> triggerType fields."},"children":[]}]}]}]},{"name":"logResultTriggerProvenanceTechnicalKeys","in":"query","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provenance technical keys used for filtering the result which should match with at least one of any log result status -> triggerType fields."},"children":[]}]}]}]},{"name":"typeTechnicalKeys","in":"query","schemaId":"schema_47","description":"Business Partner type technical keys which should be filtered."},{"name":"tagValues","in":"query","schemaId":"schema_48","description":"Tag values that will be used to filter Business Partners. Values are connected with logical 'AND'."},{"name":"tagTypeTechnicalKey","in":"query","schemaId":"schema_49","description":"Type Technical Key of tags that are provided in 'tagValues' query param."},{"name":"curationProcessingStatus","in":"query","schemaId":"schema_50","description":"Curation's processing status technical key to filter by."},{"name":"validationProcessingStatus","in":"query","schemaId":"schema_50","description":"Validation's processing status technical key to filter by."}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/storages/{storageId}/businesspartners","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"schema_2"},{"name":"dataSource","in":"query","required":false,"schemaId":"schema_33"},{"name":"countryCode","in":"query","required":false,"schemaId":"schema_34"},{"name":"exceptCountryCode","in":"query","required":false,"schemaId":"schema_34"},{"name":"hasRawData","in":"query","required":false,"example":"false","schemaId":"schema_35"},{"name":"updateMonitoring","in":"query","required":false,"example":"true","schemaId":"schema_36"},{"name":"modifiedBefore","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"modifiedAfter","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"businessPartnerId","in":"query","required":false,"schemaId":"schema_12"},{"name":"externalId","in":"query","required":false,"schemaId":"schema_37"},{"name":"sharingStatus","in":"query","required":false,"schemaId":"schema_38"},{"name":"featuresOn","in":"query","required":false,"schemaId":"schema_39"},{"name":"featuresOff","in":"query","schemaId":"schema_40"},{"name":"validationLogResultStatus","in":"query","required":false,"schemaId":"schema_41"},{"name":"validationSharingLogResultStatus","in":"query","required":false,"schemaId":"schema_41"},{"name":"curationLogResultStatus","in":"query","required":false,"schemaId":"schema_42"},{"name":"query","in":"query","required":false,"example":"n/a","schemaId":"schema_43"},{"name":"reviewStatus","in":"query","required":false,"example":"REVIEWED","schemaId":"components/schemas/ReviewStatusParam"},{"name":"fromJobProcessedAt","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"toJobProcessedAt","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"fromTriggerProcessedAt","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"toTriggerProcessedAt","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"fromProcessedAt","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"toProcessedAt","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"logResultTriggerType","in":"query","required":false,"schemaId":"schema_45"},{"name":"logResultTriggerProvenanceTechnicalKeys","in":"query","required":false,"schemaId":"schema_46"},{"name":"typeTechnicalKeys","in":"query","required":false,"schemaId":"schema_47"},{"name":"tagValues","in":"query","required":false,"schemaId":"schema_48"},{"name":"tagTypeTechnicalKey","in":"query","required":false,"example":"WAREHOUSE","schemaId":"components/schemas/TagTypeTechnicalKey"},{"name":"curationProcessingStatus","in":"query","required":false,"example":"IN_PROGRESS","schemaId":"components/schemas/ProcessingStatusTechnicalKeyEnum"},{"name":"validationProcessingStatus","in":"query","required":false,"example":"IN_PROGRESS","schemaId":"components/schemas/ProcessingStatusTechnicalKeyEnum"},{"name":"sort","in":"query","required":false,"example":"-lastModifiedAt","schemaId":"components/schemas/BusinessPartnersSort"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v4/storages/{storageId}/businesspartners","href":"business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners/get","summary":"List Business Partners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/BusinessPartnerPage"}},"schemaId":"components/schemas/BusinessPartnerPage"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerPage"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners/get"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/businesspartners"},{"label":"Upsert Business Partners","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners/put","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners/put","metadata":{"seo":{"title":"Upsert Business Partners","description":"Upsert Business Partners in a Business Partner storage in batches. Maximum of 1000 Business Partners are allowed per batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upsert Business Partners","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert Business Partners","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":"Upsert Business Partners in a Business Partner storage in batches. Maximum of 1000 Business Partners are allowed per batch."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no data source (via field: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is provided and the storage has only one, then this data source will be used/set. Other options are to provide an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"existing data source in the request, which will then be taken for all the Business Partner or to provide a data source for each Business Partner"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"individually."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the following cases an API error will be thrown:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"given data source in the Request or the BusinessPartner is unknown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no data source given and more than one data source is attached to the storage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To start upserting Business Partners into a storage, use the following request."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"PUT https://api.corporate-data-league.ch/data-exchange/rest/v4/storages/{YOUR STORAGE ID}/businesspartners\n{\n  \"dataSource\": \"{YOUR DATA SOURCE}\",\n  \"featuresOn\": [\"UPSERT_BY_EXTERNAL_ID\"],\n  \"businessPartners\": [\n   {\n     \"externalId\": \"123\",\n     \"record\": \"{\\\"MyId\\\":\\\"123\\\", \\\"City\\\":\\\"St. Gallen\\\"}\"\n   }]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PUT https://api.corporate-data-league.ch/data-exchange/rest/v4/storages/{YOUR STORAGE ID}/businesspartners\n{\n  \"dataSource\": \"{YOUR DATA SOURCE}\",\n  \"featuresOn\": [\"UPSERT_BY_EXTERNAL_ID\"],\n  \"businessPartners\": [\n   {\n     \"externalId\": \"123\",\n     \"record\": \"{\\\"MyId\\\":\\\"123\\\", \\\"City\\\":\\\"St. Gallen\\\"}\"\n   }]\n}\n"},"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n   \"numberOfAccepted\": \"1\",\n   \"numberOfFailed\": \"0\",\n}\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n   \"numberOfAccepted\": \"1\",\n   \"numberOfFailed\": \"0\",\n}\n\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upserting Business Partners enables automated data transformation from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to the Business Partner model."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It requires a Data Mapper Definition and assigned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataMapperDefinitionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of a data source Business Partner is being upserted to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field requires stringified JSON. 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.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To enable automated data transformation, one of the following features is required:"},"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":"TRANSFORM_RECORD - synchronous transformation, limited for batch size <= 250,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENABLE_ASYNC - asynchronous transformation. Enabled by default when TRANSFORM_RECORD is not requested."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated data transformation can be executed together with the UPSERT_BY_EXTERNAL_ID feature,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but it requires to provide external ID as a field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a Business Partner,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is preserved during the transformation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there is no name typed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataModel:CDQ/Business_Partner/Name/Name_Type/LOCAL"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCAL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessPartner.names"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and exists any name with empty type or not filled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type.technicalKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it becomes name of type LOCAL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warn: in order to support multiple data sources, include dataSource into the request, either"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in $.dataSource or $.businessPartners[*].dataSource. Otherwise, multiple data sources with no selection"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of data source will lead to \"No DataSource was provided for the given Business Partners and the storage"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has more than one attached to it.\" exception."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner and Address fields have defined array size limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max array size"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners[*].names"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners[*].identifiers"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners[*].categories"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners[*].addresses"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners[*].relations"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners[*].types"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners[*].bankAccounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"50"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners[*].profile.websites"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners[*].profile.classifications"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners[*].profile.contactEmails"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners[*].profile.phoneNumbers"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners["},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].addresses["},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].contexts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"100"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners["},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].addresses["},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].administrativeAreas"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners["},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].addresses["},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].postCodes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners["},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].addresses["},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].localities"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners["},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].addresses["},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].thoroughfares"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners["},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].addresses["},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].premises"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners["},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].addresses["},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].postalDeliveryPoints"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$.businessPartners["},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].addresses["},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"].types"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnersUpsertRequest","exampleIds":["paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example1","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example2","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example3","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example4"]}},"schemaId":"components/schemas/BusinessPartnersUpsertRequest","exampleIds":["paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example1","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example2","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example3","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example4"],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody","description":"Parameters for Business Partners Upsert."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/storages/{storageId}/businesspartners","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnersUpsertRequest","exampleIds":["paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example1","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example2","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example3","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example4"]}},"responseCodes":["200"],"pointer":"/v4/storages/{storageId}/businesspartners","href":"business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners/put","summary":"Upsert Business Partners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnersUpsertRequest","exampleIds":["paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example1","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example2","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example3","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example4"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnersUpsertRequest","exampleIds":["paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example1","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example2","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example3","paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example4"]}},"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/BusinessPartnersUpsertResult"}},"schemaId":"components/schemas/BusinessPartnersUpsertResult"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnersUpsertResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnersUpsertResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners/put"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/businesspartners"},{"label":"Read Business Partner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{id}/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{id}/get","metadata":{"seo":{"title":"Read Business Partner","description":"Read Business Partner by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Read Business Partner","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read Business Partner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read Business Partner 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_32","description":"Unique identifier of the Business Partner.","required":true},{"name":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"featureOn","in":"query","schemaId":"schema_53","description":"Features to be used during the read Business Partner."},{"name":"featureOff","in":"query","schemaId":"schema_54","description":"Features to be deactivated during the read Business Partner."}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/storages/{storageId}/businesspartners/{id}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"63e635235c06b7396330fe40","schemaId":"components/schemas/BusinessPartnerId"},{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[{"name":"featureOn","in":"query","required":false,"schemaId":"schema_53"},{"name":"featureOff","in":"query","required":false,"schemaId":"schema_54"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/storages/{storageId}/businesspartners/{id}","href":"business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{id}/get","summary":"Read Business Partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/BusinessPartner"}},"schemaId":"components/schemas/BusinessPartner"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartner","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartner"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{id}/get"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/businesspartners/{id}"},{"label":"List Business Partners Updates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1updates/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1updates/get","metadata":{"seo":{"title":"List Business Partners Updates","description":"Example Response:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Business Partners Updates","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1updates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Business Partners Updates","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":"Example Response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"values\": [\n    {\n      \"businessPartner\": {\n        \"id\": \"123456\",\n        \"externalId\": \"EXTID-86\",\n        ...,\n        \"record\": \"{<JSON>}\"\n      },\n      \"provenances\": [\n        {\n          \"name\": \"Supplier Gateway\",\n          \"technicalKey\": \"SGW\"\n        }\n      ],\n      \"changeSet\": [\n        {\n          \"modifiedAt\": \"2007-08-31T16:47\",\n          \"propertyChanges\": [\n            {\n              \"newContent\": \"AAB\",\n              \"previousContent\": \"XYZ\",\n              \"changeType\": \"MODIFIED\",\n              \"changeClassification\": \"MAJOR\",\n              \"provenance\": {\n                \"name\": \"Supplier Gateway\",\n                \"technicalKey\": \"SGW\"\n              },\n              \"property\": {\n                \"name\": \"Minority Indicator Value\",\n                \"contentSelector\": \"$.profile.minorityIndicator.value\",\n                \"technicalKey\": \"MINORITY_INDICATOR_VALUE\"\n                \"parentConcept\": {\n                  \"name\": \"Minority Indicator\",\n                  \"technicalKey\": \"MINORITY_INDICATOR\"\n                }\n              }\n            }\n          ],\n          \"provenances\": [\n            {\n              \"name\": \"Supplier Gateway\",\n              \"technicalKey\": \"SGW\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"values\": [\n    {\n      \"businessPartner\": {\n        \"id\": \"123456\",\n        \"externalId\": \"EXTID-86\",\n        ...,\n        \"record\": \"{<JSON>}\"\n      },\n      \"provenances\": [\n        {\n          \"name\": \"Supplier Gateway\",\n          \"technicalKey\": \"SGW\"\n        }\n      ],\n      \"changeSet\": [\n        {\n          \"modifiedAt\": \"2007-08-31T16:47\",\n          \"propertyChanges\": [\n            {\n              \"newContent\": \"AAB\",\n              \"previousContent\": \"XYZ\",\n              \"changeType\": \"MODIFIED\",\n              \"changeClassification\": \"MAJOR\",\n              \"provenance\": {\n                \"name\": \"Supplier Gateway\",\n                \"technicalKey\": \"SGW\"\n              },\n              \"property\": {\n                \"name\": \"Minority Indicator Value\",\n                \"contentSelector\": \"$.profile.minorityIndicator.value\",\n                \"technicalKey\": \"MINORITY_INDICATOR_VALUE\"\n                \"parentConcept\": {\n                  \"name\": \"Minority Indicator\",\n                  \"technicalKey\": \"MINORITY_INDICATOR\"\n                }\n              }\n            }\n          ],\n          \"provenances\": [\n            {\n              \"name\": \"Supplier Gateway\",\n              \"technicalKey\": \"SGW\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In typed concepts, like Name, Identifier or Premise, type.technicalKey and any non-empty property are required to be filled in order to monitor updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following limits for updates calculated per concepts is applied:"},"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":"$.addresses.administrativeAreas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": up to 5 sub concept levels supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses.localities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": up to 5 sub concept levels supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses.postCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": up to 3 sub concepts supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses.postalDeliveryPoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": up to 3 sub concepts supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses.thoroughfares"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": up to 3 sub concepts supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses.premises"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": up to 6 sub concepts supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max limit allowed is 1000."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1updates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startAfter","in":"query","schemaId":"schema_1","description":"Only items with an ID greater than the given one will be retrieved.\n\nWhen nextStartAfter provided in the response, should be used instead of the ID\nas an indicator for a next page.\n"},{"name":"limit","in":"query","schemaId":"schema_2","description":"Number of items to be returned on the page."},{"name":"businessPartnerIds","in":"query","schemaId":"schema_55","description":"Only show updates for listed Business Partner IDs.\nWhen providing list of Business Partner IDs, limit is ignored to provide full page.\n"},{"name":"externalIds","in":"query","schemaId":"schema_56","description":"Filter updates by Business Partner externalId, limit is ignored to provide full page.\nWhen used with the businessPartnerIds parameter, \nonly business partners that have one of the specified externalIds AND one of the specified businessPartnerIds will be returned.\n"},{"name":"affectedConcepts","in":"query","schemaId":"schema_57","description":"Only show updates which affected these concepts."},{"name":"affectedProperties","in":"query","schemaId":"schema_58","description":"Only show updates which affected these properties."},{"name":"provenanceTechnicalKeys","in":"query","schemaId":"schema_59","description":"Show updates for selected provenances by technical keys."},{"name":"exceptProvenanceTechnicalKeys","in":"query","schemaId":"schema_59","description":"Show updates for all provenances except provided by technical keys. \nBy default, includes ORGANIZATION if not present on provenanceTechnicalKeys list.\n"},{"name":"from","in":"query","schemaId":"schema_9","description":"Only show updates which have been modified after this date (ISO 8601).\nDefault is to show the 'last seven days' and farthest in the past is 'since three month'.\n"},{"name":"dataSource","in":"query","schemaId":"schema_60","description":"Filter for a data source (name or id)."},{"name":"countryShortName","in":"query","schemaId":"schema_61","description":"Filter for countries."},{"name":"changeType","in":"query","schemaId":"schema_62","description":"Filter for change types."},{"name":"changeClassification","in":"query","schemaId":"schema_63","description":"Filter by change classifications."},{"name":"featuresOn","in":"query","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features to be used during the read Business Partner updates:"},"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":"APPLY_AUGMENTATION_DECISIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Applies accepted augmentation decisions from Decision Log to Business Partners in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.values[*].storageBusinessPartner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if any decisions found. Requires FETCH_STORAGE_BUSINESS_PARTNER feature. By default, deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLY_CURATION_DECISIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deprecated, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLY_AUGMENTATION_DECISIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Works the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLY_AUGMENTATION_DECISIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default, deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FETCH_STORAGE_BUSINESS_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fetch Business Partner from a storage and set in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.values[*].storageBusinessPartner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default, deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FETCH_STORAGE_BUSINESS_PARTNER_WITH_RELATIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fetch Business Partner from a storage and set in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.values[*].storageBusinessPartner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" including relations. By default, deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER_OF_TOTAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Allows to switch fetching the total number of records to improve performance. By default, turned on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_BUSINESS_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Show Business Partner merged out of updates in `$.values[*].businessPartner. By default, deactivated."},"children":[]}]}]}]}]},{"name":"featuresOff","in":"query","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features to be used during the read Business Partner updates:"},"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":"APPLY_AUGMENTATION_DECISIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Applies accepted augmentation decisions from Decision Log to Business Partners in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.values[*].storageBusinessPartner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if any decisions found. Requires FETCH_STORAGE_BUSINESS_PARTNER feature. By default, deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLY_CURATION_DECISIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deprecated, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLY_AUGMENTATION_DECISIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Works the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLY_AUGMENTATION_DECISIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default, deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FETCH_STORAGE_BUSINESS_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fetch Business Partner from a storage and set in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.values[*].storageBusinessPartner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default, deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FETCH_STORAGE_BUSINESS_PARTNER_WITH_RELATIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fetch Business Partner from a storage and set in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.values[*].storageBusinessPartner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" including relations. By default, deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER_OF_TOTAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Allows to switch fetching the total number of records to improve performance. By default, turned on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_BUSINESS_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Show Business Partner merged out of updates in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.values[*].businessPartner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default, deactivated."},"children":[]}]}]}]}]}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1updates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/storages/{storageId}/businesspartners/updates","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"schema_2"},{"name":"businessPartnerIds","in":"query","required":false,"schemaId":"schema_55"},{"name":"externalIds","in":"query","required":false,"schemaId":"schema_56"},{"name":"affectedConcepts","in":"query","required":false,"schemaId":"schema_57"},{"name":"affectedProperties","in":"query","required":false,"schemaId":"schema_58"},{"name":"provenanceTechnicalKeys","in":"query","required":false,"schemaId":"schema_59"},{"name":"exceptProvenanceTechnicalKeys","in":"query","required":false,"schemaId":"schema_59"},{"name":"from","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"dataSource","in":"query","required":false,"schemaId":"schema_60"},{"name":"countryShortName","in":"query","required":false,"schemaId":"schema_61"},{"name":"changeType","in":"query","required":false,"example":"ADDED","schemaId":"schema_62"},{"name":"changeClassification","in":"query","required":false,"example":"TRIVIAL","schemaId":"components/schemas/PropertyChangeClassificationParam"},{"name":"featuresOn","in":"query","required":false,"schemaId":"schema_64"},{"name":"featuresOff","in":"query","required":false,"schemaId":"schema_64"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/storages/{storageId}/businesspartners/updates","href":"business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1updates/get","summary":"List Business Partners Updates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/BusinessPartnerUpdatePage"}},"schemaId":"components/schemas/BusinessPartnerUpdatePage"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1updates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerUpdatePage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerUpdatePage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1updates/get"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/businesspartners/updates"},{"label":"Lookup Business Partner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1lookup/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1lookup/post","metadata":{"seo":{"title":"Lookup Business Partner","description":"Lookup a Business Partner in provided storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Lookup Business Partner","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1lookup/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup Business Partner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lookup a Business Partner in provided storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1lookup/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerLookupRequest"}},"schemaId":"components/schemas/BusinessPartnerLookupRequest","pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1lookup/post/requestBody","description":"cmd"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/storages/{storageId}/businesspartners/lookup","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnerLookupRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v4/storages/{storageId}/businesspartners/lookup","href":"business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1lookup/post","summary":"Lookup Business Partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnerLookupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerLookupRequest"}},"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/BusinessPartnerLookupResult"}},"schemaId":"components/schemas/BusinessPartnerLookupResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1lookup/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerLookupResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerLookupResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1lookup/post"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/businesspartners/lookup"},{"label":"Fetch Business Partner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1fetch/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1fetch/post","metadata":{"seo":{"title":"Fetch Business Partner","description":"Fetch a Business Partner from this storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Fetch Business Partner","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1fetch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch Business Partner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch a Business Partner from this storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1fetch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FetchBusinessPartnerRequest"}},"schemaId":"components/schemas/FetchBusinessPartnerRequest","pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1fetch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/storages/{storageId}/businesspartners/fetch","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FetchBusinessPartnerRequest"}},"responseCodes":["200","401","403"],"pointer":"/v4/storages/{storageId}/businesspartners/fetch","href":"business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1fetch/post","summary":"Fetch Business Partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/FetchBusinessPartnerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FetchBusinessPartnerRequest"}},"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/FetchBusinessPartnerResult"}},"schemaId":"components/schemas/FetchBusinessPartnerResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1fetch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FetchBusinessPartnerResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FetchBusinessPartnerResult"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1fetch/post"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/businesspartners/fetch"},{"label":"Create Business Partner Tags","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{businesspartnerid}~1profile~1tags/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{businesspartnerid}~1profile~1tags/post","metadata":{"seo":{"title":"Create Business Partner Tags","description":"Allows the creation of Business Partner tags. The tags are created in the Business Partner profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create Business Partner Tags","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{businessPartnerId}~1profile~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Business Partner Tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the creation of Business Partner tags. The tags are created in the Business Partner profile."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true},{"name":"businessPartnerId","in":"path","schemaId":"schema_0","description":"Business Partner identifier within a storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{businessPartnerId}~1profile~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerTagCreates"}},"schemaId":"components/schemas/BusinessPartnerTagCreates","pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{businessPartnerId}~1profile~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"businessPartnerId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnerTagCreates"}},"responseCodes":["200","400"],"pointer":"/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags","href":"business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{businesspartnerid}~1profile~1tags/post","summary":"Create Business Partner Tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnerTagCreates","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerTagCreates"}},"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/BusinessPartnerTagCreateResults"}},"schemaId":"components/schemas/BusinessPartnerTagCreateResults"},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{businessPartnerId}~1profile~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerTagCreateResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerTagCreateResults"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{businesspartnerid}~1profile~1tags/post"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags"},{"label":"Delete Business Partner Tags","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{businesspartnerid}~1profile~1tags~1delete/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{businesspartnerid}~1profile~1tags~1delete/post","metadata":{"seo":{"title":"Delete Business Partner Tags","description":"Allows the deletion of Business Partner tags. The tags are deleted from the Business Partner profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete Business Partner Tags","isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{businessPartnerId}~1profile~1tags~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Business Partner Tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the deletion of Business Partner tags. The tags are deleted from the Business Partner profile."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true},{"name":"businessPartnerId","in":"path","schemaId":"schema_0","description":"Business Partner identifier within a storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{businessPartnerId}~1profile~1tags~1delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerTagDeletes"}},"schemaId":"components/schemas/BusinessPartnerTagDeletes","pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{businessPartnerId}~1profile~1tags~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags/delete","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"businessPartnerId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnerTagDeletes"}},"responseCodes":["200","400"],"pointer":"/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags/delete","href":"business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{businesspartnerid}~1profile~1tags~1delete/post","summary":"Delete Business Partner Tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnerTagDeletes","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnerTagDeletes"}},"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/BusinessPartnerTagDeleteResults"}},"schemaId":"components/schemas/BusinessPartnerTagDeleteResults"},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1{businessPartnerId}~1profile~1tags~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerTagDeleteResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerTagDeleteResults"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{businesspartnerid}~1profile~1tags~1delete/post"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags/delete"},{"label":"Delete Business Partners","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1storages~1{storageid}~1businesspartners~1delete/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1storages~1{storageid}~1businesspartners~1delete/post","metadata":{"seo":{"title":"Delete Business Partners","description":"Delete batches of Business Partners by ID or a combination of DataSource and External ID. Maximum of 1000 Business Partners are allowed per batch. In case only a data source is provided in the request, all Business Partners related to this data source will be deleted, but the data source itself will not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete Business Partners","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}~1businesspartners~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Business Partners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete batches of Business Partners by ID or a combination of DataSource and External ID. Maximum of 1000 Business Partners are allowed per batch.\nIn case only a data source is provided in the request, all Business Partners related to this data source will be deleted, but the data source itself\nwill not be deleted.\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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1storages~1{storageId}~1businesspartners~1delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnersDeleteRequest","exampleIds":["paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example1","paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example2"]}},"schemaId":"components/schemas/BusinessPartnersDeleteRequest","exampleIds":["paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example1","paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example2"],"pointer":"/paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody","description":"cmd"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/storages/{storageId}/businesspartners/delete","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnersDeleteRequest","exampleIds":["paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example1","paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example2"]}},"responseCodes":["200","201","401","403","404"],"pointer":"/storages/{storageId}/businesspartners/delete","href":"business-partners/paths/~1storages~1{storageid}~1businesspartners~1delete/post","summary":"Delete Business Partners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnersDeleteRequest","exampleIds":["paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example1","paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example2"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnersDeleteRequest","exampleIds":["paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example1","paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example2"]}},"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/BusinessPartnersDeleteResult"}},"schemaId":"components/schemas/BusinessPartnersDeleteResult"},{"code":"201","description":"Created"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1storages~1{storageId}~1businesspartners~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnersDeleteResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnersDeleteResult"}}},{"code":"201"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1storages~1{storageid}~1businesspartners~1delete/post"}],"panels":[]}]},"httpPath":"/storages/{storageId}/businesspartners/delete"},{"label":"Toggle Business Partners Update Monitoring","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1storages~1{storageid}~1businesspartners~1toggleupdatemonitoring/put","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1storages~1{storageid}~1businesspartners~1toggleupdatemonitoring/put","metadata":{"seo":{"title":"Toggle Business Partners Update Monitoring","description":"To toggle update monitoring on multiple BusinessPartners, the permission can be changedvia a list of Business Partners, identified by their ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Toggle Business Partners Update Monitoring","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}~1businesspartners~1toggleUpdateMonitoring/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Toggle Business Partners Update Monitoring","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 toggle update monitoring on multiple BusinessPartners, the permission can be changed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via a list of Business Partners, identified by their ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the job is finished, the following actions are taken for Business Partners which match the businessPartnerIds criteria:"},"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":"businessPartner.updateMonitoring fields takes a value of ToggleUpdateMonitoringJobRequest#enable"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if enable is true then:"},"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":"an attempt is taken to find Business Partner in all configured "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/data-monitors/paths/~1v2~1storages~1%7Bstorageid%7D~1datamonitors~1%7Bdatamonitorid%7D/put"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update monitors for non-commercial reference data sources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and links are created if matches are found via defined linkage strategies"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if the storage has UPDATES feature activated, updates for linked Business Partners from non-commercial reference data sources are propagated to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/business-partners/paths/~1v5~1storages~1%7Bstorageid%7D~1businesspartners~1updates/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if enable is false then:"},"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":"all existing links of a Business Partner to Business Partners in non-commercial reference data sources are removed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updates are no more propagated for this Business Partner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"linkage is not performed for any non-commercial reference data source"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For toggling a complete Data Source or for a certain Country of a Data Source,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"please go to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/business-partners/paths/~1jobs~1toggleupdatemonitoringjobs/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start Toggle Update Monitoring Job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1storages~1{storageId}~1businesspartners~1toggleUpdateMonitoring/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ToggleUpdateMonitoringRequest"}},"schemaId":"components/schemas/ToggleUpdateMonitoringRequest","pointer":"/paths/~1storages~1{storageId}~1businesspartners~1toggleUpdateMonitoring/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/storages/{storageId}/businesspartners/toggleUpdateMonitoring","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ToggleUpdateMonitoringRequest"}},"responseCodes":["204"],"pointer":"/storages/{storageId}/businesspartners/toggleUpdateMonitoring","href":"business-partners/paths/~1storages~1{storageid}~1businesspartners~1toggleupdatemonitoring/put","summary":"Toggle Business Partners Update Monitoring"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/ToggleUpdateMonitoringRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ToggleUpdateMonitoringRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK"}],"pointer":"/paths/~1storages~1{storageId}~1businesspartners~1toggleUpdateMonitoring/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1storages~1{storageid}~1businesspartners~1toggleupdatemonitoring/put"}],"panels":[]}]},"httpPath":"/storages/{storageId}/businesspartners/toggleUpdateMonitoring"},{"label":"Start a Toggle Update Monitoring Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1jobs~1toggleupdatemonitoringjobs/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1jobs~1toggleupdatemonitoringjobs/post","metadata":{"seo":{"title":"Start a Toggle Update Monitoring Job","description":"To toggle update monitoring on multiple BusinessPartners, the permission can be changed in two ways:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Start a Toggle Update Monitoring Job","isWebhook":false,"pointer":"/paths/~1jobs~1toggleUpdateMonitoringJobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start a Toggle Update Monitoring Job","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 toggle update monitoring on multiple BusinessPartners, the permission can be changed in two ways:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A complete Data Source identified by the parameter 'dataSourceId'"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Or for a certain Country of a Data Source. This requires both parameters 'dataSourceId' and 'countryShortName' to be set"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the job is finished, the following actions are taken for Business Partners which match the dataSourceId and countryShortName criteria:"},"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":"businessPartner.updateMonitoring fields takes a value of ToggleUpdateMonitoringJobRequest#enable"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if enable is true then:"},"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":"an attempt is taken to find Business Partner in all configured "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/data-monitors/paths/~1v2~1storages~1%7Bstorageid%7D~1datamonitors~1%7Bdatamonitorid%7D/put"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update monitors for non-commercial reference data sources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and links are created if matches are found via defined linkage strategies"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if the storage has UPDATES feature activated, updates for linked Business Partners from non-commercial reference data sources are propagated to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/business-partners/paths/~1v5~1storages~1%7Bstorageid%7D~1businesspartners~1updates/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Updates"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if enable is false then:"},"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":"all existing links of a Business Partner to Business Partners in non-commercial reference data sources are removed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updates are no more propagated for this Business Partner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"linkage is not performed for any non-commercial reference data source"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For toggling via a list of Business Partners, identified by their ID, please go to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/business-partners/paths/~1jobs~1toggleupdatemonitoringjobs/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Toggle Update Monitoring of Business Partners"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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/ToggleUpdateMonitoringJobRequest"}},"schemaId":"components/schemas/ToggleUpdateMonitoringJobRequest","pointer":"/paths/~1jobs~1toggleUpdateMonitoringJobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/jobs/toggleUpdateMonitoringJobs","servers":[{"url":"https://api.cdq.com/data-exchange/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/ToggleUpdateMonitoringJobRequest"}},"responseCodes":["200","400"],"pointer":"/jobs/toggleUpdateMonitoringJobs","href":"business-partners/paths/~1jobs~1toggleupdatemonitoringjobs/post","summary":"Start a Toggle Update Monitoring Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/ToggleUpdateMonitoringJobRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ToggleUpdateMonitoringJobRequest"}},"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/ToggleUpdateMonitoringJob"}},"schemaId":"components/schemas/ToggleUpdateMonitoringJob"},{"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/~1jobs~1toggleUpdateMonitoringJobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ToggleUpdateMonitoringJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ToggleUpdateMonitoringJob"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1jobs~1toggleupdatemonitoringjobs/post"}],"panels":[]}]},"httpPath":"/jobs/toggleUpdateMonitoringJobs"},{"label":"Poll Toggle Update Monitoring Job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1jobs~1toggleupdatemonitoringjobs~1{jobid}/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1jobs~1toggleupdatemonitoringjobs~1{jobid}/get","metadata":{"seo":{"title":"Poll Toggle Update Monitoring Job","description":"Poll endpoint for a job created in POST toggleUpdateMonitoringJobs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Poll Toggle Update Monitoring Job","isWebhook":false,"pointer":"/paths/~1jobs~1toggleUpdateMonitoringJobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll Toggle Update Monitoring Job","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":"Poll endpoint for a job created in POST "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toggleUpdateMonitoringJobs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"jobId","in":"path","schemaId":"schema_29","description":"Unique identifier of a job.","required":true}],"pointer":"/paths/~1jobs~1toggleUpdateMonitoringJobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/jobs/toggleUpdateMonitoringJobs/{jobId}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"example":"35f23c03-1c22-45fe-9484-3ffe769325de","schemaId":"components/schemas/JobId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/jobs/toggleUpdateMonitoringJobs/{jobId}","href":"business-partners/paths/~1jobs~1toggleupdatemonitoringjobs~1{jobid}/get","summary":"Poll Toggle Update Monitoring Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/ToggleUpdateMonitoringJobResult"}},"schemaId":"components/schemas/ToggleUpdateMonitoringJobResult"}],"pointer":"/paths/~1jobs~1toggleUpdateMonitoringJobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ToggleUpdateMonitoringJobResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ToggleUpdateMonitoringJobResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1jobs~1toggleupdatemonitoringjobs~1{jobid}/get"}],"panels":[]}]},"httpPath":"/jobs/toggleUpdateMonitoringJobs/{jobId}"},{"label":"Update Disclosure","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v3~1storages~1{storageid}~1businesspartners~1updatedisclosure/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v3~1storages~1{storageid}~1businesspartners~1updatedisclosure/post","metadata":{"seo":{"title":"Update Disclosure","description":"To un-/disclose multiple BusinessPartners, the disclosure can be changed in three ways:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Disclosure","isWebhook":false,"pointer":"/paths/~1v3~1storages~1{storageId}~1businesspartners~1updateDisclosure/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Disclosure","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 un-/disclose multiple BusinessPartners, the disclosure can be changed in three ways:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A complete data source identified by the parameter 'dataSourceId' (deprecated - use Sharing Scopes instead. Still applicable, but can be overwritten by Sharing Scopes)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Or for a certain country of a data source. This requires both parameters 'dataSourceId' and 'countryCode' to be set (deprecated - use Sharing Scopes instead. Still applicable, but can be overwritten by Sharing Scopes)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Or a list of Business Partners, identified by their ID. The other parameters should be left empty. Note: disclosure set via Business Partner ID can be overwritten by creation or deletion of a Sharing Scope."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any other combination may result in a Bad Request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more details, you can read about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/business-partner-storages/paths/~1v4~1storages~1%7Bstorageid%7D~1sharingscopes/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sharing Scopes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v3~1storages~1{storageId}~1businesspartners~1updateDisclosure/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDisclosureRequest"}},"schemaId":"components/schemas/UpdateDisclosureRequest","pointer":"/paths/~1v3~1storages~1{storageId}~1businesspartners~1updateDisclosure/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/storages/{storageId}/businesspartners/updateDisclosure","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateDisclosureRequest"}},"responseCodes":["200"],"pointer":"/v3/storages/{storageId}/businesspartners/updateDisclosure","href":"business-partners/paths/~1v3~1storages~1{storageid}~1businesspartners~1updatedisclosure/post","summary":"Update Disclosure"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/UpdateDisclosureRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDisclosureRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v3~1storages~1{storageId}~1businesspartners~1updateDisclosure/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1v3~1storages~1{storageid}~1businesspartners~1updatedisclosure/post"}],"panels":[]}]},"httpPath":"/v3/storages/{storageId}/businesspartners/updateDisclosure"},{"label":"Random Business Partners","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1random/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1random/get","metadata":{"seo":{"title":"Random Business Partners","description":"Get random Business Partners from this storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Random Business Partners","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1random/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Random Business Partners","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get random Business Partners from this storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1random/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_65","description":"Number of items to be returned on the page."},{"name":"dataSource","in":"query","schemaId":"schema_6","description":"Data Source (name or ID) used to filter the result of Business Partners returned."},{"name":"countryCode","in":"query","schemaId":"schema_52","description":"Country code (ISO 3166-1 alpha-2) used to filter the result of business partners returned."},{"name":"modifiedBefore","in":"query","schemaId":"schema_9","description":"Return entries which were modified before given data. The given date should support ISO-8601 representation."},{"name":"modifiedAfter","in":"query","schemaId":"schema_9","description":"Return entries which were modified after given data. The given date should support ISO-8601 representation."},{"name":"featureOn","in":"query","schemaId":"schema_66","description":"Features to be used during the fetch Business Partner."},{"name":"featureOff","in":"query","schemaId":"schema_67","description":"Features to be excluded during the fetch Business Partner."}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1random/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/storages/{storageId}/businesspartners/random","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[{"name":"limit","in":"query","required":false,"example":"5","schemaId":"schema_65"},{"name":"dataSource","in":"query","required":false,"example":"\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"","schemaId":"components/schemas/BusinessPartnerDataSource"},{"name":"countryCode","in":"query","required":false,"example":"CH","schemaId":"components/schemas/CountryShortName"},{"name":"modifiedBefore","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"modifiedAfter","in":"query","required":false,"example":"2026-10-21T13:37:18Z","schemaId":"schema_9"},{"name":"featureOn","in":"query","required":false,"schemaId":"schema_66"},{"name":"featureOff","in":"query","required":false,"schemaId":"schema_67"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v4/storages/{storageId}/businesspartners/random","href":"business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1random/get","summary":"Random Business Partners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/BusinessPartnerRandomPage"}},"schemaId":"components/schemas/BusinessPartnerRandomPage"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v4~1storages~1{storageId}~1businesspartners~1random/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnerRandomPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnerRandomPage"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1random/get"}],"panels":[]}]},"httpPath":"/v4/storages/{storageId}/businesspartners/random"}],"content":{"contentType":"group","meta":{"name":"Business Partners"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Business Partners","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for creating, retrieving, updating, and deleting Business Partner records, as well as performing \nvarious operations such as lookup and upsert."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/storages/{storageId}/businesspartners","summary":"List Business Partners","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners/get","deprecated":false},{"title":"/v4/storages/{storageId}/businesspartners","summary":"Upsert Business Partners","prefix":{"name":"put","color":"put"},"badges":[],"link":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners/put","deprecated":false},{"title":"/v4/storages/{storageId}/businesspartners/{id}","summary":"Read Business Partner","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{id}/get","deprecated":false},{"title":"/v4/storages/{storageId}/businesspartners/updates","summary":"List Business Partners Updates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1updates/get","deprecated":false},{"title":"/v4/storages/{storageId}/businesspartners/lookup","summary":"Lookup Business Partner","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1lookup/post","deprecated":false},{"title":"/v4/storages/{storageId}/businesspartners/fetch","summary":"Fetch Business Partner","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1fetch/post","deprecated":false},{"title":"/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags","summary":"Create Business Partner Tags","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{businesspartnerid}~1profile~1tags/post","deprecated":false},{"title":"/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags/delete","summary":"Delete Business Partner Tags","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1{businesspartnerid}~1profile~1tags~1delete/post","deprecated":false},{"title":"/storages/{storageId}/businesspartners/delete","summary":"Delete Business Partners","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partners/paths/~1storages~1{storageid}~1businesspartners~1delete/post","deprecated":false},{"title":"/storages/{storageId}/businesspartners/toggleUpdateMonitoring","summary":"Toggle Business Partners Update Monitoring","prefix":{"name":"put","color":"put"},"badges":[],"link":"/business-partners/paths/~1storages~1{storageid}~1businesspartners~1toggleupdatemonitoring/put","deprecated":false},{"title":"/jobs/toggleUpdateMonitoringJobs","summary":"Start a Toggle Update Monitoring Job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partners/paths/~1jobs~1toggleupdatemonitoringjobs/post","deprecated":false},{"title":"/jobs/toggleUpdateMonitoringJobs/{jobId}","summary":"Poll Toggle Update Monitoring Job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-partners/paths/~1jobs~1toggleupdatemonitoringjobs~1{jobid}/get","deprecated":false},{"title":"/v3/storages/{storageId}/businesspartners/updateDisclosure","summary":"Update Disclosure","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-partners/paths/~1v3~1storages~1{storageid}~1businesspartners~1updatedisclosure/post","deprecated":false},{"title":"/v4/storages/{storageId}/businesspartners/random","summary":"Random Business Partners","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/business-partners/paths/~1v4~1storages~1{storageid}~1businesspartners~1random/get","deprecated":true}]}]}]}]}},{"type":"group","label":"Data Import","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-import","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-import","items":[{"label":"Start Import Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-import/paths/~1jobs~1importjobs/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-import/paths/~1jobs~1importjobs/post","metadata":{"seo":{"title":"Start Import Job","description":"To start importing a file into a storage, use the following request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Start Import Job","isWebhook":false,"pointer":"/paths/~1jobs~1importjobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start Import Job","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 a file into a storage, use the following request."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST https://api.corporate-data-league.ch/data-exchange/rest/jobs/importjobs\n  ?file=@{YOUR FILE}\n  ?storageId={YOUR STORAGE ID}\n  ?dataSource={YOUR DATASOURCE ID}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST https://api.corporate-data-league.ch/data-exchange/rest/jobs/importjobs\n  ?file=@{YOUR FILE}\n  ?storageId={YOUR STORAGE ID}\n  ?dataSource={YOUR DATASOURCE ID}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields (cells) in a file, that contain a special character (comma, semicolon, CR, LF, or double quote), must be \"escaped\" by enclosing them in double quotes. Header names can not contain any dot."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to successfully perform file upload use file upload for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" up to 10MB or Upload via Upload Request approach for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" larger than 10MB. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not allowed to be present together."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use one of the below instructions for your case:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File size < 10MB : "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/documentation/instructions/uploading-cvs-xls-data"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Upload"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File size > 10MB : "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/documentation/instructions/url-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Upload"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Including this sample CSV file in the default configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Customer Number;City\n123;St. Gallen\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Customer Number;City\n123;St. Gallen\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported columns (matched by ignoring letter case) with their mappings are the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Column Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target Path in the latest Business Partner Model"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wiki Page of Attribute in CDQ Data Model"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CUSTOMER NUMBER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.externalId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner External ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VENDOR NUMBER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not available"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner External ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NAME"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.names\\[0\\].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.names\\[0\\].type.technicalKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Business Partner External ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Name Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX NUMBER 1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in identifierId of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TAX NUMBER 1 TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if exists, otherwise, new identifier of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STCD1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type mapping, applied for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Identifier Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX NUMBER 1 TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX NUMBER 2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in identifierId of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TAX NUMBER 2 TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if exists, otherwise, new identifier of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STCD2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type mapping, applied for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Identifier Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX NUMBER 2 TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX NUMBER 3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in identifierId of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TAX NUMBER 3 TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if exists, otherwise, new identifier of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STCD3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type mapping, applied for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Identifier Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX NUMBER 3 TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX NUMBER 4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in identifierId of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TAX NUMBER 4 TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if exists, otherwise, new identifier of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STCD4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type mapping, applied for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Identifier Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX NUMBER 4 TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX NUMBER 5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in identifierId of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TAX NUMBER 5 TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if exists, otherwise, new identifier of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STCD5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type mapping, applied for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Identifier Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX NUMBER 5 TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT NUMBER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in identifierId of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT NUMBER TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if exists, otherwise, new identifier of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STCEG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type mapping, applied for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Identifier Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT NUMBER TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.identifiers\\[identifierId\\].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COUNTRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.country.(value, shortName)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses\\[0\\]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (+ in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses\\[1\\]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PO BOX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exists for non-France)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REGION"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.administrativeAreas\\[0\\].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses\\[0\\]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (+ in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses\\[1\\]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PO BOX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exists for non-France)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Administrative Area Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POSTAL CODE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.postCodes\\[0\\].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses\\[0\\]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (+ in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses\\[1\\]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PO BOX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exists for non-France)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Post Code Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CITY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.localities\\[0\\].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses\\[0\\]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (+ in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses\\[1\\]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PO BOX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exists for non-France)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locality Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STREET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.thoroughfares\\[0\\].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Thoroughfare Value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOUSE NUMBER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.thoroughfares\\[0\\].number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Thoroughfare Number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PO BOX"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.postalDeliveryPoints\\[0\\].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.postalDeliveryPoints\\[0\\].type.technicalKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PO BOX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses\\[0\\]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in France, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$.addresses\\[1\\]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for non-France"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner External ID"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternatively, CUSTOM_DATA_MAPPER feature can be used to enable record transformation based on the Data Mapper Definition"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provided either via a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataMapperDefinitionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or assigned to provided data source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Input file could contain customized columns naming effectively mapped to the Business Partner model via data mapper, shown in this sample CSV."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"MyId;Country;City;Name\n123;CH;St. Gallen;\n124;CH;;Quote \"Example\"\n\"125\";\"CH\";\"\";\"\"\"Quote \"\"\"\"Example\"\"\"\"  \"\"\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MyId;Country;City;Name\n123;CH;St. Gallen;\n124;CH;;Quote \"Example\"\n\"125\";\"CH\";\"\";\"\"\"Quote \"\"\"\"Example\"\"\"\"  \"\"\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Input file for CUSTOM_DATA_MAPPER feature can also contain only one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column with a stringified JSON representation of a record."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Based on the Data Mapper Definition, data is transformed to the Business Partner model."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case UPSERT_BY_EXTERNAL_ID feature is used, external ID value needs to be included:"},"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":"in a column which name is provided via a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extenalIdColumn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request property"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the JSON representation in the attribute mapped to externalId via data mapper"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Below is the sample CSV file for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-based configuration containing external ID column named MyId."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"MyId,Record\n123,\"{\"\"MyId\"\": \"\"123\"\", \"\"Country\"\": \"\"CH\"\", \"\"City\"\": \"\"St. Gallen\"\"}\"\n124,\"{\"\"MyId\"\": \"\"124\"\", \"\"Country\"\": \"\"CH\"\", \"\"Name\"\": \"\"Quote \\\"\"Example\\\"\"\"\"}\"\n125,\"{\"\"MyId\"\": \"\"125\"\", \"\"Country\"\": \"\"CH\"\", \"\"Name\"\": \"\"\\\"\"Quote \\\"\"\\\"\"Example\\\"\"\\\"\"  \\\"\"\"\"}\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MyId,Record\n123,\"{\"\"MyId\"\": \"\"123\"\", \"\"Country\"\": \"\"CH\"\", \"\"City\"\": \"\"St. Gallen\"\"}\"\n124,\"{\"\"MyId\"\": \"\"124\"\", \"\"Country\"\": \"\"CH\"\", \"\"Name\"\": \"\"Quote \\\"\"Example\\\"\"\"\"}\"\n125,\"{\"\"MyId\"\": \"\"125\"\", \"\"Country\"\": \"\"CH\"\", \"\"Name\"\": \"\"\\\"\"Quote \\\"\"\\\"\"Example\\\"\"\\\"\"  \\\"\"\"\"}\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of columns is 512"},"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-exchange-api/api-v5/data-import/paths/~1jobs~1importjobs~1%7Bjobid%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 IMPORT JOB ID}\"\n    ...\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"id\" : \"{YOUR IMPORT 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":"These imports, in default import samples, lead to the following Business Partners in the storage. The imported rows are represented as stringifies JSONs."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n   \"id\" : \"{AUTO GENERATED}\",\n   \"externalId\" : \"123\",\n   \"dataSource\": \"{YOUR DATASOURCE ID}\",\n   \"record\" : \"{ \\\"MyId\\\" : \\\"123\\\", \\\"Country\\\" : \\\"CH\\\", \\\"City\\\" : \\\"St. Gallen\\\" }\",\n   \"addresses\": [{\n      \"country\": {\n         \"shortName\": \"CH\"\n      },\n      \"localities\": [{\n         \"value\": \"St. Gallen\"\n      }]\n   }],\n   ...\n},\n{\n   \"id\" : \"{AUTO GENERATED}\",\n   \"externalId\" : \"124\",\n   \"dataSource\": \"{YOUR DATASOURCE ID}\",\n   \"record\" : \"{ \\\"MyId\\\" : \\\"124\\\", \\\"Country\\\" : \\\"CH\\\", \\\"Name\\\" : \\\"Quote \\\\\\\"Example\\\\\\\"\\\" }\",\n   \"names\": [{\n      \"value\": \"Quote \\\"Example\\\"\"\n      ...\n   }],\n   \"addresses\": [{\n      \"country\": {\n         \"shortName\": \"CH\"\n      }\n   }],\n   ...\n},\n{\n   \"id\" : \"{AUTO GENERATED}\",\n   \"externalId\" : \"125\",\n   \"dataSource\": \"{YOUR DATASOURCE ID}\",\n   \"record\" : \"{ \\\"MyId\\\" : \\\"125\\\", \\\"Country\\\" : \\\"CH\\\", \\\"Name\\\" : \\\"\\\\\\\"Quote \\\\\\\"\\\\\\\"Example\\\\\\\"\\\\\\\"  \\\\\\\"\\\" }\",\n   \"names\": [{\n      \"value\": \"\\\"Quote \\\"\\\"Example\\\"\\\"  \\\"\"\n      ...\n   }],\n   \"addresses\": [{\n      \"country\": {\n         \"shortName\": \"CH\"\n      }\n   }],\n   ...\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n   \"id\" : \"{AUTO GENERATED}\",\n   \"externalId\" : \"123\",\n   \"dataSource\": \"{YOUR DATASOURCE ID}\",\n   \"record\" : \"{ \\\"MyId\\\" : \\\"123\\\", \\\"Country\\\" : \\\"CH\\\", \\\"City\\\" : \\\"St. Gallen\\\" }\",\n   \"addresses\": [{\n      \"country\": {\n         \"shortName\": \"CH\"\n      },\n      \"localities\": [{\n         \"value\": \"St. Gallen\"\n      }]\n   }],\n   ...\n},\n{\n   \"id\" : \"{AUTO GENERATED}\",\n   \"externalId\" : \"124\",\n   \"dataSource\": \"{YOUR DATASOURCE ID}\",\n   \"record\" : \"{ \\\"MyId\\\" : \\\"124\\\", \\\"Country\\\" : \\\"CH\\\", \\\"Name\\\" : \\\"Quote \\\\\\\"Example\\\\\\\"\\\" }\",\n   \"names\": [{\n      \"value\": \"Quote \\\"Example\\\"\"\n      ...\n   }],\n   \"addresses\": [{\n      \"country\": {\n         \"shortName\": \"CH\"\n      }\n   }],\n   ...\n},\n{\n   \"id\" : \"{AUTO GENERATED}\",\n   \"externalId\" : \"125\",\n   \"dataSource\": \"{YOUR DATASOURCE ID}\",\n   \"record\" : \"{ \\\"MyId\\\" : \\\"125\\\", \\\"Country\\\" : \\\"CH\\\", \\\"Name\\\" : \\\"\\\\\\\"Quote \\\\\\\"\\\\\\\"Example\\\\\\\"\\\\\\\"  \\\\\\\"\\\" }\",\n   \"names\": [{\n      \"value\": \"\\\"Quote \\\"\\\"Example\\\"\\\"  \\\"\"\n      ...\n   }],\n   \"addresses\": [{\n      \"country\": {\n         \"shortName\": \"CH\"\n      }\n   }],\n   ...\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Input file which first 100 data lines except header are corrupted is canceled without further processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Importing data to Data Mirror requires using \"UPSERT_BY_EXTERNAL_ID\" feature. Otherwise, Bad Request is reported."},"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_68"}},"schemaId":"schema_68","pointer":"/paths/~1jobs~1importjobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/jobs/importjobs","servers":[{"url":"https://api.cdq.com/data-exchange/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_68"}},"responseCodes":["200","400"],"pointer":"/jobs/importjobs","href":"data-import/paths/~1jobs~1importjobs/post","summary":"Start Import Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"schema_68","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_68"}},"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/ImportJob"}},"schemaId":"components/schemas/ImportJob"},{"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/~1jobs~1importjobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportJob"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-import/paths/~1jobs~1importjobs/post"}],"panels":[]}]},"httpPath":"/jobs/importjobs"},{"label":"Poll Import Job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-import/paths/~1jobs~1importjobs~1{jobid}/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-import/paths/~1jobs~1importjobs~1{jobid}/get","metadata":{"seo":{"title":"Poll Import Job","description":"Allows polling the status of an Import Job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Poll Import Job","isWebhook":false,"pointer":"/paths/~1jobs~1importjobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll Import Job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows polling the status of an Import 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":"jobId","in":"path","schemaId":"schema_29","description":"Unique identifier of a Job.","required":true}],"pointer":"/paths/~1jobs~1importjobs~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skippedStartAfter","in":"query","schemaId":"schema_1","description":"Next page of items will be retrieved. When skippedNextStartAfter provided in the response, should be used."}],"pointer":"/paths/~1jobs~1importjobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/jobs/importjobs/{jobId}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"example":"35f23c03-1c22-45fe-9484-3ffe769325de","schemaId":"components/schemas/JobId"}],"query":[{"name":"skippedStartAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/jobs/importjobs/{jobId}","href":"data-import/paths/~1jobs~1importjobs~1{jobid}/get","summary":"Poll Import Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/ImportJob"}},"schemaId":"components/schemas/ImportJob"}],"pointer":"/paths/~1jobs~1importjobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportJob"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-import/paths/~1jobs~1importjobs~1{jobid}/get"}],"panels":[]}]},"httpPath":"/jobs/importjobs/{jobId}"}],"content":{"contentType":"group","meta":{"name":"Data Import"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Import","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for uploading external data and enabling users to enhance and update their Business Partner \nrecords with new information."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/jobs/importjobs","summary":"Start Import Job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-import/paths/~1jobs~1importjobs/post","deprecated":false},{"title":"/jobs/importjobs/{jobId}","summary":"Poll Import Job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-import/paths/~1jobs~1importjobs~1{jobid}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Mapping","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping","items":[{"label":"Create Data Mapper Definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping/paths/~1datamapperdefinitions/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping/paths/~1datamapperdefinitions/post","metadata":{"seo":{"title":"Create Data Mapper Definition","description":"Create a Data Mapper Definition which is used to map data (i.e. in the format from the database) to the CDQ data model."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create Data Mapper Definition","isWebhook":false,"pointer":"/paths/~1datamapperdefinitions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Data Mapper 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 Data Mapper Definition which is used to map data (i.e. in the format from the database) to the CDQ data model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data mapper definition consists of:"},"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":"inputMapping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - definition how to map "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessPartner.record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to CDQ data model"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outputMapping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - definition how to map CDQ data model to the target model"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business partner can be mapped via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessPartnerAttributeMappings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following values of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/data-mapping/paths/~1datamapperdefinitions/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute mapping rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"as targetAttributes for inputMapping"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as sourceAttributes for outputMapping (please remember they are case sensitive)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can be mapped to Business Partner attributes:"},"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":"businessPartner.dataSource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.externalId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.disclosed - special attribute. When defined in a mapping, takes over the decision for disclosing records in data source this Data Mapper Definition is assigned to. When source attribute is mapped from record, the mapping takes the value. If the attribute is missing, disclosed is set to false."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.names[0-10].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.names[0-10].shortName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.names[0-10].language"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.names[0-10].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.names"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.legalForm.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.legalForm.categories[0-4].technicalKey"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.categories"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.identifiers[0-49].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.identifiers[0-49].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.identifiers[0-49].issuingBody.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.identifiers[0-49].issuingBody - mapped to issuingBody.technicalKey"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.identifiers[0-49].status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.identifiers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.externalContext.identifiers[0-49].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.externalContext.identifiers[0-49].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessPartner.externalContext.identifiers"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index of typed concepts: names and identifiers, is not a final position of concept in the CDQ data model - this is a grouping indicator for a set of concept properties."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Names mapping, in case none of names is typed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and exists any name with empty type or not filled type.technicalKey, it becomes name of type LOCAL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Addresses can be mapped via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressesAttributeMappings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Address receives "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property coming from an index of the collection of AttributeMappingRules."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following values of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/data-mapping/paths/~1datamapperdefinitions/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute mapping rules"},"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":"as targetAttributes for inputMapping"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as sourceAttributes for outputMapping"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can be mapped to address attributes:"},"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":"address.externalId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.version.language"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.version.characterSet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.careOf.value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.identifyingName.value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.country.value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.country.shortName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.administrativeAreas"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.administrativeAreas[0-4].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.administrativeAreas[0-4].shortName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.administrativeAreas[0-4].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.postCodes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.postCodes[0-4].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.postCodes[0-4].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.localities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.localities[0-4].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.localities[0-4].shortName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.localities[0-4].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.thoroughfares"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.thoroughfares[0-4].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.thoroughfares[0-4].shortName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.thoroughfares[0-4].number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.thoroughfares[0-4].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.premises"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.premises[0-4].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.premises[0-4].shortName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.premises[0-4].number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.premises[0-4].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.postalDeliveryPoints"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.postalDeliveryPoints[0-4].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.postalDeliveryPoints[0-4].shortName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.postalDeliveryPoints[0-4].number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.postalDeliveryPoints[0-4].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.geographicCoordinates.latitude"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.geographicCoordinates.longitude"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.contexts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address.contexts[0-4]"},"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/DataMapperDefinitionRequest","exampleIds":["paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/Basic","paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/DisclosedBP"]}},"schemaId":"components/schemas/DataMapperDefinitionRequest","exampleIds":["paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/Basic","paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/DisclosedBP"],"pointer":"/paths/~1datamapperdefinitions/post/requestBody","description":"Request to create a new Data Mapper Definition."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/datamapperdefinitions","servers":[{"url":"https://api.cdq.com/data-exchange/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/DataMapperDefinitionRequest","exampleIds":["paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/Basic","paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/DisclosedBP"]}},"responseCodes":["200"],"pointer":"/datamapperdefinitions","href":"data-mapping/paths/~1datamapperdefinitions/post","summary":"Create Data Mapper Definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/DataMapperDefinitionRequest","exampleIds":["paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/Basic","paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/DisclosedBP"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMapperDefinitionRequest","exampleIds":["paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/Basic","paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/DisclosedBP"]}},"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/DataMapperDefinition"}},"schemaId":"components/schemas/DataMapperDefinition"}],"pointer":"/paths/~1datamapperdefinitions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMapperDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMapperDefinition"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-mapping/paths/~1datamapperdefinitions/post"}],"panels":[]}]},"httpPath":"/datamapperdefinitions"},{"label":"List Data Mapper Definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping/paths/~1datamapperdefinitions/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping/paths/~1datamapperdefinitions/get","metadata":{"seo":{"title":"List Data Mapper Definitions","description":"Read the Data Mapper Definition Page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Data Mapper Definitions","isWebhook":false,"pointer":"/paths/~1datamapperdefinitions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Data Mapper Definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read the Data Mapper Definition Page."},{"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":"label","in":"query","schemaId":"schema_69","description":"Label for filtering that is passed as header parameter with the name label."},{"name":"sharedWithOrganization","in":"query","schemaId":"schema_36","description":"Filters only mappings which are shared with organization or not."},{"name":"page","in":"query","schemaId":"schema_70","description":"Number of the page that will be retrieved."},{"name":"pageSize","in":"query","schemaId":"schema_71","description":"Number of items to be returned on the page."},{"name":"sort","in":"query","schemaId":"schema_72","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 attributes are 'id' and 'modifiedAt', separated by comma (,) and the sort direction in front of each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute. '+' means ascending, '-' means descending. If direction is not given default sort is ascending."},"children":[]}]}]}]}],"pointer":"/paths/~1datamapperdefinitions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/datamapperdefinitions","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"label","in":"query","required":false,"schemaId":"schema_69"},{"name":"sharedWithOrganization","in":"query","required":false,"example":"true","schemaId":"schema_36"},{"name":"page","in":"query","required":false,"example":"10","schemaId":"schema_70"},{"name":"pageSize","in":"query","required":false,"example":"10","schemaId":"schema_71"},{"name":"sort","in":"query","example":"-modifiedAt","schemaId":"schema_72"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/datamapperdefinitions","href":"data-mapping/paths/~1datamapperdefinitions/get","summary":"List Data Mapper Definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/DataMapperDefinitionPage"}},"schemaId":"components/schemas/DataMapperDefinitionPage"}],"pointer":"/paths/~1datamapperdefinitions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMapperDefinitionPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMapperDefinitionPage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-mapping/paths/~1datamapperdefinitions/get"}],"panels":[]}]},"httpPath":"/datamapperdefinitions"},{"label":"Read Data Mapper Definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping/paths/~1datamapperdefinitions~1{id}/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping/paths/~1datamapperdefinitions~1{id}/get","metadata":{"seo":{"title":"Read Data Mapper Definition","description":"Read a Data Mapper Definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Read Data Mapper Definition","isWebhook":false,"pointer":"/paths/~1datamapperdefinitions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read Data Mapper Definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read a Data Mapper Definition."},{"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_73","description":"Unique ID of the Data Mapper Definition.","required":true}],"pointer":"/paths/~1datamapperdefinitions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/datamapperdefinitions/{id}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6440dba32b30176c5917b1b7","schemaId":"components/schemas/DataMapperDefinitionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/datamapperdefinitions/{id}","href":"data-mapping/paths/~1datamapperdefinitions~1{id}/get","summary":"Read Data Mapper Definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/DataMapperDefinition"}},"schemaId":"components/schemas/DataMapperDefinition"}],"pointer":"/paths/~1datamapperdefinitions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMapperDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMapperDefinition"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-mapping/paths/~1datamapperdefinitions~1{id}/get"}],"panels":[]}]},"httpPath":"/datamapperdefinitions/{id}"},{"label":"Update Data Mapper Definition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping/paths/~1datamapperdefinitions~1{id}/put","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping/paths/~1datamapperdefinitions~1{id}/put","metadata":{"seo":{"title":"Update Data Mapper Definition","description":"Update a Data Mapper Definition. For more information what are the allowed Data Mapper values, go to creation endpoint description."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Data Mapper Definition","isWebhook":false,"pointer":"/paths/~1datamapperdefinitions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Data Mapper 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":"Update a Data Mapper Definition. For more information what are the allowed Data Mapper values, go to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/data-mapping/paths/~1datamapperdefinitions/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creation endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" description."},"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_73","description":"Unique ID of the Data Mapper Definition.","required":true}],"pointer":"/paths/~1datamapperdefinitions~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/DataMapperDefinitionRequest","exampleIds":["paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/Basic","paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/DisclosedBP"]}},"schemaId":"components/schemas/DataMapperDefinitionRequest","exampleIds":["paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/Basic","paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/DisclosedBP"],"pointer":"/paths/~1datamapperdefinitions~1{id}/put/requestBody","description":"Request to create a new Data Mapper Definition."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/datamapperdefinitions/{id}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6440dba32b30176c5917b1b7","schemaId":"components/schemas/DataMapperDefinitionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataMapperDefinitionRequest","exampleIds":["paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/Basic","paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/DisclosedBP"]}},"responseCodes":["200"],"pointer":"/datamapperdefinitions/{id}","href":"data-mapping/paths/~1datamapperdefinitions~1{id}/put","summary":"Update Data Mapper Definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/DataMapperDefinitionRequest","exampleIds":["paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/Basic","paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/DisclosedBP"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMapperDefinitionRequest","exampleIds":["paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/Basic","paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/DisclosedBP"]}},"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/DataMapperDefinition"}},"schemaId":"components/schemas/DataMapperDefinition"}],"pointer":"/paths/~1datamapperdefinitions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMapperDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMapperDefinition"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-mapping/paths/~1datamapperdefinitions~1{id}/put"}],"panels":[]}]},"httpPath":"/datamapperdefinitions/{id}"},{"label":"Delete Data Mapper Definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping/paths/~1datamapperdefinitions~1{id}/delete","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mapping/paths/~1datamapperdefinitions~1{id}/delete","metadata":{"seo":{"title":"Delete Data Mapper Definition","description":"Delete chosen Data Mapper Definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete Data Mapper Definition","isWebhook":false,"pointer":"/paths/~1datamapperdefinitions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Data Mapper Definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete chosen Data Mapper Definition."},{"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_73","description":"Unique ID of the Data Mapper Definition.","required":true}],"pointer":"/paths/~1datamapperdefinitions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/datamapperdefinitions/{id}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6440dba32b30176c5917b1b7","schemaId":"components/schemas/DataMapperDefinitionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/datamapperdefinitions/{id}","href":"data-mapping/paths/~1datamapperdefinitions~1{id}/delete","summary":"Delete Data Mapper Definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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"}],"pointer":"/paths/~1datamapperdefinitions~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-mapping/paths/~1datamapperdefinitions~1{id}/delete"}],"panels":[]}]},"httpPath":"/datamapperdefinitions/{id}"}],"content":{"contentType":"group","meta":{"name":"Data Mapping"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Mapping","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for defining and managing data mappings, enabling users to transform and map raw data into \nstructured formats suitable for processing and analysis."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/datamapperdefinitions","summary":"Create Data Mapper Definition","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-mapping/paths/~1datamapperdefinitions/post","deprecated":false},{"title":"/datamapperdefinitions","summary":"List Data Mapper Definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-mapping/paths/~1datamapperdefinitions/get","deprecated":false},{"title":"/datamapperdefinitions/{id}","summary":"Read Data Mapper Definition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-mapping/paths/~1datamapperdefinitions~1{id}/get","deprecated":false},{"title":"/datamapperdefinitions/{id}","summary":"Update Data Mapper Definition","prefix":{"name":"put","color":"put"},"badges":[],"link":"/data-mapping/paths/~1datamapperdefinitions~1{id}/put","deprecated":false},{"title":"/datamapperdefinitions/{id}","summary":"Delete Data Mapper Definition","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/data-mapping/paths/~1datamapperdefinitions~1{id}/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Monitors","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors","items":[{"label":"List Data Monitors by Type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1datamonitors/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1datamonitors/get","metadata":{"seo":{"title":"List Data Monitors by Type","description":"List all Data Monitors of a specific type across all storages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Data Monitors by Type","isWebhook":false,"pointer":"/paths/~1v2~1datamonitors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Data Monitors by Type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all Data Monitors of a specific type across all storages."},{"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_1","description":"Only items with an ID greater than the given one will be retrieved.\n\nWhen nextStartAfter provided in the response, should be used instead of the ID\nas an indicator for a next page.\n"},{"name":"limit","in":"query","schemaId":"schema_2","description":"Number of items to be returned on the page."},{"name":"sort","in":"query","schemaId":"schema_75","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 'modifiedAt'. Sort direction can be specified in front of each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute. '+' means ascending, '-' means descending. If direction is not given default sort is ascending."},"children":[]}]}]}]},{"name":"typeTechnicalKeys","in":"query","schemaId":"schema_76","description":"Business Partner type technical keys which should be filtered.","required":true},{"name":"dataSourceId","in":"query","schemaId":"schema_27","description":"Filter by specified Data Source ID."},{"name":"configurationId","in":"query","schemaId":"schema_77","description":"Filter by specified Configuration ID."}],"pointer":"/paths/~1v2~1datamonitors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/datamonitors","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"schema_2"},{"name":"featuresOn","in":"query","schemaId":"schema_74"},{"name":"sort","in":"query","example":"-modifiedAt","schemaId":"schema_75"},{"name":"typeTechnicalKeys","in":"query","required":true,"schemaId":"schema_76"},{"name":"dataSourceId","in":"query","required":false,"example":"648824a691d8d2503d65103e","schemaId":"components/schemas/BusinessPartnerStorageDataSourceId"},{"name":"configurationId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/ConfigurationId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/datamonitors","href":"data-monitors/paths/~1v2~1datamonitors/get","summary":"List Data Monitors by Type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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 page of Data Monitors matching the specified type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMonitorsPage"}},"schemaId":"components/schemas/DataMonitorsPage"}],"pointer":"/paths/~1v2~1datamonitors/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMonitorsPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMonitorsPage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-monitors/paths/~1v2~1datamonitors/get"}],"panels":[]}]},"httpPath":"/v2/datamonitors"},{"label":"Delete Data Monitor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1storages~1{storageid}~1datamonitors~1{datamonitorid}/delete","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1storages~1{storageid}~1datamonitors~1{datamonitorid}/delete","metadata":{"seo":{"title":"Delete Data Monitor","description":"Delete a data monitor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete Data Monitor","isWebhook":false,"pointer":"/paths/~1storages~1{storageId}~1datamonitors~1{dataMonitorId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Data Monitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a data monitor."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true},{"name":"dataMonitorId","in":"path","schemaId":"schema_78","description":"Unique ID of a Data Monitor.","required":true}],"pointer":"/paths/~1storages~1{storageId}~1datamonitors~1{dataMonitorId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/storages/{storageId}/datamonitors/{dataMonitorId}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"dataMonitorId","in":"path","required":true,"example":"bfdfd6f7-562f-4d4a-921f-e68cba60d5cf","schemaId":"components/schemas/DataMonitorId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/storages/{storageId}/datamonitors/{dataMonitorId}","href":"data-monitors/paths/~1storages~1{storageid}~1datamonitors~1{datamonitorid}/delete","summary":"Delete Data Monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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"}],"pointer":"/paths/~1storages~1{storageId}~1datamonitors~1{dataMonitorId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-monitors/paths/~1storages~1{storageid}~1datamonitors~1{datamonitorid}/delete"}],"panels":[]}]},"httpPath":"/storages/{storageId}/datamonitors/{dataMonitorId}"},{"label":"List Data Monitors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors/get","metadata":{"seo":{"title":"List Data Monitors","description":"List all Data Monitors of the give storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List Data Monitors","isWebhook":false,"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Data Monitors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all Data Monitors of the give storage."},{"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startAfter","in":"query","schemaId":"schema_1","description":"Only items with an ID greater than the given one will be retrieved.\n\nWhen nextStartAfter provided in the response, should be used instead of the ID\nas an indicator for a next page.\n"},{"name":"limit","in":"query","schemaId":"schema_2","description":"Number of items to be returned on the page."},{"name":"sort","in":"query","schemaId":"schema_75","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 'modifiedAt'. Sort direction can be specified in front of each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute. '+' means ascending, '-' means descending. If direction is not given default sort is ascending."},"children":[]}]}]}]},{"name":"typeTechnicalKeys","in":"query","schemaId":"schema_76","description":"Business Partner type technical keys which should be filtered."},{"name":"dataSourceId","in":"query","schemaId":"schema_27","description":"Filter by specified Data Source ID."},{"name":"configurationId","in":"query","schemaId":"schema_77","description":"Filter by specified Configuration ID."}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/storages/{storageId}/datamonitors","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"schema_2"},{"name":"featuresOn","in":"query","schemaId":"schema_79"},{"name":"sort","in":"query","example":"-modifiedAt","schemaId":"schema_75"},{"name":"typeTechnicalKeys","in":"query","required":false,"schemaId":"schema_76"},{"name":"dataSourceId","in":"query","required":false,"example":"648824a691d8d2503d65103e","schemaId":"components/schemas/BusinessPartnerStorageDataSourceId"},{"name":"configurationId","in":"query","required":false,"example":"c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4","schemaId":"components/schemas/ConfigurationId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/storages/{storageId}/datamonitors","href":"data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors/get","summary":"List Data Monitors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/DataMonitorsPage"}},"schemaId":"components/schemas/DataMonitorsPage"}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMonitorsPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMonitorsPage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors/get"}],"panels":[]}]},"httpPath":"/v2/storages/{storageId}/datamonitors"},{"label":"Create Data Monitor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors/post","metadata":{"seo":{"title":"Create Data Monitor","description":"Create a new data monitor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create Data Monitor","isWebhook":false,"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Data Monitor","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 monitor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data monitor is a concept for asynchronous processing of data curation and data validation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data monitors should be unique by a pair: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data monitor can be created only for DATA_MIRROR storage, having "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sharedWithOrganization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to true."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available execution types:"},"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":"TRIGGER - causes reevaluation of data whenever CDQ Business Partner model of your data has changed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or whenever linked reference data has changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JOB - reevaluates data every specified period of time."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: creation of data monitor starts background process that is invoked for all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partners from data monitor scope."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMonitorCreate","exampleIds":["paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/dataMonitor","paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/augmentationMonitor"]}},"schemaId":"components/schemas/DataMonitorCreate","exampleIds":["paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/dataMonitor","paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/augmentationMonitor"],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/storages/{storageId}/datamonitors","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[{"name":"featuresOn","in":"query","schemaId":"schema_80"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataMonitorCreate","exampleIds":["paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/dataMonitor","paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/augmentationMonitor"]}},"responseCodes":["200"],"pointer":"/v2/storages/{storageId}/datamonitors","href":"data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors/post","summary":"Create Data Monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/DataMonitorCreate","exampleIds":["paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/dataMonitor","paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/augmentationMonitor"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMonitorCreate","exampleIds":["paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/dataMonitor","paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/augmentationMonitor"]}},"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/DataMonitor"}},"schemaId":"components/schemas/DataMonitor"}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMonitor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMonitor"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors/post"}],"panels":[]}]},"httpPath":"/v2/storages/{storageId}/datamonitors"},{"label":"Update Data Monitor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1{datamonitorid}/put","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1{datamonitorid}/put","metadata":{"seo":{"title":"Update Data Monitor","description":"Note: modification of configuration.id or set of dataSources starts background processthat populates processing log for all Business Partners from data monitor scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Data Monitor","isWebhook":false,"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1{dataMonitorId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Data Monitor","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":"Note: modification of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"configuration.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or set of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" starts background process"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that populates processing log for all Business Partners from data monitor scope."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true},{"name":"dataMonitorId","in":"path","schemaId":"schema_78","description":"Unique ID of a Data Monitor.","required":true}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1{dataMonitorId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMonitorUpdate"}},"schemaId":"components/schemas/DataMonitorUpdate","pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1{dataMonitorId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/storages/{storageId}/datamonitors/{dataMonitorId}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"dataMonitorId","in":"path","required":true,"example":"bfdfd6f7-562f-4d4a-921f-e68cba60d5cf","schemaId":"components/schemas/DataMonitorId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataMonitorUpdate"}},"responseCodes":["200"],"pointer":"/v2/storages/{storageId}/datamonitors/{dataMonitorId}","href":"data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1{datamonitorid}/put","summary":"Update Data Monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/DataMonitorUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMonitorUpdate"}},"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/DataSourceUpsertsResult"}},"schemaId":"components/schemas/DataSourceUpsertsResult"}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1{dataMonitorId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataSourceUpsertsResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataSourceUpsertsResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1{datamonitorid}/put"}],"panels":[]}]},"httpPath":"/v2/storages/{storageId}/datamonitors/{dataMonitorId}"},{"label":"Data Monitor Progress","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1{datamonitorid}~1progress/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1{datamonitorid}~1progress/get","metadata":{"seo":{"title":"Data Monitor Progress","description":"Note: modification of configuration.id or set of dataSources starts background processthat populates processing log for all Business Partners from data monitor scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Data Monitor Progress","isWebhook":false,"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1{dataMonitorId}~1progress/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Monitor Progress","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":"Note: modification of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"configuration.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or set of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" starts background process"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that populates processing log for all Business Partners from data monitor scope."},"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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true},{"name":"dataMonitorId","in":"path","schemaId":"schema_78","description":"Unique ID of a Data Monitor.","required":true}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1{dataMonitorId}~1progress/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"scope","in":"query","schemaId":"schema_81","description":"Scope of data monitor to fetch progress."}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1{dataMonitorId}~1progress/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/storages/{storageId}/datamonitors/{dataMonitorId}/progress","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"},{"name":"dataMonitorId","in":"path","required":true,"example":"bfdfd6f7-562f-4d4a-921f-e68cba60d5cf","schemaId":"components/schemas/DataMonitorId"}],"query":[{"name":"scope","in":"query","required":false,"example":"RAW_UPDATES","schemaId":"components/schemas/DataMonitorScopeTechnicalKey"},{"name":"featuresOff","in":"query","required":false,"schemaId":"schema_82"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/storages/{storageId}/datamonitors/{dataMonitorId}/progress","href":"data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1{datamonitorid}~1progress/get","summary":"Data Monitor Progress"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/DataMonitorProgressResult"}},"schemaId":"components/schemas/DataMonitorProgressResult"}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1{dataMonitorId}~1progress/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMonitorProgressResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMonitorProgressResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1{datamonitorid}~1progress/get"}],"panels":[]}]},"httpPath":"/v2/storages/{storageId}/datamonitors/{dataMonitorId}/progress"},{"label":"Refresh Data Monitors","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1refresh/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1refresh/post","metadata":{"seo":{"title":"Refresh Data Monitors","description":"Refresh Data Monitors. When refreshing data monitor, a reevaluation is done for all Business Partners from the data monitor scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Refresh Data Monitors","isWebhook":false,"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1refresh/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refresh Data Monitors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Refresh Data Monitors. When refreshing data monitor, a reevaluation is done\nfor all Business Partners from the data monitor scope.\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":"storageId","in":"path","schemaId":"schema_0","description":"Unique identifier of the Storage.","required":true}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1refresh/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMonitorRefreshes"}},"schemaId":"components/schemas/DataMonitorRefreshes","pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1refresh/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/storages/{storageId}/datamonitors/refresh","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"storageId","in":"path","required":true,"example":"72d6900fce6b326088f5d9d91049e3e6","schemaId":"components/schemas/BusinessPartnerStorageId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataMonitorRefreshes"}},"responseCodes":["200"],"pointer":"/v2/storages/{storageId}/datamonitors/refresh","href":"data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1refresh/post","summary":"Refresh Data Monitors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/DataMonitorRefreshes","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataMonitorRefreshes"}},"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/DataMonitorRefreshResults"}},"schemaId":"components/schemas/DataMonitorRefreshResults"}],"pointer":"/paths/~1v2~1storages~1{storageId}~1datamonitors~1refresh/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataMonitorRefreshResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataMonitorRefreshResults"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1refresh/post"}],"panels":[]}]},"httpPath":"/v2/storages/{storageId}/datamonitors/refresh"}],"content":{"contentType":"group","meta":{"name":"Data Monitors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Monitors","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for creating, retrieving, updating and deleting data monitors."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/datamonitors","summary":"List Data Monitors by Type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-monitors/paths/~1v2~1datamonitors/get","deprecated":false},{"title":"/storages/{storageId}/datamonitors/{dataMonitorId}","summary":"Delete Data Monitor","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/data-monitors/paths/~1storages~1{storageid}~1datamonitors~1{datamonitorid}/delete","deprecated":false},{"title":"/v2/storages/{storageId}/datamonitors","summary":"List Data Monitors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors/get","deprecated":false},{"title":"/v2/storages/{storageId}/datamonitors","summary":"Create Data Monitor","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors/post","deprecated":false},{"title":"/v2/storages/{storageId}/datamonitors/{dataMonitorId}","summary":"Update Data Monitor","prefix":{"name":"put","color":"put"},"badges":[],"link":"/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1{datamonitorid}/put","deprecated":false},{"title":"/v2/storages/{storageId}/datamonitors/{dataMonitorId}/progress","summary":"Data Monitor Progress","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1{datamonitorid}~1progress/get","deprecated":false},{"title":"/v2/storages/{storageId}/datamonitors/refresh","summary":"Refresh Data Monitors","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-monitors/paths/~1v2~1storages~1{storageid}~1datamonitors~1refresh/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Transformation","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-transformation","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-transformation","items":[{"label":"Start Transformation Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-transformation/paths/~1jobs~1transformationjobs/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-transformation/paths/~1jobs~1transformationjobs/post","metadata":{"seo":{"title":"Start Transformation Job","description":"Starting a Transformation Job. In case any selected data source does not have a dataMappingDefinition an API error returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Start Transformation Job","isWebhook":false,"pointer":"/paths/~1jobs~1transformationjobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start Transformation Job","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":"Starting a Transformation Job. In case any selected data source does not have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataMappingDefinition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an API error returned."},"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/TransformationJobRequest","exampleIds":["paths/~1jobs~1transformationjobs/post/requestBody/content/application~1json/examples/example1"]}},"schemaId":"components/schemas/TransformationJobRequest","exampleIds":["paths/~1jobs~1transformationjobs/post/requestBody/content/application~1json/examples/example1"],"pointer":"/paths/~1jobs~1transformationjobs/post/requestBody","description":"cmd"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/jobs/transformationjobs","servers":[{"url":"https://api.cdq.com/data-exchange/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/TransformationJobRequest","exampleIds":["paths/~1jobs~1transformationjobs/post/requestBody/content/application~1json/examples/example1"]}},"responseCodes":["200","400","401","403"],"pointer":"/jobs/transformationjobs","href":"data-transformation/paths/~1jobs~1transformationjobs/post","summary":"Start Transformation Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/TransformationJobRequest","exampleIds":["paths/~1jobs~1transformationjobs/post/requestBody/content/application~1json/examples/example1"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransformationJobRequest","exampleIds":["paths/~1jobs~1transformationjobs/post/requestBody/content/application~1json/examples/example1"]}},"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/TransformationJob"}},"schemaId":"components/schemas/TransformationJob"},{"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/~1jobs~1transformationjobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransformationJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransformationJob"}}},{"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":"/data-transformation/paths/~1jobs~1transformationjobs/post"}],"panels":[]}]},"httpPath":"/jobs/transformationjobs"},{"label":"Poll Transformation Job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-transformation/paths/~1jobs~1transformationjobs~1{id}/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-transformation/paths/~1jobs~1transformationjobs~1{id}/get","metadata":{"seo":{"title":"Poll Transformation Job","description":"After you have started a  transformation job, you will receive a job id in the response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Poll Transformation Job","isWebhook":false,"pointer":"/paths/~1jobs~1transformationjobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll Transformation Job","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":"After you have started a  transformation job, you will receive a job id in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"id\" : \"<ID>\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"id\" : \"<ID>\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED the transformation is done, and you are able to verify the result in your storage."},"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_29","description":"ID of the transformation job.","required":true}],"pointer":"/paths/~1jobs~1transformationjobs~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"failuresStartAfter","in":"query","schemaId":"schema_83","description":"Only items with an ID greater than the given one will be retrieved. Use failuresNextStartAfter from the response for pagination."}],"pointer":"/paths/~1jobs~1transformationjobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/jobs/transformationjobs/{id}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"35f23c03-1c22-45fe-9484-3ffe769325de","schemaId":"components/schemas/JobId"}],"query":[{"name":"failuresStartAfter","in":"query","required":false,"example":"NmEyOThlMGM4MTAyNTI3NWM2M2M1Y2I3","schemaId":"schema_83"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/jobs/transformationjobs/{id}","href":"data-transformation/paths/~1jobs~1transformationjobs~1{id}/get","summary":"Poll Transformation Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/TransformationJob"}},"schemaId":"components/schemas/TransformationJob"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1jobs~1transformationjobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransformationJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransformationJob"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-transformation/paths/~1jobs~1transformationjobs~1{id}/get"}],"panels":[]}]},"httpPath":"/jobs/transformationjobs/{id}"},{"label":"Use Data Mapper Definition","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-transformation/paths/~1v3~1datamappers~1{id}~1transform/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-transformation/paths/~1v3~1datamappers~1{id}~1transform/post","metadata":{"seo":{"title":"Use Data Mapper Definition","description":"Use a Data Mapper Definition to transform a list of records into Business Partners."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Use Data Mapper Definition","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1datamappers~1{id}~1transform/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use Data Mapper Definition","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use a Data Mapper Definition to transform a list of records into Business Partners."},{"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_73","description":"ID of the Data Mapper Definition.","required":true}],"pointer":"/paths/~1v3~1datamappers~1{id}~1transform/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransformRequest"}},"schemaId":"components/schemas/TransformRequest","pointer":"/paths/~1v3~1datamappers~1{id}~1transform/post/requestBody","description":"Records"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/datamappers/{id}/transform","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6440dba32b30176c5917b1b7","schemaId":"components/schemas/DataMapperDefinitionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransformRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/datamappers/{id}/transform","href":"data-transformation/paths/~1v3~1datamappers~1{id}~1transform/post","summary":"Use Data Mapper Definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/TransformRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransformRequest"}},"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":"schema_84"}},"schemaId":"schema_84"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v3~1datamappers~1{id}~1transform/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-transformation/paths/~1v3~1datamappers~1{id}~1transform/post"}],"panels":[]}]},"httpPath":"/v3/datamappers/{id}/transform"}],"content":{"contentType":"group","meta":{"name":"Data Transformation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Transformation","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for converting raw data into structured formats."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/jobs/transformationjobs","summary":"Start Transformation Job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-transformation/paths/~1jobs~1transformationjobs/post","deprecated":false},{"title":"/jobs/transformationjobs/{id}","summary":"Poll Transformation Job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-transformation/paths/~1jobs~1transformationjobs~1{id}/get","deprecated":false},{"title":"/v3/datamappers/{id}/transform","summary":"Use Data Mapper Definition","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/data-transformation/paths/~1v3~1datamappers~1{id}~1transform/post","deprecated":true}]}]}]}]}},{"type":"group","label":"DNB Storages","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages","items":[{"label":"List DNB Records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1v4~1dnbstorages~1dnbrecords/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1v4~1dnbstorages~1dnbrecords/get","metadata":{"seo":{"title":"List DNB Records","description":"Read a page of records from the D&B storage of your organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List DNB Records","isWebhook":false,"pointer":"/paths/~1v4~1dnbstorages~1dnbrecords/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List DNB Records","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":"Read a page of records from the D&B storage of your organization."},"children":[]}]}]}]},{"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_1","description":"Only items with an ID greater than the given one will be retrieved.\n\nWhen nextStartAfter provided in the response, should be used instead of the ID\nas an indicator for a next page.\n"},{"name":"limit","in":"query","schemaId":"schema_2","description":"Number of items to be returned on the page."},{"name":"featureOn","in":"query","schemaId":"schema_85","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features to be activated during the D&B Records read."},"children":[]}]}]}]},{"name":"featureOff","in":"query","schemaId":"schema_86","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features to be deactivated during the D&B Records read."},"children":[]}]}]}]}],"pointer":"/paths/~1v4~1dnbstorages~1dnbrecords/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/dnbstorages/dnbrecords","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"startAfter","in":"query","required":false,"example":"5712566172571652","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":"100","schemaId":"schema_2"},{"name":"featureOn","in":"query","required":false,"schemaId":"schema_85"},{"name":"featureOff","in":"query","required":false,"schemaId":"schema_86"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/dnbstorages/dnbrecords","href":"dnb-storages/paths/~1v4~1dnbstorages~1dnbrecords/get","summary":"List DNB Records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/DnbRecordPage"}},"schemaId":"components/schemas/DnbRecordPage"}],"pointer":"/paths/~1v4~1dnbstorages~1dnbrecords/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DnbRecordPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DnbRecordPage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dnb-storages/paths/~1v4~1dnbstorages~1dnbrecords/get"}],"panels":[]}]},"httpPath":"/v4/dnbstorages/dnbrecords"},{"label":"Fetch DNB Record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1v4~1dnbstorages~1fetch/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1v4~1dnbstorages~1fetch/post","metadata":{"seo":{"title":"Fetch DNB Record","description":"Fetch a D&B record by providing the DUNS."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Fetch DNB Record","isWebhook":false,"pointer":"/paths/~1v4~1dnbstorages~1fetch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch DNB Record","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":"Fetch a D&B record by providing the DUNS."},"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/FetchDnbRecordRequest"}},"schemaId":"components/schemas/FetchDnbRecordRequest","pointer":"/paths/~1v4~1dnbstorages~1fetch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/dnbstorages/fetch","servers":[{"url":"https://api.cdq.com/data-exchange/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/FetchDnbRecordRequest"}},"responseCodes":["200"],"pointer":"/v4/dnbstorages/fetch","href":"dnb-storages/paths/~1v4~1dnbstorages~1fetch/post","summary":"Fetch DNB Record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/FetchDnbRecordRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FetchDnbRecordRequest"}},"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/FetchDnbRecordResult"}},"schemaId":"components/schemas/FetchDnbRecordResult"}],"pointer":"/paths/~1v4~1dnbstorages~1fetch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FetchDnbRecordResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FetchDnbRecordResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dnb-storages/paths/~1v4~1dnbstorages~1fetch/post"}],"panels":[]}]},"httpPath":"/v4/dnbstorages/fetch"},{"label":"Start DNB Import Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1jobs~1dnbimportjobs/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1jobs~1dnbimportjobs/post","metadata":{"seo":{"title":"Start DNB Import Job","description":"To start a D&B Import Job use the following request"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Start DNB Import Job","isWebhook":false,"pointer":"/paths/~1jobs~1dnbimportjobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start DNB Import Job","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 a D&B Import Job use the following request"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \\\n  --url 'https://api.corporate-data-league.ch/data-exchange/rest/jobs/dnbimportjobs?dnbUser=optional&dnbPassword=optional' \\\n  -u 'BasicAuthUserName:your_credentials'\\\n  -H 'Accept: application/json' \\\n  -F 'file=@your_file.csv'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \\\n  --url 'https://api.corporate-data-league.ch/data-exchange/rest/jobs/dnbimportjobs?dnbUser=optional&dnbPassword=optional' \\\n  -u 'BasicAuthUserName:your_credentials'\\\n  -H 'Accept: application/json' \\\n  -F 'file=@your_file.csv'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with using this sample file:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"DUNS\n305211311\nDNB:305211311\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DUNS\n305211311\nDNB:305211311\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file can be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xlsx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The file should contain only one column with the DUNS number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the first row should the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUNS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The DUNS number can be in following forms:"},"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":"As CDQ-ID. Example or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DNB:305211311"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as raw DUNS "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"305211311"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The DUNS consist of 9 digits. When the input DUNS does not consist of 9 digits, leading zeros are added."},"children":[]}]}]}]},{"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":"name","in":"query","schemaId":"schema_87","description":"Name of the job."},{"name":"description","in":"query","schemaId":"schema_88","description":"Description of the job."},{"name":"dnbUser","in":"query","schemaId":"schema_89","description":"Optional, if credentials are available in user or organization settings."},{"name":"dnbPassword","in":"query","schemaId":"schema_90","description":"Optional, if credentials are available in user or organization settings."},{"name":"featuresOn","in":"query","schemaId":"schema_91","description":"Feature to be activated."},{"name":"dnbDataSource","in":"query","schemaId":"schema_92","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D&B product that should be downloaded from D&B and put into specific D&B storage."},"children":[]}]}]}]}],"pointer":"/paths/~1jobs~1dnbimportjobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_93"}},"schemaId":"schema_93","pointer":"/paths/~1jobs~1dnbimportjobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/jobs/dnbimportjobs","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","example":"Process vendor data.","schemaId":"components/schemas/JobName"},{"name":"description","in":"query","example":"I started this job to improve quality of our data.","schemaId":"components/schemas/JobDescription"},{"name":"dnbUser","in":"query","example":"username","schemaId":"schema_89"},{"name":"dnbPassword","in":"query","example":"password","schemaId":"schema_90"},{"name":"featuresOn","in":"query","required":false,"schemaId":"schema_91"},{"name":"dnbDataSource","in":"query","example":"DNB_MASTER_DATA_BASIC","schemaId":"components/schemas/DnbStorageTechnicalKeyParam"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_93"}},"responseCodes":["200","400"],"pointer":"/jobs/dnbimportjobs","href":"dnb-storages/paths/~1jobs~1dnbimportjobs/post","summary":"Start DNB Import Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"schema_93","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_93"}},"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/DnbImportJob"}},"schemaId":"components/schemas/DnbImportJob"},{"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/~1jobs~1dnbimportjobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DnbImportJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DnbImportJob"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dnb-storages/paths/~1jobs~1dnbimportjobs/post"}],"panels":[]}]},"httpPath":"/jobs/dnbimportjobs"},{"label":"Poll DNB Import Job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1jobs~1dnbimportjobs~1{id}/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1jobs~1dnbimportjobs~1{id}/get","metadata":{"seo":{"title":"Poll DNB Import Job","description":"After you have started a D&B import job, you will receive a job id in the response. {   \"id\" : \"<ID>\" }Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can see the results in the D&B storage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Poll DNB Import Job","isWebhook":false,"pointer":"/paths/~1jobs~1dnbimportjobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll DNB Import Job","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":"After you have started a D&B import job, you will receive a job id in the response. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{   \"id\" : \"<ID>\" }"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can see the results in the D&B storage."},"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_29","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the D&B import job."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1jobs~1dnbimportjobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/jobs/dnbimportjobs/{id}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"35f23c03-1c22-45fe-9484-3ffe769325de","schemaId":"components/schemas/JobId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/jobs/dnbimportjobs/{id}","href":"dnb-storages/paths/~1jobs~1dnbimportjobs~1{id}/get","summary":"Poll DNB Import Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/DnbImportJob"}},"schemaId":"components/schemas/DnbImportJob"}],"pointer":"/paths/~1jobs~1dnbimportjobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DnbImportJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DnbImportJob"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dnb-storages/paths/~1jobs~1dnbimportjobs~1{id}/get"}],"panels":[]}]},"httpPath":"/jobs/dnbimportjobs/{id}"},{"label":"Create LOD File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1jobs~1dnbcreatelodjobs/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1jobs~1dnbcreatelodjobs/post","metadata":{"seo":{"title":"Create LOD File","description":"For all data mirrors configured for an organization, read Business Partners identifiers with type DUNS_ID and create a listof the DUNS file. This file is used to initialize the D&B Monitoring process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create LOD File","isWebhook":false,"pointer":"/paths/~1jobs~1dnbcreatelodjobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create LOD File","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":"For all data mirrors configured for an organization, read Business Partners identifiers with type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUNS_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and create a list"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the DUNS file. This file is used to initialize the D&B Monitoring process."},"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":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DnbLodJobRequest"}},"schemaId":"components/schemas/DnbLodJobRequest","pointer":"/paths/~1jobs~1dnbcreatelodjobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/jobs/dnbcreatelodjobs","servers":[{"url":"https://api.cdq.com/data-exchange/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/DnbLodJobRequest"}},"responseCodes":["200","400"],"pointer":"/jobs/dnbcreatelodjobs","href":"dnb-storages/paths/~1jobs~1dnbcreatelodjobs/post","summary":"Create LOD File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/DnbLodJobRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DnbLodJobRequest"}},"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/DnbCreateLODJob"}},"schemaId":"components/schemas/DnbCreateLODJob"},{"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/~1jobs~1dnbcreatelodjobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DnbCreateLODJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DnbCreateLODJob"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dnb-storages/paths/~1jobs~1dnbcreatelodjobs/post"}],"panels":[]}]},"httpPath":"/jobs/dnbcreatelodjobs"},{"label":"Poll DNB LOD Job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1jobs~1dnbcreatelodjobs~1{id}/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/dnb-storages/paths/~1jobs~1dnbcreatelodjobs~1{id}/get","metadata":{"seo":{"title":"Poll DNB LOD Job","description":"After you have started a D&B LOD job, you will receive a job id in the response. {   \"id\" : \"<ID>\" }Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can see the results in the attachments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Poll DNB LOD Job","isWebhook":false,"pointer":"/paths/~1jobs~1dnbcreatelodjobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll DNB LOD Job","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":"After you have started a D&B LOD job, you will receive a job id in the response. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{   \"id\" : \"<ID>\" }"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can see the results in the attachments."},"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_29","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the D&B Create LOD job."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1jobs~1dnbcreatelodjobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/jobs/dnbcreatelodjobs/{id}","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"35f23c03-1c22-45fe-9484-3ffe769325de","schemaId":"components/schemas/JobId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/jobs/dnbcreatelodjobs/{id}","href":"dnb-storages/paths/~1jobs~1dnbcreatelodjobs~1{id}/get","summary":"Poll DNB LOD Job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/DnbCreateLODJob"}},"schemaId":"components/schemas/DnbCreateLODJob"}],"pointer":"/paths/~1jobs~1dnbcreatelodjobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DnbCreateLODJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DnbCreateLODJob"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dnb-storages/paths/~1jobs~1dnbcreatelodjobs~1{id}/get"}],"panels":[]}]},"httpPath":"/jobs/dnbcreatelodjobs/{id}"}],"content":{"contentType":"group","meta":{"name":"DNB Storages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DNB Storages","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for creating, retrieving, updating and deleting DNB storage, as well as managing associated \ndata sources and data monitors."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/dnbstorages/dnbrecords","summary":"List DNB Records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dnb-storages/paths/~1v4~1dnbstorages~1dnbrecords/get","deprecated":false},{"title":"/v4/dnbstorages/fetch","summary":"Fetch DNB Record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dnb-storages/paths/~1v4~1dnbstorages~1fetch/post","deprecated":false},{"title":"/jobs/dnbimportjobs","summary":"Start DNB Import Job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dnb-storages/paths/~1jobs~1dnbimportjobs/post","deprecated":false},{"title":"/jobs/dnbimportjobs/{id}","summary":"Poll DNB Import Job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dnb-storages/paths/~1jobs~1dnbimportjobs~1{id}/get","deprecated":false},{"title":"/jobs/dnbcreatelodjobs","summary":"Create LOD File","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dnb-storages/paths/~1jobs~1dnbcreatelodjobs/post","deprecated":false},{"title":"/jobs/dnbcreatelodjobs/{id}","summary":"Poll DNB LOD Job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dnb-storages/paths/~1jobs~1dnbcreatelodjobs~1{id}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Files","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/files","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/files","items":[{"label":"Request File Upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/files/paths/~1files~1upload/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/files/paths/~1files~1upload/post","metadata":{"seo":{"title":"Request File Upload","description":"Create a file in the file storage using the url provided. Maximum allowed file size is 5GB."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Request File Upload","isWebhook":false,"pointer":"/paths/~1files~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request File Upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a file in the file storage using the url provided. Maximum allowed file size is 5GB."},{"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/FileUploadRequest"}},"schemaId":"components/schemas/FileUploadRequest","pointer":"/paths/~1files~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/files/upload","servers":[{"url":"https://api.cdq.com/data-exchange/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/FileUploadRequest"}},"responseCodes":["200","400","403"],"pointer":"/files/upload","href":"files/paths/~1files~1upload/post","summary":"Request File Upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/FileUploadRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileUploadRequest"}},"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/FileUploadResult"}},"schemaId":"components/schemas/FileUploadResult"},{"code":"400","description":"Bad Request."},{"code":"403","description":"Forbidden."}],"pointer":"/paths/~1files~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileUploadResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadResult"}}},{"code":"400"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/paths/~1files~1upload/post"}],"panels":[]}]},"httpPath":"/files/upload"},{"label":"Request Files Delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/files/paths/~1files/delete","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/files/paths/~1files/delete","metadata":{"seo":{"title":"Request Files Delete","description":"Delete files in the customer-uploads directory using the provided urls."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Request Files Delete","isWebhook":false,"pointer":"/paths/~1files/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Files Delete","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete files in the customer-uploads directory using the provided urls."},{"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":"url","in":"query","schemaId":"schema_94","description":"Url of the file to delete.","required":true}],"pointer":"/paths/~1files/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/files","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"url","in":"query","required":true,"schemaId":"schema_94"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/files","href":"files/paths/~1files/delete","summary":"Request Files Delete"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/FileDeleteResponse"}},"schemaId":"components/schemas/FileDeleteResponse"},{"code":"400","description":"Bad Request."}],"pointer":"/paths/~1files/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileDeleteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileDeleteResponse"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/paths/~1files/delete"}],"panels":[]}]},"httpPath":"/files"},{"label":"List All Resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/files/paths/~1files~1resources/get","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/files/paths/~1files~1resources/get","metadata":{"seo":{"title":"List All Resources","description":"Returns list of all resources, which are available at the specific url path."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List All Resources","isWebhook":false,"pointer":"/paths/~1files~1resources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of all resources, which are available at the specific url path."},{"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":"url","in":"query","schemaId":"schema_95","description":"Path of requested directory for which resources should be listed."},{"name":"startAfter","in":"query","schemaId":"schema_96","description":"Continuation token. Encoded path from which the listing resources should be started."},{"name":"limit","in":"query","schemaId":"schema_97","description":"Allowed maximum elements."}],"pointer":"/paths/~1files~1resources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/resources","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[],"query":[{"name":"url","in":"query","example":"requestedDirectory/ or requestedDirectory/otherDirectory","schemaId":"schema_95"},{"name":"startAfter","in":"query","required":false,"example":"1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u","schemaId":"schema_96"},{"name":"limit","in":"query","required":false,"example":"200","schemaId":"schema_97"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/files/resources","href":"files/paths/~1files~1resources/get","summary":"List All Resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/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/ResourcesListResult"}},"schemaId":"components/schemas/ResourcesListResult"},{"code":"400","description":"Bad Request."}],"pointer":"/paths/~1files~1resources/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourcesListResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourcesListResult"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/paths/~1files~1resources/get"}],"panels":[]}]},"httpPath":"/files/resources"},{"label":"Request File Download","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/files/paths/~1files~1download/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/files/paths/~1files~1download/post","metadata":{"seo":{"title":"Request File Download","description":"Download file from CDQ Cloud."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Request File Download","isWebhook":false,"pointer":"/paths/~1files~1download/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request File Download","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download file from CDQ Cloud."},{"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/FileDownloadRequest"}},"schemaId":"components/schemas/FileDownloadRequest","pointer":"/paths/~1files~1download/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/files/download","servers":[{"url":"https://api.cdq.com/data-exchange/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/FileDownloadRequest"}},"responseCodes":["200","400"],"pointer":"/files/download","href":"files/paths/~1files~1download/post","summary":"Request File Download"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/FileDownloadRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileDownloadRequest"}},"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/FileDownloadResult"}},"schemaId":"components/schemas/FileDownloadResult"},{"code":"400","description":"Bad Request."}],"pointer":"/paths/~1files~1download/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileDownloadResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileDownloadResult"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/paths/~1files~1download/post"}],"panels":[]}]},"httpPath":"/files/download"}],"content":{"contentType":"group","meta":{"name":"Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Files","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for uploading, downloading and deleting files."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/files/upload","summary":"Request File Upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files/paths/~1files~1upload/post","deprecated":false},{"title":"/files","summary":"Request Files Delete","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/files/paths/~1files/delete","deprecated":false},{"title":"/files/resources","summary":"List All Resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/paths/~1files~1resources/get","deprecated":false},{"title":"/files/download","summary":"Request File Download","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files/paths/~1files~1download/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Mappers","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mappers","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mappers","items":[{"label":"Transform Records","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mappers/paths/~1v4~1datamapperdefinitions~1{id}~1transformbusinesspartners/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mappers/paths/~1v4~1datamapperdefinitions~1{id}~1transformbusinesspartners/post","metadata":{"seo":{"title":"Transform Records","description":"Use a Data Mapper Definition to transform a list of records into Business Partners."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Transform Records","isWebhook":false,"pointer":"/paths/~1v4~1datamapperdefinitions~1{id}~1transformBusinessPartners/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transform Records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use a Data Mapper Definition to transform a list of records into Business Partners."},{"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_73","description":"Data Mapper Definition ID.","required":true}],"pointer":"/paths/~1v4~1datamapperdefinitions~1{id}~1transformBusinessPartners/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnersTransformationRequest"}},"schemaId":"components/schemas/BusinessPartnersTransformationRequest","pointer":"/paths/~1v4~1datamapperdefinitions~1{id}~1transformBusinessPartners/post/requestBody","description":"Records"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/datamapperdefinitions/{id}/transformBusinessPartners","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6440dba32b30176c5917b1b7","schemaId":"components/schemas/DataMapperDefinitionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnersTransformationRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v4/datamapperdefinitions/{id}/transformBusinessPartners","href":"data-mappers/paths/~1v4~1datamapperdefinitions~1{id}~1transformbusinesspartners/post","summary":"Transform Records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnersTransformationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnersTransformationRequest"}},"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/BusinessPartnersTransformationResult"}},"schemaId":"components/schemas/BusinessPartnersTransformationResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v4~1datamapperdefinitions~1{id}~1transformBusinessPartners/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnersTransformationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnersTransformationResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-mappers/paths/~1v4~1datamapperdefinitions~1{id}~1transformbusinesspartners/post"}],"panels":[]}]},"httpPath":"/v4/datamapperdefinitions/{id}/transformBusinessPartners"},{"label":"Transform Business Partners","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mappers/paths/~1v4~1datamapperdefinitions~1{id}~1transformfields/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mappers/paths/~1v4~1datamapperdefinitions~1{id}~1transformfields/post","metadata":{"seo":{"title":"Transform Business Partners","description":"Use a Data Mapper Definition to transform a list of Business Partners into key-value lists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Transform Business Partners","isWebhook":false,"pointer":"/paths/~1v4~1datamapperdefinitions~1{id}~1transformFields/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transform Business Partners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use a Data Mapper Definition to transform a list of Business Partners into key-value lists."},{"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_73","description":"Data Mapper Definition ID.","required":true}],"pointer":"/paths/~1v4~1datamapperdefinitions~1{id}~1transformFields/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldsTransformationRequest"}},"schemaId":"components/schemas/FieldsTransformationRequest","pointer":"/paths/~1v4~1datamapperdefinitions~1{id}~1transformFields/post/requestBody","description":"Records"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/datamapperdefinitions/{id}/transformFields","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6440dba32b30176c5917b1b7","schemaId":"components/schemas/DataMapperDefinitionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FieldsTransformationRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v4/datamapperdefinitions/{id}/transformFields","href":"data-mappers/paths/~1v4~1datamapperdefinitions~1{id}~1transformfields/post","summary":"Transform Business Partners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/FieldsTransformationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldsTransformationRequest"}},"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/FieldsTransformationResult"}},"schemaId":"components/schemas/FieldsTransformationResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v4~1datamapperdefinitions~1{id}~1transformFields/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldsTransformationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldsTransformationResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-mappers/paths/~1v4~1datamapperdefinitions~1{id}~1transformfields/post"}],"panels":[]}]},"httpPath":"/v4/datamapperdefinitions/{id}/transformFields"},{"label":"Transform Records","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mappers/paths/~1v3~1datamappers~1{id}~1transformbusinesspartners/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mappers/paths/~1v3~1datamappers~1{id}~1transformbusinesspartners/post","metadata":{"seo":{"title":"Transform Records","description":"Use a Data Mapper Definition to transform a list of records into Business Partners."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Transform Records","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1datamappers~1{id}~1transformBusinessPartners/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transform Records","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use a Data Mapper Definition to transform a list of records into Business Partners."},{"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_73","description":"ID of the Data Mapper Definition","required":true}],"pointer":"/paths/~1v3~1datamappers~1{id}~1transformBusinessPartners/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnersTransformationRequest"}},"schemaId":"components/schemas/BusinessPartnersTransformationRequest","pointer":"/paths/~1v3~1datamappers~1{id}~1transformBusinessPartners/post/requestBody","description":"Records."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/datamappers/{id}/transformBusinessPartners","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6440dba32b30176c5917b1b7","schemaId":"components/schemas/DataMapperDefinitionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessPartnersTransformationRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/datamappers/{id}/transformBusinessPartners","href":"data-mappers/paths/~1v3~1datamappers~1{id}~1transformbusinesspartners/post","summary":"Transform Records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/BusinessPartnersTransformationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessPartnersTransformationRequest"}},"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/BusinessPartnersTransformationResult"}},"schemaId":"components/schemas/BusinessPartnersTransformationResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v3~1datamappers~1{id}~1transformBusinessPartners/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessPartnersTransformationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessPartnersTransformationResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-mappers/paths/~1v3~1datamappers~1{id}~1transformbusinesspartners/post"}],"panels":[]}]},"httpPath":"/v3/datamappers/{id}/transformBusinessPartners"},{"label":"Transform Business Partners","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mappers/paths/~1v3~1datamappers~1{id}~1transformfields/post","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/data-mappers/paths/~1v3~1datamappers~1{id}~1transformfields/post","metadata":{"seo":{"title":"Transform Business Partners","description":"Use a Data Mapper Definition to transform a list of Business Partners into key-value lists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Transform Business Partners","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1datamappers~1{id}~1transformFields/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transform Business Partners","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use a Data Mapper Definition to transform a list of Business Partners into key-value lists."},{"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_73","description":"ID of the Data Mapper Definition.","required":true}],"pointer":"/paths/~1v3~1datamappers~1{id}~1transformFields/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldsTransformationRequest"}},"schemaId":"components/schemas/FieldsTransformationRequest","pointer":"/paths/~1v3~1datamappers~1{id}~1transformFields/post/requestBody","description":"Records"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/datamappers/{id}/transformFields","servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"6440dba32b30176c5917b1b7","schemaId":"components/schemas/DataMapperDefinitionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FieldsTransformationRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/datamappers/{id}/transformFields","href":"data-mappers/paths/~1v3~1datamappers~1{id}~1transformfields/post","summary":"Transform Business Partners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.cdq.com/data-exchange/rest","description":"Production"}],"schemaId":"components/schemas/FieldsTransformationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldsTransformationRequest"}},"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/FieldsTransformationResult"}},"schemaId":"components/schemas/FieldsTransformationResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v3~1datamappers~1{id}~1transformFields/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldsTransformationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldsTransformationResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-mappers/paths/~1v3~1datamappers~1{id}~1transformfields/post"}],"panels":[]}]},"httpPath":"/v3/datamappers/{id}/transformFields"}],"content":{"contentType":"group","meta":{"name":"Data Mappers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Mappers","showPageActions":true},{"nodeType":"markdoc","content":"Provides functionalities for transforming raw data into structured Business Partner data using predefined data mapper \ndefinitions. This allows users to convert various data formats into a standardized format suitable for processing \nand analysis."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/datamapperdefinitions/{id}/transformBusinessPartners","summary":"Transform Records","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-mappers/paths/~1v4~1datamapperdefinitions~1{id}~1transformbusinesspartners/post","deprecated":false},{"title":"/v4/datamapperdefinitions/{id}/transformFields","summary":"Transform Business Partners","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-mappers/paths/~1v4~1datamapperdefinitions~1{id}~1transformfields/post","deprecated":false},{"title":"/v3/datamappers/{id}/transformBusinessPartners","summary":"Transform Records","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/data-mappers/paths/~1v3~1datamappers~1{id}~1transformbusinesspartners/post","deprecated":true},{"title":"/v3/datamappers/{id}/transformFields","summary":"Transform Business Partners","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/data-mappers/paths/~1v3~1datamappers~1{id}~1transformfields/post","deprecated":true}]}]}]}]}},{"type":"group","label":"Event Store","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/event-store","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/event-store","items":[],"content":{"contentType":"group","meta":{"name":"Event Store"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event Store","showPageActions":true}],"panels":[{"children":[]}]}]}},{"type":"group","label":"Update Classification","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/update-classification","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/update-classification","items":[],"content":{"contentType":"group","meta":{"name":"Update Classification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Classification","showPageActions":true}],"panels":[{"children":[]}]}]}},{"type":"group","label":"CDQ Community Pool","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/cdq-community-pool","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/cdq-community-pool","items":[],"content":{"contentType":"group","meta":{"name":"CDQ Community Pool"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CDQ Community Pool","showPageActions":true}],"panels":[{"children":[]}]}]}},{"type":"group","label":"Identity Link","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/identity-link","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/identity-link","items":[],"content":{"contentType":"group","meta":{"name":"Identity Link"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identity Link","showPageActions":true}],"panels":[{"children":[]}]}]}},{"type":"group","label":"Business Partner Storages (None Public)","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages-(none-public)","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/business-partner-storages-(none-public)","items":[],"content":{"contentType":"group","meta":{"name":"Business Partner Storages (None Public)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Business Partner Storages (None Public)","showPageActions":true}],"panels":[{"children":[]}]}]}},{"type":"group","label":"Restart Monitor Job","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/restart-monitor-job","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/restart-monitor-job","items":[],"content":{"contentType":"group","meta":{"name":"Restart Monitor Job"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restart Monitor Job","showPageActions":true}],"panels":[{"children":[]}]}]}},{"type":"group","label":"Cache","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/cache","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/cache","items":[],"content":{"contentType":"group","meta":{"name":"Cache"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cache","showPageActions":true}],"panels":[{"children":[]}]}]}},{"type":"group","label":"Configuration","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/configuration","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/configuration","items":[],"content":{"contentType":"group","meta":{"name":"Configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configuration","showPageActions":true}],"panels":[{"children":[]}]}]}},{"type":"group","label":"Event Stores","link":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/event-stores","routeSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4/event-stores","items":[],"content":{"contentType":"group","meta":{"name":"Event Stores"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event Stores","showPageActions":true}],"panels":[{"children":[]}]}]}}],"store":{"schemaStore":{"components/schemas/BusinessPartner":{"id":"components/schemas/BusinessPartner","kind":"json-schema","title":"BusinessPartner","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization which has some degree of involvement with another organization's business dealings. Typically, a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company's Business Partner is another company in the role of a customer, a supplier, a vendor, or a service provider."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the CDL context, the Business Partner is the core managed entity. A Business Partner is globally uniquely identifiable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a Business Partner."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the detailed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataModel:CDQ/Business_Partner"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Model"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on CDQ wiki."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerId"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"lastModifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"dataSource":{"$ref":"#/components/schemas/BusinessPartnerDataSource"},"disclosed":{"$ref":"#/components/schemas/BusinessPartnerDisclosed"},"updateMonitoring":{"$ref":"#/components/schemas/BusinessPartnerUpdateMonitoring"},"updateCommercialMonitoring":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enabling update commercial monitoring has 2 possibilities:"},"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":"via Data Mapper Definition: include mapping of updateCommercialMonitoring in the Data Mapper Definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via direct Business Partner model upload: fill complete Business Partner model and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateCommercialMonitoring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null/undefined "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateCommercialMonitoring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in protection of this setup from the previous upsert."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Empty or filled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateCommercialMonitoring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in data transition that may link or unlink to / from respective"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commercial Reference Data Source"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: follow the approach that is currently used in your storage integration."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BusinessPartnerUpdateCommercialMonitoring"}},"metadata":{"$ref":"#/components/schemas/BusinessPartnerMetadata"},"record":{"$ref":"#/components/schemas/BusinessPartnerRecord"},"additionalInformation":{"type":"array","description":"List of additional information.","items":{"$ref":"#/components/schemas/AdditionalInformation"}},"names":{"type":"array","description":"List of names.","items":{"$ref":"#/components/schemas/Name"}},"legalForm":{"$ref":"#/components/schemas/LegalForm"},"identifiers":{"type":"array","description":"List of Identifiers.","items":{"$ref":"#/components/schemas/Identifier"}},"categories":{"type":"array","description":"List of Categories.","items":{"$ref":"#/components/schemas/BusinessPartnerCategory"}},"status":{"$ref":"#/components/schemas/BusinessPartnerStatus"},"profile":{"$ref":"#/components/schemas/PartnerProfile"},"relations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of Relations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Insert or update Business Partner Relations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relations that are not listed in the request and start in the current business partner, are marked as INACTIVE."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In D&B storages, only not-listed relations of class "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_PARTNER_RELATION_CLASS_DNB_HIERARCHY' and one of type "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIRECT_LEGAL_RELATION"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DOMESTIC_LEGAL_ULTIMATE_RELATION"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"or"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GLOBAL_LEGAL_ULTIMATE_RELATION"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":", are marked as "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE`."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the wiki's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataModel:CDQ/Business_Partner/Business_Partner_Relation/Business_Partner_Relation_Class"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Relation Class"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataModel:CDQ/Business_Partner/Business_Partner_Relation/Business_Partner_Relation_Type"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Partner Relation Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details about the mentioned types and classes."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BusinessPartnerRelation"}},"types":{"type":"array","description":"List of Types.","items":{"$ref":"#/components/schemas/BusinessPartnerType"}},"addresses":{"type":"array","description":"List of Addresses.","items":{"$ref":"#/components/schemas/Address"}},"bankAccounts":{"type":"array","description":"List of Bank Accounts.","items":{"$ref":"#/components/schemas/BankAccount"}},"externalContext":{"$ref":"#/components/schemas/ExternalContext"}}}},"components/schemas/BusinessPartnerUpdateMonitoring":{"id":"components/schemas/BusinessPartnerUpdateMonitoring","kind":"json-schema","title":"BusinessPartnerUpdateMonitoring","data":{"type":"boolean","description":"A flag to indicate whether the Business Partner should receive updates from non-commercial Reference Data Sources or not.\nIf 'true' this Business Partner will receive updates since the change from 'false'.\nIf 'false' this Business Partner will not receive any new updates since the change.\nIf not provided, the previous value will not be changed. By default, Update Monitoring is activated.\n","example":"true"}},"components/schemas/BusinessPartnerUpdateCommercialMonitoring":{"id":"components/schemas/BusinessPartnerUpdateCommercialMonitoring","kind":"json-schema","title":"BusinessPartnerUpdateCommercialMonitoring","data":{"type":"object","description":"An indicator whether the Business Partner should receive updates from specific commercial Reference Data Source or not.","required":["type","value"],"properties":{"type":{"$ref":"#/components/schemas/BusinessPartnerUpdateCommercialMonitoringType"},"value":{"$ref":"#/components/schemas/BusinessPartnerUpdateCommercialMonitoringValue"}}}},"components/schemas/BusinessPartnerUpdateCommercialMonitoringType":{"id":"components/schemas/BusinessPartnerUpdateCommercialMonitoringType","kind":"json-schema","title":"BusinessPartnerUpdateCommercialMonitoringType","data":{"type":"object","description":"Type of the Business Partner Update Commercial Monitoring.","properties":{"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerUpdateCommercialMonitoringTypeTechnicalKey"}}}},"components/schemas/BusinessPartnerUpdateCommercialMonitoringTypeTechnicalKey":{"id":"components/schemas/BusinessPartnerUpdateCommercialMonitoringTypeTechnicalKey","kind":"json-schema","title":"BusinessPartnerUpdateCommercialMonitoringTypeTechnicalKey","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 commercial Reference Data Source that from which the Business Partner should receive updates. 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":"link","inline":true,"attributes":{"href":"https://directplus.documentation.dnb.com/openAPI.html?apiID=cmpelkv2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNB"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataSource:DNB"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wiki"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://directplus.documentation.dnb.com/DataBlocks.html?apiID=dataBlocks&blockIDs=companyinfo_L1_v1"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNB_MASTER_DATA_BASIC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataSource:DNB.MASTER.DATA.BASIC"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wiki"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://directplus.documentation.dnb.com/DataBlocks.html?apiID=dataBlocks&blockIDs=companyinfo_L2_v1,principalscontacts_L2_v2,hierarchyconnections_L1_v1"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNB_MASTER_DATA_EXTENDED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataSource:DNB.MASTER.DATA.EXTENDED"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wiki"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://directplus.documentation.dnb.com/openAPI.html?apiID=lnkeli"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNB_LINKAGE_LNKELI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataSource:DNB.LINKAGE.LNKELI"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wiki"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}],"example":"DNB"}},"components/schemas/BusinessPartnerUpdateCommercialMonitoringValue":{"id":"components/schemas/BusinessPartnerUpdateCommercialMonitoringValue","kind":"json-schema","title":"BusinessPartnerUpdateCommercialMonitoringValue","data":{"type":"boolean","default":false,"description":"Value of the Business Partner Update Commercial Monitoring.\nIf 'true', the monitoring of this record will be activated on the commercial data source and this Business Partner will receive updates from that source.\nIf 'false', the monitoring of this record will be deactivated in the commercial data source and this Business Partner will not receive any new updates from that source.\nBy default, Update Commercial Monitoring is NOT activated.\n","example":"true"}},"components/schemas/ExternalContext":{"id":"components/schemas/ExternalContext","kind":"json-schema","title":"ExternalContext","data":{"type":"object","description":"Represents additional context information that is external to the main Business Partner data.","properties":{"identifiers":{"type":"array","description":"List of Identifiers.","items":{"$ref":"#/components/schemas/ExternalContextIdentifier"}}}}},"components/schemas/ExternalContextIdentifier":{"id":"components/schemas/ExternalContextIdentifier","kind":"json-schema","title":"ExternalContextIdentifier","data":{"type":"object","description":"An identifier of the External Context.","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":"Type of the External Context Identifier.","properties":{"technicalKey":{"$ref":"#/components/schemas/ExternalContextIdentifierTypeTechnicalKey"}}}},"components/schemas/BankAccount":{"id":"components/schemas/BankAccount","kind":"json-schema","title":"BankAccount","data":{"type":"object","description":"A bank account is a financial account maintained by a bank for a customer. A bank account can be a deposit account, a credit card, or any other type of account offered by a financial institution.","properties":{"internationalBankAccountIdentifier":{"$ref":"#/components/schemas/InternationalBankAccountIdentifier"},"internationalBankIdentifier":{"$ref":"#/components/schemas/InternationalBankIdentifier"},"nationalBankAccountIdentifier":{"$ref":"#/components/schemas/NationalBankAccountIdentifier"},"nationalBankIdentifier":{"$ref":"#/components/schemas/NationalBankIdentifier"},"countryCode":{"$ref":"#/components/schemas/BankAccountCountryCode"},"vendorPaymentSummary":{"$ref":"#/components/schemas/VendorPaymentSummary"}}}},"components/schemas/VendorPaymentSummary":{"id":"components/schemas/VendorPaymentSummary","kind":"json-schema","title":"VendorPaymentSummary","data":{"type":"object","description":"Vendor Payment Summary.","properties":{"firstPaymentDate":{"$ref":"#/components/schemas/FirstPaymentDate"},"lastPaymentDate":{"$ref":"#/components/schemas/LastPaymentDate"},"numberOfPayments":{"$ref":"#/components/schemas/NumberOfPayments"}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"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":{"id":{"type":"string","description":"ID of the address.","example":"0001"},"externalId":{"$ref":"#/components/schemas/AddressExternalId"},"cdqId":{"$ref":"#/components/schemas/AddressCdqId"},"version":{"$ref":"#/components/schemas/AddressVersion"},"identifyingName":{"$ref":"#/components/schemas/AddressIdentifyingName"},"careOf":{"$ref":"#/components/schemas/CareOf"},"contexts":{"type":"array","description":"List of Address Contexts.","items":{"$ref":"#/components/schemas/AddressContext"}},"country":{"$ref":"#/components/schemas/Country"},"administrativeAreas":{"type":"array","description":"List of Administrative Areas.","items":{"$ref":"#/components/schemas/AdministrativeArea"}},"postCodes":{"type":"array","description":"List of Post Codes.","items":{"$ref":"#/components/schemas/PostCode"}},"localities":{"type":"array","description":"List of Localities.","items":{"$ref":"#/components/schemas/Locality"}},"thoroughfares":{"type":"array","description":"List of Thoroughfares.","items":{"$ref":"#/components/schemas/Thoroughfare"}},"premises":{"type":"array","description":"List of Premises.","items":{"$ref":"#/components/schemas/Premise"}},"postalDeliveryPoints":{"type":"array","description":"List of Postal Delivery Points.","items":{"$ref":"#/components/schemas/PostalDeliveryPoint"}},"geographicCoordinates":{"$ref":"#/components/schemas/GeographicCoordinates"},"types":{"type":"array","description":"List of Types.","items":{"$ref":"#/components/schemas/AddressType"}},"metadata":{"$ref":"#/components/schemas/AddressMetadata"}}}},"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"},"startNodeDataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"startNodeBusinessPartner":{"$ref":"#/components/schemas/RelationBusinessPartner"},"endNode":{"$ref":"#/components/schemas/BusinessPartnerRelationEndNode"},"endNodeDataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"endNodeBusinessPartner":{"$ref":"#/components/schemas/RelationBusinessPartner"},"deactivatedAt":{"$ref":"#/components/schemas/BusinessPartnerRelationDeactivatedAt"}}}},"components/schemas/BusinessPartnerRelationDeactivatedAt":{"id":"components/schemas/BusinessPartnerRelationDeactivatedAt","kind":"json-schema","title":"BusinessPartnerRelationDeactivatedAt","data":{"type":"string","description":"Describe when this relationship was deactivated. Read only.","example":"2026-10-21T13:37:18Z"}},"components/schemas/RelationBusinessPartner":{"id":"components/schemas/RelationBusinessPartner","kind":"json-schema","title":"RelationBusinessPartner","data":{"type":"object","description":"Business Partner hierarchy, or any other kind of relation between two Business Partner entities.","properties":{"names":{"type":"array","description":"List of Business Partner names.","items":{"$ref":"#/components/schemas/Name"}},"addresses":{"type":"array","description":"List of Business Partner addresses.","items":{"$ref":"#/components/schemas/RelationAddress"}},"types":{"type":"array","description":"List of Business Partner types.","items":{"$ref":"#/components/schemas/BusinessPartnerType"}},"identifiers":{"type":"array","description":"List of Business Partner identifiers.","items":{"$ref":"#/components/schemas/RelationIdentifier"}},"metadata":{"type":"object","description":"Metadata of the Business Partner relation.","properties":{"identityLinks":{"type":"array","description":"List of Identity Links.","items":{"$ref":"#/components/schemas/IdentityLink"}}}}}}},"components/schemas/RelationAddress":{"id":"components/schemas/RelationAddress","kind":"json-schema","title":"RelationAddress","data":{"type":"object","description":"Address of the Business Partner.","properties":{"country":{"$ref":"#/components/schemas/Country"},"postCodes":{"type":"array","description":"List of Post Codes.","items":{"$ref":"#/components/schemas/PostCode"}},"localities":{"type":"array","description":"List of Localities.","items":{"$ref":"#/components/schemas/Locality"}},"thoroughfares":{"type":"array","description":"List of Thoroughfares.","items":{"$ref":"#/components/schemas/Thoroughfare"}}}}},"components/schemas/RelationIdentifier":{"id":"components/schemas/RelationIdentifier","kind":"json-schema","title":"RelationIdentifier","data":{"type":"object","description":"Identifies a Business Partner in a given context uniquely such as a VAT identification number.","properties":{"type":{"$ref":"#/components/schemas/IdentifierType"},"value":{"$ref":"#/components/schemas/IdentifierValue"}}}},"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"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerRelationTypeTechnicalKey"},"url":{"$ref":"#/components/schemas/BusinessPartnerRelationTypeUrl"}}}},"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"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerRelationClassTechnicalKey"},"url":{"$ref":"#/components/schemas/BusinessPartnerRelationClassUrl"}}}},"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/BusinessPartnerTypeTechnicalKeyParam":{"id":"components/schemas/BusinessPartnerTypeTechnicalKeyParam","kind":"json-schema","title":"BusinessPartnerTypeTechnicalKeyParam","data":{"type":"string","description":"Technical key of the Business Partner Type.","example":"LEGAL_ENTITY","enum":["BP_ADDRESS","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","UNKNOWN","BRAND"],"x-enumDescritions":{"BP_ADDRESS":"Business Partner Address","LEGAL_ENTITY":"Legal Entity","ORGANIZATIONAL_UNIT":"Organizational Unit","UNKNOWN":"Unknown","BRAND":"Brand"}}},"components/schemas/BusinessPartnerVersionNumber":{"id":"components/schemas/BusinessPartnerVersionNumber","kind":"json-schema","title":"BusinessPartnerVersionNumber","data":{"type":"integer","description":"Version number of the Business Partner. The version number is incremented with each change in model data of the Business Partner.","example":1}},"components/schemas/BusinessPartnerUpsertVersionNumber":{"id":"components/schemas/BusinessPartnerUpsertVersionNumber","kind":"json-schema","title":"BusinessPartnerUpsertVersionNumber","data":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version number of the Business Partner. The version number is incremented with each upsert of the Business Partner."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Distinguished from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as it is incremented always when the Business Partner is upserted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"regardless of whether the model data of the Business Partner has been changed or not."},"children":[]}]}]}],"example":1}},"components/schemas/BusinessPartnerDocumentStatus":{"id":"components/schemas/BusinessPartnerDocumentStatus","kind":"json-schema","title":"BusinessPartnerDocumentStatus","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":{"recordStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Record validity 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":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The business partner is accepted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The business partner is rejected."},"children":[]}]}]}]}],"example":"ACCEPTED"},"explanations":{"type":"array","description":"List of Explanations.","items":{"type":"string","description":"Detailed information about the status.","example":"No errors have been found"}}}}},"components/schemas/SharingStatus":{"id":"components/schemas/SharingStatus","kind":"json-schema","title":"SharingStatus","data":{"type":"object","description":"Business Partner Sharing Statuses.","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":"Sharing 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":"ERRONEOUS_INFORMATION_FOR_LINKAGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The business partner violates at least one rule for required parameters defined by collaboration linkage strategy so can not be shared."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERRONEOUS_RECORD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The business partner violates at least one rule that leads to an overall data validation result of ERROR, and can not be shared."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MISSING_INFORMATION_FOR_LINKAGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The business partner has missing at least one of required parameters defined by collaboration linkage strategy so can not be shared."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NATURAL_PERSON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The record was identified as natural person and is therefore excluded from the sharing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_LINKAGE_DECISION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - As the matching result was uncertain the business partner is currently waiting to be reviewed before it can be shared."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESS_ISSUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - During the last attempt to share the business partner process issue occurred. This business partner will be processed again."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHARED_WITH_NO_MATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - No match could be found and therefore the business partner was added to the community pool as a new business partner."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHARED_WITH_CONFIDENT_MATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A confident match was found and therefore the business partner was linked to an existing business partner in the community pool."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHARED_WITH_NO_MATCH_BY_REVIEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Review decision has been made and the business partner was added to the community pool as a new business partner."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHARED_BY_REVIEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Review decision has been made and the business partner was linked to an existing business partner in the community pool."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNDER_CONSIDERATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The business partner will be considered for the sharing process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNDISCLOSED_RECORD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - During the last attempt to share the business partner it was marked as 'undisclosed' and for that reason not considered."},"children":[]}]}]}]}],"example":"SHARED_WITH_NO_MATCH"},"description":{"$ref":"#/components/schemas/SharingStatusDescription"}}}},"components/schemas/ProcessingLogResultStatus":{"id":"components/schemas/ProcessingLogResultStatus","kind":"json-schema","title":"ProcessingLogResultStatus","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Summary of processing log result processed for this Business Partner."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To enable processing log results, you need to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/data-exchange-api-v2/api-v2/data-monitors/paths/~1v2~1storages~1%7Bstorageid%7D~1datamonitors/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create data monitors"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this storage."},"children":[]}]}]}],"properties":{"processingLogId":{"$ref":"#/components/schemas/ProcessingLogId"},"triggerProcessedAt":{"$ref":"#/components/schemas/ProcessingLogResultStatusTriggerProcessedAt"},"triggerType":{"$ref":"#/components/schemas/ProcessingLogResultStatusTriggerType"},"trigger":{"$ref":"#/components/schemas/ProcessingLogResultStatusTrigger"},"jobProcessedAt":{"$ref":"#/components/schemas/ProcessingLogResultStatusJobProcessedAt"},"processedAt":{"$ref":"#/components/schemas/ProcessingLogResultStatusProcessedAt"},"status":{"$ref":"#/components/schemas/ProcessingLogResultStatusStatus"},"description":{"$ref":"#/components/schemas/ProcessingLogResultStatusDescription"},"processingStatus":{"$ref":"#/components/schemas/ProcessingStatus"}}}},"components/schemas/ProcessingLogResultStatusTriggerProcessedAt":{"id":"components/schemas/ProcessingLogResultStatusTriggerProcessedAt","kind":"json-schema","title":"ProcessingLogResultStatusTriggerProcessedAt","data":{"type":"string","description":"Time when this log result has been processed by trigger.","example":"2026-10-21T13:37:18Z"}},"components/schemas/ProcessingLogResultStatusJobProcessedAt":{"id":"components/schemas/ProcessingLogResultStatusJobProcessedAt","kind":"json-schema","title":"ProcessingLogResultStatusJobProcessedAt","data":{"type":"string","description":"Time when this log result has been processed by job.","example":"2026-10-21T13:37:18Z"}},"components/schemas/ProcessingLogResultStatusProcessedAt":{"id":"components/schemas/ProcessingLogResultStatusProcessedAt","kind":"json-schema","title":"ProcessingLogResultStatusProcessedAt","data":{"type":"string","description":"Time when this log result has been processed.","example":"2026-10-21T13:37:18Z"}},"components/schemas/ProcessingLogResultStatusTrigger":{"id":"components/schemas/ProcessingLogResultStatusTrigger","kind":"json-schema","title":"ProcessingLogResultStatusTrigger","data":{"description":"Processing trigger reason.","type":"object","properties":{"processedAt":{"$ref":"#/components/schemas/ProcessingLogResultStatusTriggerProcessedAt"},"provenance":{"$ref":"#/components/schemas/ProcessingLogResultStatusTriggerProvenance"},"type":{"$ref":"#/components/schemas/ProcessingLogResultStatusTriggerType"}}}},"components/schemas/ProcessingLogResultStatusTriggerProvenance":{"id":"components/schemas/ProcessingLogResultStatusTriggerProvenance","kind":"json-schema","title":"ProcessingLogResultStatusTriggerProvenance","data":{"description":"Processing trigger provenance.","type":"object","properties":{"name":{"$ref":"#/components/schemas/ProvenanceName"},"technicalKey":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"},"cdqId":{"$ref":"#/components/schemas/ProvenanceCdqId"}}}},"components/schemas/ProcessingLogResultStatusTriggerType":{"id":"components/schemas/ProcessingLogResultStatusTriggerType","kind":"json-schema","title":"ProcessingLogResultStatusTriggerType","data":{"type":"object","description":"Type of processing triggers.","properties":{"name":{"$ref":"#/components/schemas/ProcessingLogResultStatusTriggerTypeName"},"technicalKey":{"$ref":"#/components/schemas/ProcessingLogResultStatusTriggerTypeTechnicalKey"}}}},"components/schemas/ProcessingLogResultStatusTriggerTypeName":{"id":"components/schemas/ProcessingLogResultStatusTriggerTypeName","kind":"json-schema","title":"ProcessingLogResultStatusTriggerTypeName","data":{"type":"string","description":"Name of processing trigger reason.","example":"CREATED"}},"components/schemas/ProcessingLogResultStatusTriggerTypeTechnicalKey":{"id":"components/schemas/ProcessingLogResultStatusTriggerTypeTechnicalKey","kind":"json-schema","title":"ProcessingLogResultStatusTriggerTypeTechnicalKey","data":{"type":"string","description":"Technical Key of the processing trigger reason.","example":"CREATED"}},"components/schemas/ProcessingLogResultStatusTriggerTypeTechnicalKeyParam":{"id":"components/schemas/ProcessingLogResultStatusTriggerTypeTechnicalKeyParam","kind":"json-schema","title":"ProcessingLogResultStatusTriggerTypeTechnicalKeyParam","data":{"type":"string","description":"Technical Key of the processing trigger reason.","example":"CREATED","enum":["CREATED","UPDATED","REFERENCE_DATA_CHANGED","REFRESHED","JOB","INITIALIZED,","CONFIGURATION_MODIFIED","MANUALLY_FORCED","MONITORING_REENABLED"],"x-enumDescription":{"CREATED":"Business Partner has been created.","UPDATED":"Business Partner has been updated.","REFERENCE_DATA_CHANGED":"There was a change in referenced Business Partner from external Data Source.","REFRESHED":"Business Partner has been refreshed.","JOB":"evaluated via a job.","INITIALIZED":"Covers 2 use cases: data monitor has been created; data monitor has been reactivated and business partner didn't have processing log results before - it was created when monitor was deactivated.","CONFIGURATION_MODIFIED":"Configuration has been modified for scope, where business partner is considered.","MANUALLY_FORCED":"Processing of all business partners has been forced by customer.","MONITORING_REENABLED":"Data monitor has been enabled from disabled and business partner already had processing log results before."}}},"components/schemas/ProcessingLogResultStatusStatus":{"id":"components/schemas/ProcessingLogResultStatusStatus","kind":"json-schema","title":"ProcessingLogResultStatusStatus","data":{"type":"string","description":"Status of log result.","example":"INFO"}},"components/schemas/ProcessingLogResultStatusDescription":{"id":"components/schemas/ProcessingLogResultStatusDescription","kind":"json-schema","title":"ProcessingLogResultStatusDescription","data":{"type":"string","description":"Description of log result.","example":"Validation Level"}},"components/schemas/Name":{"id":"components/schemas/Name","kind":"json-schema","title":"Name","data":{"type":"object","description":"The name of a Business Partner.","properties":{"type":{"$ref":"#/components/schemas/NameType"},"value":{"$ref":"#/components/schemas/NameValue"},"shortName":{"$ref":"#/components/schemas/NameShortName"},"language":{"$ref":"#/components/schemas/Language"},"details":{"type":"array","items":{"$ref":"#/components/schemas/NameDetail"}}}}},"components/schemas/NameDetail":{"id":"components/schemas/NameDetail","kind":"json-schema","title":"NameDetail","data":{"type":"object","description":"Additional information on a Business Partner's name.","properties":{"value":{"$ref":"#/components/schemas/NameDetailValue"},"type":{"$ref":"#/components/schemas/NameDetailType"}}}},"components/schemas/NameDetailType":{"id":"components/schemas/NameDetailType","kind":"json-schema","title":"NameDetailType","data":{"type":"object","description":"Type of additional information on a Business Partner's name.","properties":{"name":{"$ref":"#/components/schemas/NameDetailTypeName"},"url":{"$ref":"#/components/schemas/NameDetailTypeUrl"},"technicalKey":{"$ref":"#/components/schemas/NameDetailTypeTechnicalKey"}}}},"components/schemas/NameType":{"id":"components/schemas/NameType","kind":"json-schema","title":"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/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/LegalForm":{"id":"components/schemas/LegalForm","kind":"json-schema","title":"LegalForm","data":{"type":"object","description":"The legal form is the form it takes in the eyes of the law governing it. The legal form of a company is the general \ntype it may legally use to identify itself according to the local, regional, national, or international law governing \nit. This is normally reflected in the ending abbreviation after the company's name (e.g. AG, Inc., LLC, S.A.).\n","properties":{"name":{"$ref":"#/components/schemas/LegalFormName"},"url":{"$ref":"#/components/schemas/LegalFormUrl"},"technicalKey":{"$ref":"#/components/schemas/LegalFormTechnicalKey"},"language":{"$ref":"#/components/schemas/Language"},"mainAbbreviation":{"$ref":"#/components/schemas/LegalFormMainAbbreviation"},"categories":{"type":"array","description":"List of Legal Form Categories.","items":{"$ref":"#/components/schemas/LegalFormCategory"}}}}},"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/Identifier":{"id":"components/schemas/Identifier","kind":"json-schema","title":"Identifier","data":{"type":"object","description":"Identifies a Business Partner in a given context uniquely such as a VAT identification number.","properties":{"type":{"$ref":"#/components/schemas/IdentifierType"},"value":{"$ref":"#/components/schemas/IdentifierValue"},"issuingBody":{"$ref":"#/components/schemas/IssuingBody"},"status":{"$ref":"#/components/schemas/IdentifierStatus"}}}},"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/schemas-IdentifierTypeTechnicalKey"}}}},"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"},"url":{"$ref":"#/components/schemas/IssuingBodyUrl"},"technicalKey":{"$ref":"#/components/schemas/IssuingBodyTechnicalKey"},"jurisdiction":{"$ref":"#/components/schemas/Jurisdiction"}}}},"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.","properties":{"country":{"$ref":"#/components/schemas/Country"}}}},"components/schemas/IdentifierStatus":{"id":"components/schemas/IdentifierStatus","kind":"json-schema","title":"IdentifierStatus","data":{"type":"object","description":"Describes the status of an identifier with respect to its level of activity (e.g. out of business) or legally relevant conditions (e.g. in liquidation).","properties":{"name":{"$ref":"#/components/schemas/IdentifierStatusName"},"technicalKey":{"$ref":"#/components/schemas/IdentifierStatusTechnicalKey"}}}},"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/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":{"type":{"$ref":"#/components/schemas/BusinessPartnerStatusType"},"officialDenotation":{"$ref":"#/components/schemas/BusinessPartnerStatusOfficialDenotation"},"validFrom":{"$ref":"#/components/schemas/BusinessPartnerStatusValidFrom"},"validUntil":{"$ref":"#/components/schemas/BusinessPartnerStatusValidUntil"}}}},"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/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, \ncontact details, or minority indicator.\n","type":"object","properties":{"minorityIndicator":{"$ref":"#/components/schemas/MinorityIndicator"},"classifications":{"type":"array","description":"List of Classifications.","items":{"$ref":"#/components/schemas/Classification"}},"phoneNumbers":{"type":"array","description":"List of Phone Numbers.","items":{"$ref":"#/components/schemas/PhoneNumber"}},"websites":{"type":"array","description":"List of Websites.","items":{"$ref":"#/components/schemas/Website"}},"contactEmails":{"type":"array","description":"List of Contact Emails.","items":{"$ref":"#/components/schemas/ContactEmail"}},"tags":{"type":"array","description":"List of Tags.","maxItems":30,"items":{"$ref":"#/components/schemas/Tag"}},"vatPayerStatus":{"$ref":"#/components/schemas/VatPayerStatus"},"hcpProfile":{"$ref":"#/components/schemas/HcpProfile"}}}},"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/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/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/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/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/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/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/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/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/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/MinorityIndicator":{"id":"components/schemas/MinorityIndicator","kind":"json-schema","title":"MinorityIndicator","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 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is as of today dependent on data provided by a US based company: SupplierGateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For businesses, the minority indicator is often required in the context of:"},"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":"Government Contracts: Businesses must disclose if they are minority-owned, which can qualify them for certain federal, state, or local government contracts reserved for minority-owned businesses."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Diversity Reporting: Companies may use minority indicators to track the diversity of their workforce, ensuring compliance with regulations such as the Equal Employment Opportunity (EEO) laws."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supplier Diversity Programs: Large corporations often track minority-owned businesses in their supply chains as part of their supplier diversity initiatives."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The indicators can pertain to various minority groups, such as:"},"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":"racial and ethnic minorities (e.g., African American, Hispanic, Asian American, Native American),"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"women,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"veterans"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"people with disabilities."},"children":[]}]}]}]}],"properties":{"value":{"$ref":"#/components/schemas/MinorityIndicatorValue"}}}},"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"},"type":{"$ref":"#/components/schemas/ClassificationType"}}}},"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/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 headquarters.","properties":{"countryPrefix":{"$ref":"#/components/schemas/PhoneNumberCountryPrefix"},"number":{"$ref":"#/components/schemas/PhoneNumberNumber"},"type":{"$ref":"#/components/schemas/PhoneNumberType"},"value":{"$ref":"#/components/schemas/PhoneNumberValue"}}}},"components/schemas/PhoneNumberType":{"id":"components/schemas/PhoneNumberType","kind":"json-schema","title":"PhoneNumberType","data":{"type":"object","description":"The type of 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/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/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/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/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Typed string describing and identifying a resource. Custom information about the resource in form of a tag."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only value, not allowed to send in any creation endpoints, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /v4/storages/{storageId}/businesspartners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint (leads to Bad Request)."},"children":[]}]}]}],"properties":{"value":{"$ref":"#/components/schemas/TagValue"},"type":{"$ref":"#/components/schemas/TagType"}}}},"components/schemas/TagType":{"id":"components/schemas/TagType","kind":"json-schema","title":"TagType","data":{"type":"object","description":"A type that specifies the nature of the tag.","required":["technicalKey"],"properties":{"technicalKey":{"$ref":"#/components/schemas/TagTypeTechnicalKey"}}}},"components/schemas/AddressCdqId":{"id":"components/schemas/AddressCdqId","kind":"json-schema","title":"AddressCdqId","data":{"type":"string","description":"CDQ ID of an address.","example":"CDQID-123456789"}},"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":{"language":{"$ref":"#/components/schemas/Language"},"characterSet":{"$ref":"#/components/schemas/CharacterSet"}}}},"components/schemas/CharacterSet":{"id":"components/schemas/CharacterSet","kind":"json-schema","title":"CharacterSet","data":{"type":"object","description":"Character set for transliteration of the curated data.","properties":{"name":{"$ref":"#/components/schemas/CharacterSetName"},"technicalKey":{"$ref":"#/components/schemas/CharacterSetTechnicalKey"}}}},"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/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/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/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/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"},"isoCode":{"$ref":"#/components/schemas/AdministrativeAreaIsoCode"},"type":{"$ref":"#/components/schemas/schemas-AdministrativeAreaType"},"language":{"$ref":"#/components/schemas/Language"}}}},"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/Locality":{"id":"components/schemas/Locality","kind":"json-schema","title":"Locality","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A locality is a named, densely populated area (a place), such as a town, village, or suburb. A locality composes of many individual addresses. Many localities exist in an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://meta.cdq.com/DataModel:CDQ/Business_Partner/Address/Administrative_Area"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"administrative area"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A locality can also have several levels of sub-localities."},"children":[]}]}]}],"properties":{"type":{"$ref":"#/components/schemas/LocalityType"},"shortName":{"$ref":"#/components/schemas/LocalityShortName"},"value":{"$ref":"#/components/schemas/LocalityValue"},"language":{"$ref":"#/components/schemas/Language"}}}},"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/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"},"value":{"$ref":"#/components/schemas/ThoroughfareValue"},"name":{"$ref":"#/components/schemas/ThoroughfareName"},"direction":{"$ref":"#/components/schemas/ThoroughfareDirection"},"language":{"$ref":"#/components/schemas/Language"}}}},"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/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"},"language":{"$ref":"#/components/schemas/Language"}}}},"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/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"},"language":{"$ref":"#/components/schemas/Language"}}}},"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/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/AddressType":{"id":"components/schemas/AddressType","kind":"json-schema","title":"AddressType","data":{"type":"object","description":"An address type characterizes an address. The type of 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/FetchBusinessPartnerRequest":{"id":"components/schemas/FetchBusinessPartnerRequest","kind":"json-schema","title":"FetchBusinessPartnerRequest","data":{"type":"object","description":"Allows fetching Business Partner information. It requires the externalId parameter and allows specifying the dataSource, featuresOn, and featuresOff parameters to customize the fetch operation.","required":["externalId"],"properties":{"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalIdParam"},"dataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"featuresOn":{"type":"array","description":"Features to be used during the fetch Business Partner.","items":{"$ref":"#/components/schemas/FetchBusinessPartnerFeatureParam"}},"featuresOff":{"type":"array","description":"Features to be excluded during the fetch Business Partner.","items":{"$ref":"#/components/schemas/FetchBusinessPartnerFeatureParam"}}}}},"components/schemas/FetchBusinessPartnerResult":{"id":"components/schemas/FetchBusinessPartnerResult","kind":"json-schema","title":"FetchBusinessPartnerResult","data":{"type":"object","description":"Result of fetching a Business Partner from Storage.","properties":{"businessPartner":{"$ref":"#/components/schemas/BusinessPartner"},"status":{"$ref":"#/components/schemas/FetchBusinessPartnerStatus"},"message":{"$ref":"#/components/schemas/FetchBusinessPartnerMessage"}}}},"components/schemas/BusinessPartnerLookupResult":{"id":"components/schemas/BusinessPartnerLookupResult","kind":"json-schema","title":"BusinessPartnerLookupResult","data":{"type":"object","description":"Result of Business Partner Lookup.","properties":{"pageSize":{"$ref":"#/components/schemas/PageSize"},"total":{"type":"integer","description":"Total number of items which can be paged. \nNull if Business Partner was not specified.\n","example":"67"},"page":{"$ref":"#/components/schemas/Page"},"values":{"type":"array","description":"List of matching Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartnerLookupMatch"}},"debugInfo":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is just a reference implementation of how to structure external service responses. Usually, this should be hidden behind the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOW_DEBUG_INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}],"properties":{"features":{"type":"array","description":"List of features.","items":{"type":"object","description":"Feature with its status.","properties":{"feature":{"type":"string","description":"Feature to be used in the request.","example":"TRANSFORM_RECORD"},"active":{"type":"boolean","description":"Information, whether the feature is activated or not.","example":"true"}}}},"request":{"$ref":"#/components/schemas/BusinessPartnerLookupRequest"}}},"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","properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"technicalKey":{"$ref":"#/components/schemas/HttpStatusTechnicalKey"},"details":{"type":"array","items":{"$ref":"#/components/schemas/StatusDetail"}},"path":{"$ref":"#/components/schemas/HttpPath"},"timestamp":{"$ref":"#/components/schemas/StatusTimestamp"}}}},"components/schemas/StatusDetail":{"id":"components/schemas/StatusDetail","kind":"json-schema","title":"StatusDetail","data":{"type":"object","description":"Details about this status or error","properties":{"id":{"$ref":"#/components/schemas/StatusDetailsMessageId"},"message":{"$ref":"#/components/schemas/StatusDetailsMessage"},"technicalKey":{"$ref":"#/components/schemas/StatusDetailsTechnicalKey"}}}},"components/schemas/BusinessPartnerLookupMatch":{"id":"components/schemas/BusinessPartnerLookupMatch","kind":"json-schema","title":"BusinessPartnerLookupMatch","data":{"type":"object","description":"Business Partner found in the Data Mirror with the match.","properties":{"businessPartner":{"$ref":"#/components/schemas/BusinessPartner"},"matchingProfile":{"$ref":"#/components/schemas/MatchingProfile"}}}},"components/schemas/BusinessPartnerLookupRequest":{"id":"components/schemas/BusinessPartnerLookupRequest","kind":"json-schema","title":"BusinessPartnerLookupRequest","data":{"type":"object","description":"Request for Business Partner Lookup.","properties":{"matchingThreshold":{"$ref":"#/components/schemas/DataMatchingThreshold"},"pageSize":{"$ref":"#/components/schemas/PageSize"},"page":{"$ref":"#/components/schemas/Page"},"dataSources":{"$ref":"#/components/schemas/BusinessPartnerLookupRequestDataSources"},"businessPartner":{"$ref":"#/components/schemas/BusinessPartnerLookupParam"},"featuresOn":{"$ref":"#/components/schemas/BusinessPartnerLookupRequestFeaturesOn"},"featuresOff":{"$ref":"#/components/schemas/BusinessPartnerLookupRequestFeaturesOff"}}}},"components/schemas/BusinessPartnerLookupRequestDataSources":{"id":"components/schemas/BusinessPartnerLookupRequestDataSources","kind":"json-schema","title":"BusinessPartnerLookupRequestDataSources","data":{"type":"array","description":"List of Data Sources.","items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DataSource ID or name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both values, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM_DATA_SOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"648824a691d8d2503d65103e"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", are valid."},"children":[]}]}]}],"example":"CUSTOM_DATA_SOURCE"}}},"components/schemas/BusinessPartnerLookupRequestFeaturesOn":{"id":"components/schemas/BusinessPartnerLookupRequestFeaturesOn","kind":"json-schema","title":"BusinessPartnerLookupRequestFeaturesOn","data":{"type":"array","description":"Features to be used during the Business Partner lookup.","items":{"$ref":"#/components/schemas/FetchBusinessPartnerFeatureParam"}}},"components/schemas/BusinessPartnerLookupRequestFeaturesOff":{"id":"components/schemas/BusinessPartnerLookupRequestFeaturesOff","kind":"json-schema","title":"BusinessPartnerLookupRequestFeaturesOff","data":{"type":"array","description":"Features to be excluded during the Business Partner lookup.","items":{"$ref":"#/components/schemas/FetchBusinessPartnerFeatureParam"}}},"components/schemas/BusinessPartnerLookupRequestMatchingFeaturesOn":{"id":"components/schemas/BusinessPartnerLookupRequestMatchingFeaturesOn","kind":"json-schema","title":"BusinessPartnerLookupRequestMatchingFeaturesOn","data":{"type":"array","description":"Matching features to be used during the Business Partner lookup.","items":{"$ref":"#/components/schemas/LookupMatchingFeatureParam"}}},"components/schemas/LookupMatchingFeatureParam":{"id":"components/schemas/LookupMatchingFeatureParam","kind":"json-schema","title":"LookupMatchingFeatureParam","data":{"type":"string","description":"Lookup Matching Feature.","example":"LAB_OPTIMIZE_LEGAL_FORMS","enum":["LAB_OPTIMIZE_LEGAL_FORMS"],"x-enumDescriptions":{"LAB_OPTIMIZE_LEGAL_FORMS":"Uses legal-form-detection shared lib instead of calling Metadata API for faster name matching."}}},"components/schemas/BusinessPartnerLookupParam":{"id":"components/schemas/BusinessPartnerLookupParam","kind":"json-schema","title":"BusinessPartnerLookupParam","data":{"type":"object","description":"Lookup business partner data in connected data sources like the CDQ Community Data Pool, Business registers, or even in the own data mirror.","properties":{"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"record":{"$ref":"#/components/schemas/BusinessPartnerRecord"},"names":{"type":"array","description":"List of names.","items":{"$ref":"#/components/schemas/NameLookupParam"}},"identifiers":{"type":"array","description":"List of identifiers.","items":{"$ref":"#/components/schemas/IdentifierLookupParam"}},"legalForm":{"$ref":"#/components/schemas/LegalFormLookupParam"},"addresses":{"type":"array","description":"List of addresses.","maxItems":1,"items":{"$ref":"#/components/schemas/AddressLookupParam"}},"externalContext":{"$ref":"#/components/schemas/ExternalContextLookupParam"},"profile":{"$ref":"#/components/schemas/ProfileLookupParam"}}}},"components/schemas/NameLookupParam":{"id":"components/schemas/NameLookupParam","kind":"json-schema","title":"NameLookupParam","data":{"type":"object","description":"The name of a Business Partner.","properties":{"value":{"$ref":"#/components/schemas/NameValue"}}}},"components/schemas/IdentifierLookupParam":{"id":"components/schemas/IdentifierLookupParam","kind":"json-schema","title":"IdentifierLookupParam","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/IdentifierTypeLookupParam"}}}},"components/schemas/IdentifierTypeLookupParam":{"id":"components/schemas/IdentifierTypeLookupParam","kind":"json-schema","title":"IdentifierTypeLookupParam","data":{"type":"object","description":"Type of the identifier.","properties":{"technicalKey":{"$ref":"#/components/schemas/schemas-IdentifierTypeTechnicalKey"}}}},"components/schemas/LegalFormLookupParam":{"id":"components/schemas/LegalFormLookupParam","kind":"json-schema","title":"LegalFormLookupParam","data":{"type":"object","description":"The legal form of a Business Partner 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.","properties":{"name":{"$ref":"#/components/schemas/LegalFormName"}}}},"components/schemas/AddressLookupParam":{"id":"components/schemas/AddressLookupParam","kind":"json-schema","title":"AddressLookupParam","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":{"country":{"$ref":"#/components/schemas/CountryLookupParam"},"administrativeAreas":{"type":"array","description":"List of administrative areas.","items":{"$ref":"#/components/schemas/AdministrativeAreaLookupParam"}},"localities":{"type":"array","description":"List of localities.","items":{"$ref":"#/components/schemas/LocalityLookupParam"}},"postCodes":{"type":"array","description":"List of post codes.","items":{"$ref":"#/components/schemas/PostCodeLookupParam"}},"thoroughfares":{"type":"array","description":"List of thoroughfares.","items":{"$ref":"#/components/schemas/ThoroughfareLookupParam"}}}}},"components/schemas/CountryLookupParam":{"id":"components/schemas/CountryLookupParam","kind":"json-schema","title":"CountryLookupParam","data":{"type":"object","description":"Country code (ISO 3166-1 alpha-2).","properties":{"shortName":{"$ref":"#/components/schemas/CountryShortName"}}}},"components/schemas/AdministrativeAreaLookupParam":{"id":"components/schemas/AdministrativeAreaLookupParam","kind":"json-schema","title":"AdministrativeAreaLookupParam","data":{"type":"object","description":"A top-level geographical or political area division in a country.","properties":{"value":{"$ref":"#/components/schemas/AdministrativeAreaValue"}}}},"components/schemas/LocalityLookupParam":{"id":"components/schemas/LocalityLookupParam","kind":"json-schema","title":"LocalityLookupParam","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":{"value":{"$ref":"#/components/schemas/LocalityValue"}}}},"components/schemas/PostCodeLookupParam":{"id":"components/schemas/PostCodeLookupParam","kind":"json-schema","title":"PostCodeLookupParam","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"}}}},"components/schemas/ThoroughfareLookupParam":{"id":"components/schemas/ThoroughfareLookupParam","kind":"json-schema","title":"ThoroughfareLookupParam","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":{"value":{"$ref":"#/components/schemas/ThoroughfareValue"},"number":{"$ref":"#/components/schemas/ThoroughfareNumber"}}}},"components/schemas/ExternalContextLookupParam":{"id":"components/schemas/ExternalContextLookupParam","kind":"json-schema","title":"ExternalContextLookupParam","data":{"type":"object","description":"External context of a Business Partner.","properties":{"identifiers":{"type":"array","description":"List of identifiers.","items":{"$ref":"#/components/schemas/ExternalContextIdentifierLookupParam"}}}}},"components/schemas/ExternalContextIdentifierLookupParam":{"id":"components/schemas/ExternalContextIdentifierLookupParam","kind":"json-schema","title":"ExternalContextIdentifierLookupParam","data":{"type":"object","description":"Identifies a Business Partner in a given context.","properties":{"value":{"$ref":"#/components/schemas/ExternalContextIdentifierValue"},"type":{"$ref":"#/components/schemas/ExternalContextIdentifierTypeLookupParam"}}}},"components/schemas/ExternalContextIdentifierTypeLookupParam":{"id":"components/schemas/ExternalContextIdentifierTypeLookupParam","kind":"json-schema","title":"ExternalContextIdentifierTypeLookupParam","data":{"type":"object","description":"Type of the identifier.","properties":{"technicalKey":{"$ref":"#/components/schemas/ExternalContextIdentifierTypeTechnicalKey"}}}},"components/schemas/ProfileLookupParam":{"id":"components/schemas/ProfileLookupParam","kind":"json-schema","title":"ProfileLookupParam","data":{"type":"object","description":"Profile of a Business Partner.","properties":{"tags":{"type":"array","description":"List of tags.","items":{"$ref":"#/components/schemas/TagLookupParam"}}}}},"components/schemas/TagLookupParam":{"id":"components/schemas/TagLookupParam","kind":"json-schema","title":"TagLookupParam","data":{"type":"object","description":"Typed string describing and identifying a resource.","properties":{"value":{"$ref":"#/components/schemas/TagValue"},"type":{"$ref":"#/components/schemas/TagTypeLookupParam"}}}},"components/schemas/TagTypeLookupParam":{"id":"components/schemas/TagTypeLookupParam","kind":"json-schema","title":"TagTypeLookupParam","data":{"type":"object","description":"A type of the tag.","properties":{"technicalKey":{"$ref":"#/components/schemas/TagTypeTechnicalKey"}}}},"components/schemas/BusinessPartnersUpsertRequest":{"id":"components/schemas/BusinessPartnersUpsertRequest","kind":"json-schema","title":"BusinessPartnersUpsertRequest","data":{"type":"object","description":"Parameters for Business Partners Upsert.","required":["businessPartners"],"properties":{"dataSource":{"$ref":"#/components/schemas/BusinessPartnerDataSource"},"businessPartners":{"type":"array","description":"List of Business Partners.","minItems":1,"maxItems":1000,"items":{"$ref":"#/components/schemas/BusinessPartner"}},"featuresOn":{"type":"array","description":"Features to be activated during the upsert.","items":{"$ref":"#/components/schemas/UpsertFeatureParam"}},"featuresOff":{"type":"array","description":"Features to be deactivated during the upsert.","items":{"$ref":"#/components/schemas/UpsertFeatureParam"}}}}},"components/schemas/UpsertFeatureParam":{"id":"components/schemas/UpsertFeatureParam","kind":"json-schema","title":"UpsertFeatureParam","data":{"type":"string","description":"Features to be used during the upsert.","example":"UPSERT_BY_EXTERNAL_ID","enum":["UPSERT_BY_EXTERNAL_ID","API_ERROR_ON_FAILURES","LAB_USE_QUEUES","TRANSFORM_RECORD","ENABLE_SETTINGS","ENABLE_ASYNC"],"x-enumDescriptions":{"UPSERT_BY_EXTERNAL_ID":"Updates a Business Partners identified by external ID instead of an insert if the external ID is already present in this storage.","API_ERROR_ON_FAILURES":"Throws exception instead of default Upsert Failure Log.","TRANSFORM_RECORD":"Transforms record into Business Partner model using the dataMapperDefinition attached to the dataSource. Supported only for batch size up to 250 Business Partners.","ENABLE_SETTINGS":"Enables usage of user and organization settings in upsert process. Enabled by default.","ENABLE_ASYNC":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stores data to the storage. Enables asynchronous data processing for transformation, updates, indexing and sharing processes. Requires externalId to be present in the businessPartner. Enabled by default when TRANSFORM_RECORD not used."},"children":[]}]}]}]}}},"components/schemas/UpsertFeature":{"id":"components/schemas/UpsertFeature","kind":"json-schema","title":"UpsertFeature","data":{"type":"string","description":"Features to be used during the upsert.","example":"UPSERT_BY_EXTERNAL_ID"}},"components/schemas/RelationsUpsertRequest":{"id":"components/schemas/RelationsUpsertRequest","kind":"json-schema","title":"RelationsUpsertRequest","data":{"type":"object","description":"Request for Business Partner Upsert. Each relation must have a unique combination of startNodeExternalId, endNodeExternalId and relationType.\nIf a relation with the same combination of startNodeExternalId, endNodeExternalId and relationType already exists in the storage, it will be updated.\nIf a relation with the same combination of startNodeExternalId, endNodeExternalId and relationType does not exist in the storage, it will be inserted.\n","required":["relations"],"properties":{"relations":{"type":"array","description":"Batch of Business Partner relations.","minItems":1,"maxItems":1000,"items":{"$ref":"#/components/schemas/BusinessPartnerRelation"}}}}},"components/schemas/RelationUpsertFeatureParam":{"id":"components/schemas/RelationUpsertFeatureParam","kind":"json-schema","title":"RelationUpsertFeatureParam","data":{"type":"string","description":"Features to be activated during Business Partner Relations Upsert.","example":"SKIP_UPDATES","enum":["SKIP_UPDATES"],"x-enumDescriptions":{"SKIP_UPDATES":"Prevents sending updates when relations are created or modified. This feature is used only for testing relations in CDQ.POOL."}}},"components/schemas/RelationsUpsertResult":{"id":"components/schemas/RelationsUpsertResult","kind":"json-schema","title":"RelationsUpsertResult","data":{"type":"object","description":"Result of Business Partner Relations Upsert.","properties":{"numberOfProvidedRelations":{"type":"integer","description":"Number of provided Business Partner Relations.","example":"10"},"numberOfInserts":{"type":"integer","description":"Number of inserted Business Partners.","example":"10"},"numberOfUpdates":{"type":"integer","description":"Number of updated Business Partners.","example":"10"},"numberOfFailed":{"type":"integer","description":"Number of failed inserts.","example":"10"},"failures":{"type":"array","description":"List of relations failed to be inserted or updated.","items":{"$ref":"#/components/schemas/RelationUpsertFailureLog"}}}}},"components/schemas/RelationUpsertFailureLog":{"id":"components/schemas/RelationUpsertFailureLog","kind":"json-schema","title":"RelationUpsertFailureLog","data":{"type":"object","description":"Log of a failed relation upsert.","properties":{"startNodeExternalId":{"$ref":"#/components/schemas/RelationUpsertFailureLogExternalId"},"endNodeExternalId":{"$ref":"#/components/schemas/RelationUpsertFailureLogExternalId"},"message":{"$ref":"#/components/schemas/RelationUpsertFailureLogMessage"}}}},"components/schemas/RelationUpsertFailureLogExternalId":{"id":"components/schemas/RelationUpsertFailureLogExternalId","kind":"json-schema","title":"RelationUpsertFailureLogExternalId","data":{"type":"string","description":"External ID of a Business Partner.","example":"78643267348"}},"components/schemas/RelationUpsertFailureLogMessage":{"id":"components/schemas/RelationUpsertFailureLogMessage","kind":"json-schema","title":"RelationUpsertFailureLogMessage","data":{"type":"string","description":"Error message.","example":"Missing data source ID."}},"components/schemas/FetchBusinessPartnerFeatureParam":{"id":"components/schemas/FetchBusinessPartnerFeatureParam","kind":"json-schema","title":"FetchBusinessPartnerFeatureParam","data":{"type":"string","description":"Fetch Business Partner Feature.","example":"FETCH_RECORD","enum":["FETCH_RECORD","FETCH_RELATIONS"],"x-enumDescriptions":{"FETCH_RECORD":"Allows to switch fetching record field to reduce data size. By default, turned on.","FETCH_RELATIONS":"Allows to switch fetching relations of Business Partners. By default, deactivated. Only for storages with RELATIONS feature activated."}}},"components/schemas/ReadBusinessPartnerFeatureParam":{"id":"components/schemas/ReadBusinessPartnerFeatureParam","kind":"json-schema","title":"ReadBusinessPartnerFeatureParam","data":{"type":"string","description":"Read Business Partner Feature.","example":"FETCH_RECORD","enum":["APPLY_AUGMENTATION_DECISIONS","APPLY_CURATION_DECISIONS","FETCH_RECORD","FETCH_RELATIONS"],"x-enumDescription":{"APPLY_AUGMENTATION_DECISIONS":"Applies accepted augmentation decisions from the Decision Log to the business partner if any decisions are found. By default, deactivated.","APPLY_CURATION_DECISIONS":"Deprecated, use APPLY_AUGMENTATION_DECISIONS instead. Works the same as APPLY_AUGMENTATION_DECISIONS. By default, deactivated.","FETCH_RECORD":"Allows to switch fetching record field to reduce data size. By default, turned on.","FETCH_RELATIONS":"Allows to switch fetching relations of Business Partners. By default, deactivated. Only for storages with RELATIONS feature activated."}}},"components/schemas/BusinessPartnerEventFlattenFeatureParam":{"id":"components/schemas/BusinessPartnerEventFlattenFeatureParam","kind":"json-schema","title":"BusinessPartnerEventFlattenFeatureParam","data":{"type":"string","description":"Feature to be used during the flattening.","example":"DELETE_WHEN_DELETED","enum":["DELETE_WHEN_DELETED","FLATTEN_ALL_UPDATED_TO_ONE_LATEST","FLATTEN_ALL_EVENTS_TO_CREATED_WITH_LATEST_DATE","FLATTEN_ALL_EVENTS_TO_CREATED_WITH_LATEST_DATE_OR_REBUILD_CREATED","FLATTEN_OVER_6_MONTHS"],"x-enumDescriptions":{"DELETE_WHEN_DELETED":"Deletes all events of a Business Partner if a Business Partner doesn't exist anymore.","FLATTEN_ALL_UPDATED_TO_ONE_LATEST":"Flattens all update events to one with the date of the latest update event.","FLATTEN_ALL_EVENTS_TO_CREATED_WITH_LATEST_DATE":"Flattens all events to one created with the date of the latest update event.","FLATTEN_ALL_EVENTS_TO_CREATED_WITH_LATEST_DATE_OR_REBUILD_CREATED":"Flattens all events to one created even if there is only one created, with the date of the latest update event or created event.","FLATTEN_OVER_6_MONTHS":"Flatten all events over 6 months."}}},"components/schemas/ValidationLevelParam":{"id":"components/schemas/ValidationLevelParam","kind":"json-schema","title":"ValidationLevelParam","data":{"type":"string","description":"Violation level of validation result.","example":"WARNING","enum":["OK","ERROR","WARNING","INFO","UNKNOWN"],"x-enumDescriptions":{"OK":"No data quality issues have been found after executing all the rules.","ERROR":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least 1  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  defect has been found."},"children":[]}]}]}],"WARNING":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least 1  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  defect has been found."},"children":[]}]}]}],"INFO":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least 1  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  defect has been found."},"children":[]}]}]}],"UNKNOWN":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  has been found, but at least one data quality rule could not be executed."},"children":[]}]}]}]}}},"components/schemas/CurationLevelParam":{"id":"components/schemas/CurationLevelParam","kind":"json-schema","title":"CurationLevelParam","data":{"type":"string","description":"Curation log of curation result.","example":"LEVEL_1","enum":["LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4","LEVEL_5","LEVEL_6","UNKNOWN"],"x-enumDescriptions":{"UNKNOWN":"No possibility to determine curation level.","LEVEL_1":"The address was not found by the CDQ in the employed external data sources.","LEVEL_2":"The address was found, but there were significant changes in critical fields.","LEVEL_3":"The address was found and there are minor changes in highly important fields.","LEVEL_4":"The address was found by the CDQ. There were only  changes in less critical fields such as the address/premise or address/thoroughfare/number.","LEVEL_5":"The address was found by the CDQ, but no major changes have been made as the address was correct.","LEVEL_6":"The address was found in the shared CDQ data pool. This means another company uses the same address which is a very reliable indicator that the address is correct (only  in an alpha version)."}}},"components/schemas/BusinessPartnerIdentityLinksReadFeatureParam":{"id":"components/schemas/BusinessPartnerIdentityLinksReadFeatureParam","kind":"json-schema","title":"BusinessPartnerIdentityLinksReadFeatureParam","data":{"type":"string","description":"The features to be used during the reading Business Partner Identity Links.","example":"ACCEPT_REPLICATION_DELAYS","enum":["ACCEPT_REPLICATION_DELAYS","NUMBER_OF_TOTAL"],"x-enumDescriptions":{"ACCEPT_REPLICATION_DELAYS":"Accepts replication delays in persisting to the database. Allows faster data access. By default, deactivated.","NUMBER_OF_TOTAL":"Allows to switch fetching the total number of Business Partners to improve performance. By default, turned on."}}},"components/schemas/BusinessPartnersReadFeatureParam":{"id":"components/schemas/BusinessPartnersReadFeatureParam","kind":"json-schema","title":"BusinessPartnersReadFeatureParam","data":{"type":"string","description":"The features to be activated/deactivated during the reading Business Partners.","example":"APPLY_AUGMENTATION_DECISIONS","enum":["APPLY_AUGMENTATION_DECISIONS","APPLY_CURATION_DECISIONS","CURATION_LOG_RESULT_STATUSES","FETCH_RECORD","FETCH_RELATIONS","NUMBER_OF_TOTAL","USE_NEXT_START_AFTER","VALIDATION_LOG_RESULT_STATUSES"],"x-enumDescriptions":{"APPLY_AUGMENTATION_DECISIONS":"Applies accepted augmentation decisions from the Decision Log to the business partner if any decisions are found. By default, deactivated.","APPLY_CURATION_DECISIONS":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated, use APPLY_AUGMENTATION_DECISIONS instead. Works the same as APPLY_AUGMENTATION_DECISIONS. By default, deactivated."},"children":[]}]}]}],"CURATION_LOG_RESULT_STATUSES":"Allows to switch fetching curation log result statuses. By default, deactivated.","FETCH_RECORD":"Allows to switch fetching record field to reduce data size. By default, turned on.","FETCH_RELATIONS":"Allows to switch fetching relations of Business Partners. By default, deactivated. Only for storages with RELATIONS feature activated.","NUMBER_OF_TOTAL":"Allows to switch fetching the total number of Business Partners to improve performance. By default, turned on.","USE_NEXT_START_AFTER":"Allows to switch fetching the next page of Business Partners using the nextStartAfter value. By default, deactivated.","VALIDATION_LOG_RESULT_STATUSES":"Allows to switch fetching validation log result statuses. By default, deactivated."}}},"components/schemas/BusinessPartnerPage":{"id":"components/schemas/BusinessPartnerPage","kind":"json-schema","title":"BusinessPartnerPage","data":{"type":"object","description":"Page for displaying Business Partners.","properties":{"startAfter":{"$ref":"#/components/schemas/StartAfter"},"limit":{"$ref":"#/components/schemas/Limit"},"total":{"$ref":"#/components/schemas/PageTotal"},"values":{"type":"array","description":"List of Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartner"}},"nextStartAfter":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only when you used USE_NEXT_START_AFTER feature."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a value to be used as a startAfter in next page request."},"children":[]}]}]}],"example":"5712566172571652"}}}},"components/schemas/BusinessPartnerRandomPage":{"id":"components/schemas/BusinessPartnerRandomPage","kind":"json-schema","title":"BusinessPartnerRandomPage","data":{"type":"object","description":"Return random page with business partners data.","properties":{"limit":{"$ref":"#/components/schemas/Limit"},"values":{"type":"array","description":"List of Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartner"}}}}},"components/schemas/BusinessPartnerUpdatePage":{"id":"components/schemas/BusinessPartnerUpdatePage","kind":"json-schema","title":"BusinessPartnerUpdatePage","data":{"type":"object","description":"Page for displaying Business Partner Updates.","properties":{"limit":{"$ref":"#/components/schemas/Limit"},"total":{"$ref":"#/components/schemas/PageTotal"},"startAfter":{"$ref":"#/components/schemas/StartAfter"},"nextStartAfter":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only when you used USE_NEXT_START_AFTER feature."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a value to be used as a startAfter in next page request."},"children":[]}]}]}],"example":"5712566172571652"},"values":{"type":"array","description":"List of Business Partner Updates.","items":{"$ref":"#/components/schemas/BusinessPartnerUpdate"}}}}},"components/schemas/BusinessPartnerUpdate":{"id":"components/schemas/BusinessPartnerUpdate","kind":"json-schema","title":"BusinessPartnerUpdate","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Business Partner Update comprises a list of Change Sets which belong to this Business Partner"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessPartner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a BusinessPartner model built out of all updates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storageBusinessPartner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a current Business Partner from the storage."},"children":[]}]}]}],"properties":{"businessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerId"},"externalBusinessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"changeSets":{"type":"array","description":"List of Change Sets","items":{"$ref":"#/components/schemas/ChangeSet"}},"businessPartner":{"$ref":"#/components/schemas/BusinessPartner"},"storageBusinessPartner":{"$ref":"#/components/schemas/BusinessPartner"},"provenances":{"type":"array","description":"Set of all provenances from change sets.","items":{"$ref":"#/components/schemas/Provenance2"}}}}},"components/schemas/ChangeSet":{"id":"components/schemas/ChangeSet","kind":"json-schema","title":"ChangeSet","data":{"type":"object","description":"A Change Set is a list of PropertyChanges that have been applied in one transaction by a user or reference data source update.","properties":{"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"propertyChanges":{"type":"array","description":"List of Property Changes.","items":{"$ref":"#/components/schemas/PropertyChange2"}},"provenances":{"type":"array","description":"Set of all provenances from property changes.","items":{"$ref":"#/components/schemas/Provenance2"}}}}},"components/schemas/PropertyChange2":{"id":"components/schemas/PropertyChange2","kind":"json-schema","title":"PropertyChange2","data":{"type":"object","description":"Describes how a property has been changed and how confident we are that the change was a good improvement","properties":{"externalIds":{"type":"array","description":"List of External IDs.","items":{"$ref":"#/components/schemas/ExternalId"}},"property":{"$ref":"#/components/schemas/Property"},"newContent":{"$ref":"#/components/schemas/PropertyNewContent"},"previousContent":{"$ref":"#/components/schemas/PropertyPreviousContent"},"provenance":{"$ref":"#/components/schemas/Provenance2"},"changeType":{"$ref":"#/components/schemas/PropertyChangeTypeTechnicalKey"},"changeClassification":{"$ref":"#/components/schemas/schemas-PropertyChangeClassification"},"confidenceScore":{"$ref":"#/components/schemas/PropertyChangeConfidenceScore"},"maxConfidenceScore":{"$ref":"#/components/schemas/PropertyChangeMaxConfidenceScore"}}}},"components/schemas/PropertyPreviousContent":{"id":"components/schemas/PropertyPreviousContent","kind":"json-schema","title":"PropertyPreviousContent","data":{"type":"string","example":"AAB","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of a property before change."},"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":"In update coming from reference data source, this is a value from a Business Partner"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from this storage that the update suggests to change."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In own update done via upsert, this is a last value of this property that is coming"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"out of last of previous updates of this Business Partner where this property"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"was changed - it can be either previous own update or update coming from reference data source."},"children":[]}]}]}]}]}},"components/schemas/PropertyNewContent":{"id":"components/schemas/PropertyNewContent","kind":"json-schema","title":"PropertyNewContent","data":{"type":"string","example":"AAB","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New value of a property that:"},"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":"has been changed by own update or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is an update proposal coming from reference data source."},"children":[]}]}]}]}]}},"components/schemas/PropertyChangeClassificationParam":{"id":"components/schemas/PropertyChangeClassificationParam","kind":"json-schema","title":"PropertyChangeClassificationParam","data":{"type":"string","description":"Indicator how \"much\" the attribute was changed OR how important the change was.","example":"TRIVIAL","enum":["UNMODIFIED","TRIVIAL","MINOR","MAJOR","REJECTED","CRITICAL"],"x-enumDescriptions":{"UNMODIFIED":"The attribute was not changed.","TRIVIAL":"The attribute was changed, but the change is not important.","MINOR":"The attribute was changed, but the change is minor.","MAJOR":"The attribute was changed, and the change is major.","REJECTED":"The attribute was changed, but the change was rejected.","CRITICAL":"The attribute was changed, and the change is critical."}}},"components/schemas/ExternalId":{"id":"components/schemas/ExternalId","kind":"json-schema","title":"ExternalId","data":{"type":"object","description":"Arbitrary identifier type to mark customer IDs which are \"external\" from CDQ's perspective. This is the identifier a customer provides to identify her records, e.g. the ID she manages in her SAP systems.","properties":{"externalId":{"$ref":"#/components/schemas/ExternalIdValue"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"id":{"$ref":"#/components/schemas/ExternalIdValue"},"concept":{"$ref":"#/components/schemas/Concept"},"language":{"$ref":"#/components/schemas/Language"},"characterSet":{"$ref":"#/components/schemas/CharacterSet1"},"type":{"$ref":"#/components/schemas/AddressType"}}}},"components/schemas/Concept":{"id":"components/schemas/Concept","kind":"json-schema","title":"Concept","data":{"type":"object","description":"The Concept is a part of the CDQ data model. For example Address is a concept of the Business Partner and have many subconcepts as Locality, Thoroughfare, Administrative Area etc.","properties":{"name":{"$ref":"#/components/schemas/ConceptName"},"technicalKey":{"$ref":"#/components/schemas/ConceptTechnicalKey"}}}},"components/schemas/CharacterSet1":{"id":"components/schemas/CharacterSet1","kind":"json-schema","title":"CharacterSet1","data":{"type":"object","description":"Character set.","properties":{"name":{"$ref":"#/components/schemas/CharacterSetName"},"technicalKey":{"$ref":"#/components/schemas/CharacterSetTechnicalKey"}}}},"components/schemas/Property":{"id":"components/schemas/Property","kind":"json-schema","title":"Property","data":{"type":"object","description":"Part of a concept. It describes a single attribute of a concept.","properties":{"parentConcept":{"$ref":"#/components/schemas/Concept"},"name":{"$ref":"#/components/schemas/PropertyName"},"technicalKey":{"$ref":"#/components/schemas/PropertyTechnicalKey"},"contentSelector":{"$ref":"#/components/schemas/PropertyContentSelector"},"instanceSelectors":{"type":"array","description":"List of Instance Selectors.","items":{"$ref":"#/components/schemas/PropertyContentInstanceSelector"}}}}},"components/schemas/PropertyContentInstanceSelector":{"id":"components/schemas/PropertyContentInstanceSelector","kind":"json-schema","title":"PropertyContentInstanceSelector","data":{"type":"object","description":"Contains JSON paths allowing to select specific instance of a property.","properties":{"key":{"$ref":"#/components/schemas/PropertyContentInstanceSelectorKey"},"value":{"$ref":"#/components/schemas/PropertyContentInstanceSelectorValue"}}}},"components/schemas/Provenance2":{"id":"components/schemas/Provenance2","kind":"json-schema","title":"Provenance2","data":{"type":"object","description":"The source of the change/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/BusinessPartnerUpdatesFeatureParam":{"id":"components/schemas/BusinessPartnerUpdatesFeatureParam","kind":"json-schema","title":"BusinessPartnerUpdatesFeatureParam","data":{"type":"string","description":"The feature to be activated/deactivated during Business Partner Updates.","example":"SHOW_BUSINESS_PARTNER","enum":["APPLY_AUGMENTATION_DECISIONS","APPLY_CURATION_DECISIONS","FETCH_STORAGE_BUSINESS_PARTNER","FETCH_STORAGE_BUSINESS_PARTNER_WITH_RELATIONS","SHOW_BUSINESS_PARTNER"]}},"components/schemas/BusinessPartnerConceptParam":{"id":"components/schemas/BusinessPartnerConceptParam","kind":"json-schema","title":"BusinessPartnerConceptParam","data":{"type":"string","description":"The Concept is a part of the CDQ data model. For example Address is a concept of the Business Partner and have many subconcepts as Locality, Thoroughfare, Administrative Area etc.","enum":["NAME","IDENTIFIER","LEGAL_FORM","MINORITY_INDICATOR","STATUS","ADDRESS","COUNTRY","ADMINISTRATIVE_AREA","POST_CODE","LOCALITY","THOROUGHFARE","PREMISE","POSTAL_DELIVERY_POINT","GEO_COORDINATES","GEOGRAPHIC_COORDINATES","BUSINESS_PARTNER_RELATION"],"example":"MINORITY_INDICATOR","x-enumDescriptions":{"NAME":"Name of the Business Partner.","IDENTIFIER":"Identifier of the Business Partner.","LEGAL_FORM":"Legal form of the Business Partner.","MINORITY_INDICATOR":"Minority indicator of the Business Partner.","STATUS":"Status of the Business Partner.","ADDRESS":"Address of the Business Partner.","COUNTRY":"Country of the Business Partner.","ADMINISTRATIVE_AREA":"Administrative area of the Business Partner.","POST_CODE":"Post code of the Business Partner.","LOCALITY":"Locality of the Business Partner.","THOROUGHFARE":"Thoroughfare of the Business Partner.","PREMISE":"Premise of the Business Partner.","POSTAL_DELIVERY_POINT":"Postal delivery point of the Business Partner.","GEOGRAPHIC_COORDINATES":"Geographic coordinates of the Business Partner.","BUSINESS_PARTNER_RELATION":"Relation of the Business Partner."}}},"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/Provenance2"},"language":{"$ref":"#/components/schemas/Language"}}}},"components/schemas/FieldsTransformationRequest":{"id":"components/schemas/FieldsTransformationRequest","kind":"json-schema","title":"FieldsTransformationRequest","data":{"type":"object","description":"Request to transform a list of business partners into key-value lists.","properties":{"businessPartners":{"type":"array","description":"List of Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartner"}}}}},"components/schemas/FieldsTransformationResult":{"id":"components/schemas/FieldsTransformationResult","kind":"json-schema","title":"FieldsTransformationResult","data":{"type":"object","description":"Result of transforming a list of business partners into key-value lists.","properties":{"businessPartners":{"type":"array","description":"List of Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartner"}},"fieldBusinessPartners":{"type":"array","description":"List of Field Business Partners.","items":{"$ref":"#/components/schemas/FieldBusinessPartner"}}}}},"components/schemas/BusinessPartnersTransformationResult":{"id":"components/schemas/BusinessPartnersTransformationResult","kind":"json-schema","title":"BusinessPartnersTransformationResult","data":{"type":"object","description":"Result of transforming raw data to CDQ data model.","properties":{"businessPartners":{"type":"array","description":"List of Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartner"}}}}},"components/schemas/BusinessPartnersUpsertResult":{"id":"components/schemas/BusinessPartnersUpsertResult","kind":"json-schema","title":"BusinessPartnersUpsertResult","data":{"type":"object","description":"Result of Business Partners Upsert.","properties":{"numberOfAccepted":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When asynchronous processing activated (ENABLE_ASYNC or LAB_USE_QUEUES), then represents number of Business Partners to be processed asynchronously."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When synchronous processing activated, then provides number of Business Partners processed."},"children":[]}]}]}],"example":"10"},"numberOfFailed":{"type":"integer","description":"Number of failed inserts.","example":"10"},"failures":{"type":"array","description":"List of failures.","items":{"$ref":"#/components/schemas/UpsertFailureLog"}},"featuresOn":{"type":"array","description":"List of features that cna be activated during the upsert.","items":{"$ref":"#/components/schemas/UpsertFeature"}}}}},"components/schemas/LinkStatusPatch":{"id":"components/schemas/LinkStatusPatch","kind":"json-schema","title":"LinkStatusPatch","data":{"type":"object","description":"Patch for Business Partner Identity Link Status. All fields in LinkRetry are updated together.","properties":{"retry":{"$ref":"#/components/schemas/LinkRetry"}}}},"components/schemas/LinkStatus":{"id":"components/schemas/LinkStatus","kind":"json-schema","title":"LinkStatus","data":{"type":"object","description":"Details about status or error of a service","properties":{"details":{"type":"array","items":{"$ref":"#/components/schemas/LinkStatusDetails"}}}}},"components/schemas/LinkStatusDetails":{"id":"components/schemas/LinkStatusDetails","kind":"json-schema","title":"LinkStatusDetails","data":{"type":"object","description":"Details about this status or error","properties":{"message":{"$ref":"#/components/schemas/StatusDetailsMessage"},"technicalKey":{"$ref":"#/components/schemas/StatusDetailsTechnicalKey"}}}},"components/schemas/LinkRetry":{"id":"components/schemas/LinkRetry","kind":"json-schema","title":"LinkRetry","data":{"type":"object","description":"Details about retrying linkage process.","properties":{"value":{"$ref":"#/components/schemas/LinkRetryValue"},"reason":{"$ref":"#/components/schemas/LinkRetryReason"}}}},"components/schemas/LinkRetryValue":{"id":"components/schemas/LinkRetryValue","kind":"json-schema","title":"LinkRetryValue","data":{"type":"boolean","description":"Indicates whether to retry the linkage process or not.","example":true}},"components/schemas/LinkRetryReason":{"id":"components/schemas/LinkRetryReason","kind":"json-schema","title":"LinkRetryReason","data":{"type":"string","description":"Reason for retrying the linkage process.","example":"EXTERNAL_SERVICE_NOT_AVAILABLE"}},"components/schemas/LinkageStatus":{"id":"components/schemas/LinkageStatus","kind":"json-schema","title":"LinkageStatus","data":{"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 linkage:"},"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":"SUCCESSFULLY_LINKED - Country and identifier exists, result found by lookup and contains cdqId. Link created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MISSING_INFORMATION_FOR_LINKAGE - Missing country or information for linkage strategy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_MATCH_FOUND - No result from lookup."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_CONFIDENT_MATCH_FOUND - No confident result from lookup."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_MATCH_ADDRESS_VERSION - Result found in lookup but address version doesn’t match."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNDER_CONSIDERATION - Linkage is under consideration."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESS_ISSUE - Internal issues or issues with reference data sources."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUOTA_LIMIT - The customer doesn’t have enough quota."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE_SOURCE - Reference Data source is not activated for the organization or credentials are not provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ERRONEOUS_IDENTIFIER - Business Partner didn’t pass the validation due to an incorrect identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXTERNAL_SERVICE_NOT_AVAILABLE - Lookup would succeed if external service was available."},"children":[]}]}]}]}],"example":"SUCCESSFULLY_LINKED"}},"components/schemas/BusinessPartnerIdentityLinkDataSource":{"id":"components/schemas/BusinessPartnerIdentityLinkDataSource","kind":"json-schema","title":"BusinessPartnerIdentityLinkDataSource","data":{"type":"object","description":"Data Source of the Business Partner which was used for the linkage in the POOL.","properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}}}},"components/schemas/BusinessPartnerIdentityLinkPage":{"id":"components/schemas/BusinessPartnerIdentityLinkPage","kind":"json-schema","title":"BusinessPartnerIdentityLinkPage","data":{"type":"object","description":"Page of Business Partner Identity Links.","properties":{"startAfter":{"$ref":"#/components/schemas/StartAfter"},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"},"limit":{"$ref":"#/components/schemas/Limit"},"total":{"$ref":"#/components/schemas/PageTotal"},"values":{"type":"array","description":"List of Business Partner Identity Links.","items":{"$ref":"#/components/schemas/BusinessPartnerIdentityLink"}}}}},"components/schemas/SharingScope":{"id":"components/schemas/SharingScope","kind":"json-schema","title":"SharingScope","data":{"type":"object","description":"Indicates scope of Business Partners desired for sharing.","properties":{"id":{"$ref":"#/components/schemas/SharingScopeId"},"description":{"$ref":"#/components/schemas/SharingScopeDescription"},"dataSources":{"type":"array","description":"List of Data Sources.","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSource"}},"countries":{"type":"array","description":"List of Countries.","items":{"$ref":"#/components/schemas/SharingScopeCountry"}},"applyingJob":{"$ref":"#/components/schemas/SharingScopeApplyingJob"}}}},"components/schemas/SharingScopeApplyingJob":{"id":"components/schemas/SharingScopeApplyingJob","kind":"json-schema","title":"SharingScopeApplyingJob","data":{"type":"object","description":"Job that is currently applying the sharing scope.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"status":{"$ref":"#/components/schemas/schemas-JobStatus"},"progress":{"$ref":"#/components/schemas/JobProgress"}}}},"components/schemas/SharingScopeCountry":{"id":"components/schemas/SharingScopeCountry","kind":"json-schema","title":"SharingScopeCountry","data":{"type":"object","description":"Country of the Sharing Scope.","properties":{"shortName":{"$ref":"#/components/schemas/CountryShortName"}}}},"components/schemas/SharingScopeCreate":{"id":"components/schemas/SharingScopeCreate","kind":"json-schema","title":"SharingScopeCreate","data":{"type":"object","description":"Indicates scope of Business Partners desired for sharing.","properties":{"description":{"$ref":"#/components/schemas/SharingScopeDescription"},"dataSources":{"type":"array","description":"List of Data Sources.","maxItems":1,"items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceParam"}},"countries":{"type":"array","description":"List of Countries.","maxItems":1,"items":{"$ref":"#/components/schemas/SharingScopeCountryParam"}}}}},"components/schemas/SharingScopeCountryParam":{"id":"components/schemas/SharingScopeCountryParam","kind":"json-schema","title":"SharingScopeCountryParam","data":{"type":"object","description":"Country of the Sharing Scope.","required":["shortName"],"properties":{"shortName":{"$ref":"#/components/schemas/CountryShortName"}}}},"components/schemas/SharingScopeDeletes":{"id":"components/schemas/SharingScopeDeletes","kind":"json-schema","title":"SharingScopeDeletes","data":{"type":"object","description":"Delete the Sharing Scopes.","properties":{"sharingScopes":{"type":"array","description":"List of Sharing Scopes to be deleted.","items":{"$ref":"#/components/schemas/SharingScopeDelete"},"maxItems":1}}}},"components/schemas/SharingScopeDelete":{"id":"components/schemas/SharingScopeDelete","kind":"json-schema","title":"SharingScopeDelete","data":{"type":"object","description":"Delete the Sharing Scope.","properties":{"id":{"$ref":"#/components/schemas/SharingScopeId"}}}},"components/schemas/SharingScopeDeleteResults":{"id":"components/schemas/SharingScopeDeleteResults","kind":"json-schema","title":"SharingScopeDeleteResults","data":{"type":"object","description":"Results of deleting the Sharing Scopes.","properties":{"sharingScopes":{"type":"array","description":"List of results.","items":{"$ref":"#/components/schemas/SharingScopeDeleteResult"}}}}},"components/schemas/SharingScopeDeleteResult":{"id":"components/schemas/SharingScopeDeleteResult","kind":"json-schema","title":"SharingScopeDeleteResult","data":{"type":"object","description":"Result of deleting the Sharing Scope.","properties":{"sharingScope":{"$ref":"#/components/schemas/SharingScopeDelete"},"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 - the sharing scope 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 - the sharing scope is not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APPLICATION_OR_DELETION_IN_PROGRESS - the sharing scope is already deleted but deletion consequences are not yet applied"},"children":[]}]}]}]}],"example":"OK"}}}},"components/schemas/SharingScopeRefresh":{"id":"components/schemas/SharingScopeRefresh","kind":"json-schema","title":"SharingScopeRefresh","data":{"type":"object","description":"Refresh the Sharing Scope.","properties":{"id":{"$ref":"#/components/schemas/SharingScopeId"}}}},"components/schemas/SharingScopeRefreshResult":{"id":"components/schemas/SharingScopeRefreshResult","kind":"json-schema","title":"SharingScopeRefreshResult","data":{"type":"object","description":"Result of refreshing the Sharing Scope.","properties":{"sharingScope":{"$ref":"#/components/schemas/SharingScopeRefresh"},"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 - the sharing scope 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 - the sharing scope is not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APPLICATION_IN_PROGRESS - the sharing scope is already deleted but deletion consequences are not yet applied"},"children":[]}]}]}]}],"example":"OK"}}}},"components/schemas/SharingScopesReadFeatureParam":{"id":"components/schemas/SharingScopesReadFeatureParam","kind":"json-schema","title":"SharingScopesReadFeatureParam","data":{"type":"string","description":"Features to be used during the Scope Read.","example":"FETCH_JOB_DETAILS","enum":["FETCH_JOB_DETAILS"],"x-enumDescriptions":{"FETCH_JOB_DETAILS":"Fetch job status and progress. By default, off."}}},"components/schemas/SharingScopesPage":{"id":"components/schemas/SharingScopesPage","kind":"json-schema","title":"SharingScopesPage","data":{"type":"object","description":"Page of Sharing Scopes.","properties":{"values":{"type":"array","description":"List of Sharing Scopes.","items":{"$ref":"#/components/schemas/SharingScopeSearchResult"}},"limit":{"$ref":"#/components/schemas/Limit"},"startAfter":{"$ref":"#/components/schemas/StartAfter"},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"},"total":{"$ref":"#/components/schemas/PageTotal"}}}},"components/schemas/SharingScopeSearchResult":{"id":"components/schemas/SharingScopeSearchResult","kind":"json-schema","title":"SharingScopeSearchResult","data":{"type":"object","description":"Sharing Scope Search Result.","properties":{"id":{"$ref":"#/components/schemas/SharingScopeId"},"description":{"$ref":"#/components/schemas/SharingScopeDescription"},"dataSources":{"type":"array","description":"List of Data Sources.","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSource"}},"countries":{"type":"array","description":"List of Countries.","items":{"$ref":"#/components/schemas/SharingScopeCountry"}},"applyingJob":{"$ref":"#/components/schemas/SharingScopeApplyingJob"}}}},"components/schemas/DnbRecordsReadFeatureParam":{"id":"components/schemas/DnbRecordsReadFeatureParam","kind":"json-schema","title":"DnbRecordsReadFeatureParam","data":{"type":"string","description":"Features to be used during the read.","example":"SHOW_CDQ_RECORD","enum":["NUMBER_OF_TOTAL","SHOW_CDQ_RECORD","SHOW_FORMATTED_SAP_RECORD","USE_DNB_MASTER_DATA_BASIC","USE_DNB_MASTER_DATA_MGMT","USE_DNB_MASTER_DATA_LNKG","USE_DNB_MASTER_DATA_EXTENDED","USE_DNB_LINKAGE_LNKELI"],"x-enumDescriptions":{"NUMBER_OF_TOTAL":"Provides total number of records in the storage.","SHOW_CDQ_RECORD":"Provides CDQ record.","SHOW_FORMATTED_SAP_RECORD":"Provides formatted SAP record.","USE_DNB_MASTER_DATA_BASIC":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uses D&B Master Data Basic."},"children":[]}]}]}],"USE_DNB_MASTER_DATA_MGMT":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uses D&B Master Data Mgmt."},"children":[]}]}]}],"USE_DNB_MASTER_DATA_LNKG":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uses D&B Master Data Lnkg."},"children":[]}]}]}],"USE_DNB_MASTER_DATA_EXTENDED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uses D&B Master Data Extended."},"children":[]}]}]}],"USE_DNB_LINKAGE_LNKELI":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uses D&B Linkage LNKELI."},"children":[]}]}]}]}}},"components/schemas/DnbRecordPage":{"id":"components/schemas/DnbRecordPage","kind":"json-schema","title":"DnbRecordPage","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page of D&B Records."},"children":[]}]}]}],"properties":{"startAfter":{"$ref":"#/components/schemas/StartAfter"},"limit":{"$ref":"#/components/schemas/Limit"},"total":{"$ref":"#/components/schemas/PageTotal"},"values":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of D&B Records."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/DnbRecord"}},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"}}}},"components/schemas/DnbRecord":{"id":"components/schemas/DnbRecord","kind":"json-schema","title":"DnbRecord","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D&B Record."},"children":[]}]}]}],"properties":{"duns":{"$ref":"#/components/schemas/Duns"},"cmpelkV2":{"$ref":"#/components/schemas/CmpelkV2"},"dataBlock":{"$ref":"#/components/schemas/DataBlock"},"cdqRecord":{"$ref":"#/components/schemas/BusinessPartner"},"formattedSapRecord":{"$ref":"#/components/schemas/FormattedSapRecord"},"commercialUltimate":{"$ref":"#/components/schemas/CommercialUltimate"},"domesticCommercialUltimate":{"$ref":"#/components/schemas/CommercialUltimate"},"lastModifiedAt":{"$ref":"#/components/schemas/ModifiedAt"}}}},"components/schemas/FetchDnbRecordRequest":{"id":"components/schemas/FetchDnbRecordRequest","kind":"json-schema","title":"FetchDnbRecordRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters for fetch D&B record request by DUNS."},"children":[]}]}]}],"required":["duns"],"properties":{"duns":{"$ref":"#/components/schemas/Duns"},"featuresOn":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features to be used during the D&B storage creation."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/DnbStorageFeatureParam"}}}}},"components/schemas/DnbStorageFeatureParam":{"id":"components/schemas/DnbStorageFeatureParam","kind":"json-schema","title":"DnbStorageFeatureParam","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features for D&B Storage."},"children":[]}]}]}],"example":"USE_DNB","enum":["SHOW_CDQ_RECORD","SHOW_FORMATTED_SAP_RECORD","USE_DNB","USE_DNB_MASTER_DATA_BASIC","USE_DNB_MASTER_DATA_MGMT","USE_DNB_MASTER_DATA_LNKG","USE_DNB_MASTER_DATA_EXTENDED","USE_DNB_LINKAGE_LNKELI"],"x-enumDescriptions":{"SHOW_CDQ_RECORD":"Provides CDQ record.","SHOW_FORMATTED_SAP_RECORD":"Provides formatted SAP record.","USE_DNB":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Use Business Partner Storage for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Profile, Linkage, and Executives"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (CMPELK)"},"children":[]}]}]}],"USE_DNB_MASTER_DATA_BASIC":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Use for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master Data Basic"},"children":[]}]}]}]}],"USE_DNB_MASTER_DATA_MGMT":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Use for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master Data Management"},"children":[]}]}]}]}],"USE_DNB_MASTER_DATA_LNKG":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Use for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master Data Linkage"},"children":[]}]}]}]}],"USE_DNB_MASTER_DATA_EXTENDED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Use for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master Data Extended"},"children":[]}]}]}]}],"USE_DNB_LINKAGE_LNKELI":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Use for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extended Linkage Insight"},"children":[]}]}]}]}]}}},"components/schemas/FetchDnbRecordResult":{"id":"components/schemas/FetchDnbRecordResult","kind":"json-schema","title":"FetchDnbRecordResult","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 the fetch D&B record request."},"children":[]}]}]}],"properties":{"dnbRecord":{"$ref":"#/components/schemas/DnbRecord"},"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":" - D&B Record 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":" - D&B Record with that DUNS does not exist in storage."},"children":[]}]}]}]}],"example":"OK"},"message":{"type":"string","description":"Message describing the status of the request.","example":"D&B Record has been fetched successfully"}}}},"components/schemas/BusinessPartnersTransformAndUpsertRequest":{"id":"components/schemas/BusinessPartnersTransformAndUpsertRequest","kind":"json-schema","title":"BusinessPartnersTransformAndUpsertRequest","data":{"type":"object","description":"Put storageId on top to show in browsing rabbit messages when multiple Business Partners exist.","allOf":[{"type":"object","description":"Put storageId on top to show in browsing rabbit messages when multiple Business Partners exist.","properties":{"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"requests":{"type":"array","description":"List of Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartnerTransformAndUpsertRequest"}}}},{"$ref":"#/components/schemas/BusinessPartnersUpsertRequest"}]}},"components/schemas/BusinessPartnerTransformAndUpsertRequest":{"id":"components/schemas/BusinessPartnerTransformAndUpsertRequest","kind":"json-schema","title":"BusinessPartnerTransformAndUpsertRequest","data":{"type":"object","description":"Single request per business partner.","properties":{"businessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerId"},"previousBusinessPartner":{"$ref":"#/components/schemas/BusinessPartner"},"commercialMonitoringTransitions":{"type":"array","items":{"$ref":"#/components/schemas/CommercialMonitoringTransitionInfo"}}}}},"components/schemas/CommercialMonitoringTransitionInfo":{"id":"components/schemas/CommercialMonitoringTransitionInfo","kind":"json-schema","title":"CommercialMonitoringTransitionInfo","data":{"type":"object","description":"Transition definition.","properties":{"referenceDataSource":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"},"transition":{"$ref":"#/components/schemas/UpdateMonitoringTransition"}}}},"components/schemas/UpdateMonitoringTransition":{"id":"components/schemas/UpdateMonitoringTransition","kind":"json-schema","title":"UpdateMonitoringTransition","data":{"type":"string","description":"Transition type.","example":"ENABLED","x-enumDescriptions":{"NO_CHANGE_ENABLED":"No transition, monitoring enabled.","NO_CHANGE_DISABLED":"No transition, monitoring disabled.","ENABLED":"Was deactivated and became activated.","DISABLED":"Was activated and became deactivated."}}},"components/schemas/BusinessPartnerChunkIndexRequest":{"id":"components/schemas/BusinessPartnerChunkIndexRequest","kind":"json-schema","title":"BusinessPartnerChunkIndexRequest","data":{"type":"object","description":"Request for indexing a chunk of Business Partners.","properties":{"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"skipOldIndexing":{"type":"boolean","description":"Skip indexing of Business Partners that were already indexed.","example":"true"},"requests":{"type":"array","description":"List of Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartner"}}}}},"components/schemas/BusinessPartnerChunkIdentityLinkageRequest":{"id":"components/schemas/BusinessPartnerChunkIdentityLinkageRequest","kind":"json-schema","title":"BusinessPartnerChunkIdentityLinkageRequest","data":{"type":"object","description":"Request for linking a chunk of Business Partners.","properties":{"link":{"type":"boolean","description":"Performs linkage or unlinkage.","default":true,"example":"true"},"referenceDataSource":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"},"referenceDataSourceId":{"type":"string","description":"ID of monitored data source within own Business Partner Storage.","example":"648824a691d8d2503d65103e"},"linkageStrategy":{"$ref":"#/components/schemas/LinkageStrategy"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"organizationId":{"$ref":"#/components/schemas/OrganizationId"},"featuresOn":{"type":"array","description":"List of features that cna be activated during the linkage.","items":{"$ref":"#/components/schemas/BusinessPartnerIdentityLinkageFeature"}},"featuresOff":{"type":"array","description":"List of features that cna be activated during the linkage.","items":{"$ref":"#/components/schemas/BusinessPartnerIdentityLinkageFeature"}},"requests":{"type":"array","description":"List of Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartner"}},"requestsV2":{"type":"array","description":"List of Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartnerLinkageRequest"}},"source":{"type":"string","description":"For debugging purposes.","example":"CDQ"},"disabledCdqIds":{"type":"array","description":"List of cdqIds that were deleted and should not be selected during lookup.","items":{"$ref":"#/components/schemas/ProvenanceCdqId"}}}}},"components/schemas/BusinessPartnerLinkageRequest":{"id":"components/schemas/BusinessPartnerLinkageRequest","kind":"json-schema","title":"BusinessPartnerLinkageRequest","data":{"type":"object","description":"Single processable request as a part of batch of requests. Link is present only when recalculating seed updates.","properties":{"sourceEventId":{"$ref":"#/components/schemas/SourceEventId"},"businessPartner":{"$ref":"#/components/schemas/LinkageRequestBusinessPartner"},"candidate":{"$ref":"#/components/schemas/LinkageRequestBusinessPartner"},"identityLink":{"$ref":"#/components/schemas/BusinessPartnerIdentityLink"}}}},"components/schemas/SourceEventId":{"id":"components/schemas/SourceEventId","kind":"json-schema","title":"SourceEventId","data":{"type":"string","description":"Identifier of the source event that triggered this linkage request.","example":"6532675dfed41d061fdb3360"}},"components/schemas/LinkageRequestBusinessPartner":{"id":"components/schemas/LinkageRequestBusinessPartner","kind":"json-schema","title":"LinkageRequestBusinessPartner","data":{"type":"object","description":"Business partner restricted only to fields required in business-partner-identity-linkage-worker","properties":{"id":{"description":"Business Partner identifier within a storage. Autogenerated.","example":"1234567891234567","type":"string"},"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"dataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"disclosed":{"$ref":"#/components/schemas/BusinessPartnerDisclosed"},"updateMonitoring":{"$ref":"#/components/schemas/BusinessPartnerUpdateMonitoring"},"updateCommercialMonitoring":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enabling update commercial monitoring has 2 possibilities:"},"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":"via Data Mapper Definition: include mapping of updateCommercialMonitoring in the Data Mapper Definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via direct Business Partner model upload: fill complete Business Partner model and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateCommercialMonitoring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null/undefined "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateCommercialMonitoring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in protection of this setup from the previous upsert."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Empty or filled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateCommercialMonitoring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in data transition that may link or unlink to / from respective"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commercial Reference Data Source"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: follow the approach that is currently used in your storage integration."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BusinessPartnerUpdateCommercialMonitoring"}},"names":{"type":"array","items":{"$ref":"#/components/schemas/LinkageRequestName"}},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/LinkageRequestIdentifier"}},"categories":{"type":"array","description":"List of Categories.","items":{"$ref":"#/components/schemas/LinkageRequestBusinessPartnerCategory"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/LinkageRequestAddress"}},"externalContext":{"$ref":"#/components/schemas/ExternalContext"}}}},"components/schemas/LinkageRequestName":{"id":"components/schemas/LinkageRequestName","kind":"json-schema","title":"LinkageRequestName","data":{"type":"object","description":"Name restricted only to fields required in business-partner-identity-linkage-worker","properties":{"type":{"$ref":"#/components/schemas/LinkageRequestNameType"},"value":{"$ref":"#/components/schemas/NameValue"}}}},"components/schemas/LinkageRequestNameType":{"id":"components/schemas/LinkageRequestNameType","kind":"json-schema","title":"LinkageRequestNameType","data":{"type":"object","description":"Identifier Type restricted only to fields required in business-partner-identity-linkage-worker","properties":{"technicalKey":{"$ref":"#/components/schemas/NameTypeTechnicalKey"}}}},"components/schemas/LinkageRequestIdentifier":{"id":"components/schemas/LinkageRequestIdentifier","kind":"json-schema","title":"LinkageRequestIdentifier","data":{"type":"object","description":"Identifier restricted only to fields required in business-partner-identity-linkage-worker","properties":{"type":{"$ref":"#/components/schemas/LinkageRequestIdentifierType"},"value":{"$ref":"#/components/schemas/IdentifierValue"},"issuingBody":{"$ref":"#/components/schemas/LinkageRequestIssuingBody"}}}},"components/schemas/LinkageRequestIdentifierType":{"id":"components/schemas/LinkageRequestIdentifierType","kind":"json-schema","title":"LinkageRequestIdentifierType","data":{"type":"object","description":"Identifier Type restricted only to fields required in business-partner-identity-linkage-worker","properties":{"technicalKey":{"$ref":"#/components/schemas/schemas-IdentifierTypeTechnicalKey"}}}},"components/schemas/LinkageRequestIssuingBody":{"id":"components/schemas/LinkageRequestIssuingBody","kind":"json-schema","title":"LinkageRequestIssuingBody","data":{"type":"object","description":"Issuing Body restricted only to fields required in business-partner-identity-linkage-worker","properties":{"technicalKey":{"$ref":"#/components/schemas/IssuingBodyTechnicalKey"}}}},"components/schemas/LinkageRequestBusinessPartnerCategory":{"id":"components/schemas/LinkageRequestBusinessPartnerCategory","kind":"json-schema","title":"LinkageRequestBusinessPartnerCategory","data":{"type":"object","description":"A business partner category of a business partner groups similar business partners.","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerCategoryName"},"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerCategoryTechnicalKey"}}}},"components/schemas/LinkageRequestAddress":{"id":"components/schemas/LinkageRequestAddress","kind":"json-schema","title":"LinkageRequestAddress","data":{"type":"object","description":"Address restricted only to fields required in business-partner-identity-linkage-worker","properties":{"id":{"description":"Address identifier within a Business Partner. Autogenerated.","example":"0","type":"string"},"externalId":{"$ref":"#/components/schemas/AddressExternalId"},"cdqId":{"$ref":"#/components/schemas/AddressCdqId"},"version":{"$ref":"#/components/schemas/AddressVersion"},"country":{"$ref":"#/components/schemas/Country"},"administrativeAreas":{"type":"array","items":{"$ref":"#/components/schemas/LinkageRequestAdministrativeArea"}},"postCodes":{"type":"array","items":{"$ref":"#/components/schemas/LinkageRequestPostCode"}},"localities":{"type":"array","items":{"$ref":"#/components/schemas/LinkageRequestLocality"}},"thoroughfares":{"type":"array","items":{"$ref":"#/components/schemas/LinkageRequestThoroughfare"}},"types":{"type":"array","items":{"$ref":"#/components/schemas/LinkageRequestAddressType"}}}}},"components/schemas/LinkageRequestAdministrativeArea":{"id":"components/schemas/LinkageRequestAdministrativeArea","kind":"json-schema","title":"LinkageRequestAdministrativeArea","data":{"type":"object","description":"Administrative Area restricted only to fields required in business-partner-identity-linkage-worker","properties":{"type":{"$ref":"#/components/schemas/LinkageRequestAdministrativeAreaType"},"value":{"$ref":"#/components/schemas/AdministrativeAreaValue"}}}},"components/schemas/LinkageRequestAdministrativeAreaType":{"id":"components/schemas/LinkageRequestAdministrativeAreaType","kind":"json-schema","title":"LinkageRequestAdministrativeAreaType","data":{"type":"object","description":"Administrative Area Type restricted only to fields required in business-partner-identity-linkage-worker","properties":{"technicalKey":{"$ref":"#/components/schemas/AdministrativeAreaTypeTechnicalKey"}}}},"components/schemas/LinkageRequestPostCode":{"id":"components/schemas/LinkageRequestPostCode","kind":"json-schema","title":"LinkageRequestPostCode","data":{"type":"object","description":"Post Code restricted only to fields required in business-partner-identity-linkage-worker","properties":{"type":{"$ref":"#/components/schemas/LinkageRequestPostCodeType"},"value":{"$ref":"#/components/schemas/PostCodeValue"}}}},"components/schemas/LinkageRequestPostCodeType":{"id":"components/schemas/LinkageRequestPostCodeType","kind":"json-schema","title":"LinkageRequestPostCodeType","data":{"type":"object","description":"Post Code Type restricted only to fields required in business-partner-identity-linkage-worker","properties":{"technicalKey":{"$ref":"#/components/schemas/PostCodeTypeTechnicalKey"}}}},"components/schemas/LinkageRequestLocality":{"id":"components/schemas/LinkageRequestLocality","kind":"json-schema","title":"LinkageRequestLocality","data":{"type":"object","description":"Locality restricted only to fields required in business-partner-identity-linkage-worker","properties":{"type":{"$ref":"#/components/schemas/LinkageRequestLocalityType"},"value":{"$ref":"#/components/schemas/LocalityValue"}}}},"components/schemas/LinkageRequestLocalityType":{"id":"components/schemas/LinkageRequestLocalityType","kind":"json-schema","title":"LinkageRequestLocalityType","data":{"type":"object","description":"Locality Type restricted only to fields required in business-partner-identity-linkage-worker","properties":{"technicalKey":{"$ref":"#/components/schemas/LocalityTypeTechnicalKey"}}}},"components/schemas/LinkageRequestThoroughfare":{"id":"components/schemas/LinkageRequestThoroughfare","kind":"json-schema","title":"LinkageRequestThoroughfare","data":{"type":"object","description":"Thoroughfare restricted only to fields required in business-partner-identity-linkage-worker","properties":{"type":{"$ref":"#/components/schemas/LinkageRequestThoroughfareType"},"value":{"$ref":"#/components/schemas/ThoroughfareValue"},"number":{"$ref":"#/components/schemas/ThoroughfareNumber"}}}},"components/schemas/LinkageRequestThoroughfareType":{"id":"components/schemas/LinkageRequestThoroughfareType","kind":"json-schema","title":"LinkageRequestThoroughfareType","data":{"type":"object","description":"Thoroughfare Type restricted only to fields required in business-partner-identity-linkage-worker","properties":{"technicalKey":{"$ref":"#/components/schemas/ThoroughfareTypeTechnicalKey"}}}},"components/schemas/LinkageRequestAddressType":{"id":"components/schemas/LinkageRequestAddressType","kind":"json-schema","title":"LinkageRequestAddressType","data":{"type":"object","description":"Address Type restricted only to fields required in business-partner-identity-linkage-worker.","properties":{"technicalKey":{"$ref":"#/components/schemas/AddressTypeTechnicalKey"}}}},"components/schemas/BusinessPartnerIdentityLinkageFeature":{"id":"components/schemas/BusinessPartnerIdentityLinkageFeature","kind":"json-schema","title":"BusinessPartnerIdentityLinkageFeature","data":{"type":"string","description":"The feature to be used during Business Partner Identity Linkage.","example":"DNB_AUTO_SUBSCRIBE","enum":["DNB_AUTO_SUBSCRIBE","REFRESH_SUCCESSFUL_LINKS","SEED_UPDATES","GENERATE_SEED_UPDATES_ONLY"],"x-enumDescriptions":{"DNB_AUTO_SUBSCRIBE":"Automatically subscribe to DNB commercial monitoring when the linkage is created. By default deactivated.","REFRESH_SUCCESSFUL_LINKS":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reevaluate already successful link by removing existing one in favor of creating new. Used when cdqId changes in reference data source. When used, it's recommended to send SEED_UPDATES in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featuresOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to avoid sending seed update. By default deactivated."},"children":[]}]}]}],"SEED_UPDATES":"Send updates to event store of linked business partners. By default activated.","GENERATE_SEED_UPDATES_ONLY":"Send seed updates to event store for given business partner. By default deactivated."}}},"components/schemas/BusinessPartnersWorkerUpsertResult":{"id":"components/schemas/BusinessPartnersWorkerUpsertResult","kind":"json-schema","title":"BusinessPartnersWorkerUpsertResult","data":{"type":"object","description":"Result of Business Partners Upsert.","properties":{"numberOfProcessed":{"type":"integer","description":"Number of Business Partners processed.","example":"10"},"numberOfInserts":{"type":"integer","description":"Number of inserted Business Partners.","example":"10"},"numberOfUpdates":{"type":"integer","description":"Number of updated Business Partners.","example":"10"},"numberOfNoChanges":{"type":"integer","description":"Number of Business Partners with no changes.","example":"10"},"numberOfFailed":{"type":"integer","description":"Number of failed inserts.","example":"10"},"numberOfInvalidMappings":{"type":"integer","description":"Number of Business Partners that failed transformation due to invalid mapping.","example":10},"failures":{"type":"array","description":"List of failures.","items":{"$ref":"#/components/schemas/UpsertFailureLog"}},"businessPartners":{"type":"array","description":"List of Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartnerUpserted"}}}}},"components/schemas/BusinessPartnerUpserted":{"id":"components/schemas/BusinessPartnerUpserted","kind":"json-schema","title":"BusinessPartnerUpserted","data":{"type":"object","description":"Business Partner with additional information.","properties":{"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"}}}},"components/schemas/BusinessPartnerWorkerIdentityLinkageResult":{"id":"components/schemas/BusinessPartnerWorkerIdentityLinkageResult","kind":"json-schema","title":"BusinessPartnerWorkerIdentityLinkageResult","data":{"type":"object","description":"Results of the linkage task.","properties":{"numberOfProcessed":{"description":"Number of all BusinessPartners processed (successfully or not)","type":"integer","example":"10"},"numberOfIdentityLinkCreations":{"description":"Number of newly created links","type":"integer","example":"10"},"numberOfSuccessfulIdentityLinkCreations":{"description":"Number of newly created links with successful linkage.","type":"integer","example":"10"},"numberOfRefreshSuccessfulLinkCreations":{"description":"Number of refreshed successful links with successful linkage.","type":"integer","example":"10"},"numberOfIdentityLinkDeletions":{"description":"Number of deleted links","type":"integer","example":"10"},"numberOfUpdateMonitoringEnabled":{"description":"Number of Business Partners with activated update monitoring","type":"integer","example":"10"},"numberOfUpdateMonitoringDisabled":{"description":"Number of Business Partners with deactivated update monitoring","type":"integer","example":"10"},"numberOfAlreadyExistingIdentityLinks":{"description":"Number of already existing links","type":"integer","example":"10"},"numberOfNoMatches":{"description":"BusinessPartners not found in lookup","type":"integer","example":"10"},"numberOfVersionNoMatches":{"description":"BusinessPartners not found in lookup by version","type":"integer","example":"10"},"numberOfThresholdRejections":{"description":"BusinessPartners rejected via threshold","type":"integer","example":"10"},"numberOfFailedLookups":{"description":"Lookup request failures during execution","type":"integer","example":"10"},"numberOfFailed":{"description":"Any kind of failures during execution","type":"integer","example":"10"},"numberOfNoIdentifier":{"description":"BusinessPartners have no identifiers","type":"integer","example":"10"},"numberOfNoCountry":{"description":"BusinessPartners have no country","type":"integer","example":"10"},"numberOfMissingInformationForLinkage":{"description":"BusinessPartners have remaining missing information for linkage.","type":"integer","example":"10"},"numberOfNoAccess":{"description":"BusinessPartners rejected due to no access to the resource","type":"integer","example":"10"},"numberOfNotFoundInReferenceData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of links for which the reference data source did not contain the business partner (only for GENERATE_SEED_UPDATES_ONLY)"},"children":[]}]}]}],"type":"integer","example":"10"},"numberOfCreatedSeedUpdates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of seed updates created (only for GENERATE_SEED_UPDATES_ONLY)"},"children":[]}]}]}],"type":"integer","example":"10"},"numberOfProcessIssue":{"description":"Number of Business Partners with process issues","type":"integer","example":"10"},"numberOfQuotaLimit":{"description":"Number of Business Partners with quota limit","type":"integer","example":"10"},"numberOfInactiveSource":{"description":"Number of Business Partners with inactive source","type":"integer","example":"10"},"numberOfErroneousIdentifier":{"description":"Number of Business Partners with erroneous identifier","type":"integer","example":"10"},"numberOfExternalServiceNotAvailable":{"description":"Number of Business Partners with external service not available","type":"integer","example":"10"}}}},"components/schemas/BusinessPartnersDeleteWorkerRequest":{"id":"components/schemas/BusinessPartnersDeleteWorkerRequest","kind":"json-schema","title":"BusinessPartnersDeleteWorkerRequest","data":{"type":"object","description":"Request to delete a list of Business Partners.","allOf":[{"$ref":"#/components/schemas/BusinessPartnersDeleteRequest"},{"type":"object","description":"Request to delete a list of Business Partners.","properties":{"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"referenceDataSource":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"},"source":{"type":"string","description":"for debug purposes","example":"CDQ"}}}]}},"components/schemas/BusinessPartnersWorkerDeleteResult":{"id":"components/schemas/BusinessPartnersWorkerDeleteResult","kind":"json-schema","title":"BusinessPartnersWorkerDeleteResult","data":{"type":"object","description":"Results of the delete task.","properties":{"numberOfProcessed":{"type":"integer","description":"Number of processed Business Partners.","example":"10"},"numberOfDeletes":{"type":"integer","description":"Number of deleted Business Partners.","example":"10"},"numberOfFailed":{"type":"integer","description":"Number of failed deletes.","example":"10"},"failures":{"type":"array","description":"List of failures.","items":{"$ref":"#/components/schemas/DeleteFailureLog"}}}}},"components/schemas/StorageLongOperationRequest":{"id":"components/schemas/StorageLongOperationRequest","kind":"json-schema","title":"StorageLongOperationRequest","data":{"type":"object","description":"Parameters for storage long operation worker.","properties":{"featuresOn":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/StorageLongOperationFeature"}},"organizationId":{"$ref":"#/components/schemas/OrganizationId"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"indexNameToProcess":{"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 index to be processed. Used in REMOVE_MONGO_INDEXES."},"children":[]}]}]}],"example":"fieldA_1_fieldB_-1__id_1"},"processingStatusTechnicalKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing status technical key. Used in BATCH_CURATION_PROCESSING_STATUS and BATCH_VALIDATION_PROCESSING_STATUS."},"children":[]}]}]}],"$ref":"#/components/schemas/ProcessingStatusTechnicalKey"},"dataSourceIds":{"type":"array","description":"List of Data Sources IDs.","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}},"referenceDataSource":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"},"countryShortNames":{"type":"array","description":"List of Country Short Names to be included.","items":{"$ref":"#/components/schemas/CountryShortName"}},"exceptCountryShortNames":{"type":"array","description":"List of Country Short Names to be excluded.","items":{"$ref":"#/components/schemas/CountryShortName"}},"startAfter":{"$ref":"#/components/schemas/StartAfter"}}}},"components/schemas/StorageLongOperationFeature":{"id":"components/schemas/StorageLongOperationFeature","kind":"json-schema","title":"StorageLongOperationFeature","data":{"type":"string","description":"Features to be activated with Long Operation.","example":"ENABLE_UPDATE_MONITORING","enum":["BATCH_CURATION_PROCESSING_STATUS","BATCH_VALIDATION_PROCESSING_STATUS","CLEAN_CDQ_POOL_SETTING","CLEAR_EVENT_STORE","CLEAR_PREVIOUS_EVENT_STORE","CLEAR_STORAGE","COUNT_EVENT_STORE","COUNT_IDENTITY_LINKS","COUNT_PREVIOUS_EVENT_STORE","COUNT_SUBSCRIPTIONS","DELETE_EXPIRED_STORAGE","DELETE_IDENTITY_LINKS_FOR_ORGANIZATION","DELETE_STORAGE_COLLECTION","DELETE_SUBSCRIPTIONS_FOR_ORGANIZATION","DISABLE_DISCLOSED","DISABLE_UPDATE_MONITORING","ENABLE_DISCLOSED","ENABLE_UPDATE_MONITORING","RELOAD_EXPIRES_AT","REMOVE_EXTRA_MONGO_INDEXES","REMOVE_MONGO_INDEX","RESTORE_CDQ_POOL_SETTING","SYNCHRONIZE_MONGO_INDEXES","VERIFY_MONGO_INDEXES_ONLY"],"x-enumDescriptions":{"CLEAN_CDQ_POOL_SETTING":"Remove CDQ.POOL from organizational settings. Used only when collaboration restart is invoked. Should not be used anymore, at least after last decisions.","CLEAR_EVENT_STORE":"Drops and recreates the event store for business partner storage. All events are deleted, so a verified backup is required before using it.","CLEAR_PREVIOUS_EVENT_STORE":"Deletes the previous event store of the business partner storage. All events are deleted, so a verified backup is required before using it.","CLEAR_STORAGE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invokes clearing of business partner storage, like the storages/{}/clear endpoint."},"children":[]}]}]}],"COUNT_EVENT_STORE":"Counts the number of events in the event store of business partner storage.","COUNT_IDENTITY_LINKS":"Counts number of Business Partner identity links for ReferenceDataSource.","COUNT_PREVIOUS_EVENT_STORE":"Counts the number of events in the previous event store of the business partner storage.","COUNT_SUBSCRIPTIONS":"Counts number of subscriptions for ReferenceDataSource.","DELETE_STORAGE_COLLECTION":"Deletes storage collection in MongoDB.","DELETE_EXPIRED_STORAGE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable only when the RELOAD_EXPIRES_AT feature is used. Deletes business partner storage when it has expired after reloading expiresAt."},"children":[]}]}]}],"DISABLE_DISCLOSED":"Sets disclosed to false for all Business Partners selected by parameters.","ENABLE_DISCLOSED":"Disclosed true.","DISABLE_UPDATE_MONITORING":"Sets Update Monitoring to false.","ENABLE_UPDATE_MONITORING":"Sets Update Monitoring to true.","RELOAD_EXPIRES_AT":"Invokes reloading expires at for business partner storage.","RESTORE_CDQ_POOL_SETTING":"Set back CDQ.POOL storageId to organizational settings.","REMOVE_EXTRA_MONGO_INDEXES":"Deletes any extra index (manually created or no longer created programmatically) for collections related to business partner storage.","REMOVE_MONGO_INDEX":"Removes specified index. Requires field 'indexNameToProcess' to be filled. Currently works only for BP storage.","SYNCHRONIZE_MONGO_INDEXES":"Creates missing indexes for collections related to business partner storage. Does not delete any indexes.","VERIFY_MONGO_INDEXES_ONLY":"Searches for missing/extra indexes for collections related to business partner storage."}}},"components/schemas/StorageLongOperationResult":{"id":"components/schemas/StorageLongOperationResult","kind":"json-schema","title":"StorageLongOperationResult","data":{"type":"object","description":"Results of the storage long operation task.","properties":{"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution status of storage long operation:"},"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":" - Operation has been finished 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":" - Operation has failed"},"children":[]}]}]}]}],"example":"OK"},"statusMessage":{"type":"string","description":"Execution status message of storage long operation.","example":"Operation has been finished successfully"},"numberOfProcessed":{"type":"integer","format":"int64","description":"Number of processed Business Partners.","example":"10"},"numberOfInserts":{"type":"integer","format":"int64","description":"Number of inserted Business Partners.","example":"10"},"numberOfUpdates":{"type":"integer","format":"int64","description":"Number of updated Business Partners.","example":"10"},"numberOfDeletes":{"type":"integer","format":"int64","description":"Number of deleted Business Partners.","example":"10"},"numberOfFailed":{"type":"integer","format":"int64","description":"Number of failed Business Partners.","example":"10"}}}},"components/schemas/RelationsReadActingParam":{"id":"components/schemas/RelationsReadActingParam","kind":"json-schema","title":"RelationsReadActingParam","data":{"type":"string","description":"Indicator for acting of the relation.","example":"ACTIVE","default":"ACTIVE","enum":["ACTIVE","INACTIVE"],"x-enumDescriptions":{"ACTIVE":"Only active relations.","INACTIVE":"Only inactive relations."}}},"components/schemas/BusinessPartnerRelationsPage":{"id":"components/schemas/BusinessPartnerRelationsPage","kind":"json-schema","title":"BusinessPartnerRelationsPage","data":{"type":"object","description":"Page displaying relations between Business Partners.","properties":{"startAfter":{"$ref":"#/components/schemas/StartAfter"},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"},"limit":{"$ref":"#/components/schemas/Limit"},"total":{"$ref":"#/components/schemas/PageTotal"},"values":{"type":"array","description":"List of relations between Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartnerRelation"}}}}},"components/schemas/RelationsReadFeatureParam":{"id":"components/schemas/RelationsReadFeatureParam","kind":"json-schema","title":"RelationsReadFeatureParam","data":{"type":"string","description":"Features to be activated for reading relations.","example":"SHOW_BUSINESS_PARTNER_INFORMATION","enum":["SHOW_BUSINESS_PARTNER_INFORMATION"],"x-enumDescriptions":{"SHOW_BUSINESS_PARTNER_INFORMATION":"Allows to switch fetching business partner details to improve performance. By default, turned on."}}},"components/schemas/BusinessPartnerRelationsDeleteRequest":{"id":"components/schemas/BusinessPartnerRelationsDeleteRequest","kind":"json-schema","title":"BusinessPartnerRelationsDeleteRequest","data":{"type":"object","description":"Request to delete relations.","properties":{"relations":{"type":"array","description":"List of relations to delete.","items":{"$ref":"#/components/schemas/BusinessPartnerRelationDelete"}}}}},"components/schemas/BusinessPartnerRelationDelete":{"id":"components/schemas/BusinessPartnerRelationDelete","kind":"json-schema","title":"BusinessPartnerRelationDelete","data":{"type":"object","description":"Delete relation by startNode and endNode. StartNode is required. If endNode is null, then delete all relations for BP from startNode (both as startNode or endNode).","required":["startNode"],"properties":{"startNode":{"$ref":"#/components/schemas/BusinessPartnerRelationNode"},"endNode":{"$ref":"#/components/schemas/BusinessPartnerRelationNode"},"type":{"$ref":"#/components/schemas/BusinessPartnerRelationTypeTechnicalKey"},"class":{"$ref":"#/components/schemas/BusinessPartnerRelationClassDelete"}}}},"components/schemas/BusinessPartnerRelationClassDelete":{"id":"components/schemas/BusinessPartnerRelationClassDelete","kind":"json-schema","title":"BusinessPartnerRelationClassDelete","data":{"type":"object","description":"Provides information about the classification of the relation that is to be deleted.","properties":{"technicalKey":{"$ref":"#/components/schemas/BusinessPartnerRelationClassTechnicalKey"}}}},"components/schemas/BusinessPartnerRelationNode":{"id":"components/schemas/BusinessPartnerRelationNode","kind":"json-schema","title":"BusinessPartnerRelationNode","data":{"type":"object","description":"Unique identifiers for Business Partner in the relation","properties":{"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}}}},"components/schemas/BusinessPartnerRelationsDeleteResult":{"id":"components/schemas/BusinessPartnerRelationsDeleteResult","kind":"json-schema","title":"BusinessPartnerRelationsDeleteResult","data":{"type":"object","description":"Result of deleting relations.","properties":{"deleted":{"type":"integer","description":"Number of deleted relations.","example":"10"}}}},"components/schemas/DecisionLogResult":{"id":"components/schemas/DecisionLogResult","kind":"json-schema","title":"DecisionLogResult","data":{"type":"object","description":"Outcome of a decision-making process based on a decision log.","properties":{"reviewStatus":{"$ref":"#/components/schemas/ReviewStatusParam"},"naturalPersonsReviewStatus":{"$ref":"#/components/schemas/ReviewStatusParam"},"duplicatesReviewStatus":{"$ref":"#/components/schemas/ReviewStatusParam"}}}},"components/schemas/ReviewStatusParam":{"id":"components/schemas/ReviewStatusParam","kind":"json-schema","title":"ReviewStatusParam","data":{"type":"string","description":"Review status of the Business Partner.","example":"REVIEWED","enum":["REVIEWED","NOT_REVIEWED"],"x-enumDescriptions":{"REVIEWED":"Reviewed.","NOT_REVIEWED":"Not reviewed."}}},"components/schemas/BusinessPartnerTagCreates":{"id":"components/schemas/BusinessPartnerTagCreates","kind":"json-schema","title":"BusinessPartnerTagCreates","data":{"type":"object","description":"Create Business Partner Tags.","required":["tags"],"properties":{"tags":{"type":"array","description":"List of Tags.","maxItems":30,"items":{"$ref":"#/components/schemas/TagCreate"}}}}},"components/schemas/TagCreate":{"id":"components/schemas/TagCreate","kind":"json-schema","title":"TagCreate","data":{"type":"object","description":"Typed string describing and identifying a resource. Custom information about the resource in form of a tag.","required":["value","type"],"properties":{"value":{"$ref":"#/components/schemas/TagValue"},"type":{"$ref":"#/components/schemas/TagType"}}}},"components/schemas/BusinessPartnerTagCreateResults":{"id":"components/schemas/BusinessPartnerTagCreateResults","kind":"json-schema","title":"BusinessPartnerTagCreateResults","data":{"type":"object","description":"Result page with created tags.","properties":{"tags":{"$ref":"#/components/schemas/Tags"},"results":{"type":"array","description":"List of results.","items":{"$ref":"#/components/schemas/BusinessPartnerTagCreateResult"}}}}},"components/schemas/BusinessPartnerTagCreateResult":{"id":"components/schemas/BusinessPartnerTagCreateResult","kind":"json-schema","title":"BusinessPartnerTagCreateResult","data":{"type":"object","description":"Result of tag creation.","properties":{"tag":{"$ref":"#/components/schemas/TagCreate"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag creation 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":"text","inline":true,"attributes":{"content":"OK - the tag has been created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUPLICATE - the tag already existed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OVER_LIMIT - the tag exceeded allowed tags limit of 30 tags"},"children":[]}]}]}]}],"example":"OK"}}}},"components/schemas/BusinessPartnerTagDeletes":{"id":"components/schemas/BusinessPartnerTagDeletes","kind":"json-schema","title":"BusinessPartnerTagDeletes","data":{"type":"object","description":"Delete Business Partner Tags.","required":["tags"],"properties":{"tags":{"type":"array","description":"List of deleted Tags.","maxItems":30,"items":{"$ref":"#/components/schemas/TagDelete"}}}}},"components/schemas/TagDelete":{"id":"components/schemas/TagDelete","kind":"json-schema","title":"TagDelete","data":{"type":"object","description":"Typed string describing and identifying a resource. Custom information about the resource in form of a tag.","required":["value","type"],"properties":{"value":{"$ref":"#/components/schemas/TagValue"},"type":{"$ref":"#/components/schemas/TagType"}}}},"components/schemas/BusinessPartnerTagDeleteResults":{"id":"components/schemas/BusinessPartnerTagDeleteResults","kind":"json-schema","title":"BusinessPartnerTagDeleteResults","data":{"type":"object","description":"Result page with deleted tags.","properties":{"tags":{"$ref":"#/components/schemas/Tags"},"results":{"type":"array","description":"List of results.","items":{"$ref":"#/components/schemas/BusinessPartnerTagDeleteResult"}}}}},"components/schemas/BusinessPartnerTagDeleteResult":{"id":"components/schemas/BusinessPartnerTagDeleteResult","kind":"json-schema","title":"BusinessPartnerTagDeleteResult","data":{"type":"object","description":"Result of tag deletion.","properties":{"tag":{"$ref":"#/components/schemas/TagDelete"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag deletion 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":"text","inline":true,"attributes":{"content":"OK - the tag has been deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND - the tag is not found"},"children":[]}]}]}]}],"example":"OK"}}}},"components/schemas/Tags":{"id":"components/schemas/Tags","kind":"json-schema","title":"Tags","data":{"type":"array","description":"List of Tags.","items":{"$ref":"#/components/schemas/Tag"}}},"components/schemas/UpdateClassificationConfigurationId":{"id":"components/schemas/UpdateClassificationConfigurationId","kind":"json-schema","title":"UpdateClassificationConfigurationId","data":{"type":"string","description":"Update Classification Configuration Id.","example":"123"}},"components/schemas/UpdateClassificationCountry":{"id":"components/schemas/UpdateClassificationCountry","kind":"json-schema","title":"UpdateClassificationCountry","data":{"type":"object","description":"Country for which classification is updated.","required":["shortName"],"properties":{"shortName":{"$ref":"#/components/schemas/CountryShortName"}}}},"components/schemas/PropertyChangeClassificationRequest":{"id":"components/schemas/PropertyChangeClassificationRequest","kind":"json-schema","title":"PropertyChangeClassificationRequest","data":{"type":"object","description":"Property change classification request.","required":["changeType","property"],"properties":{"externalIds":{"type":"array","description":"List of external IDs.","items":{"$ref":"#/components/schemas/ExternalId"}},"property":{"$ref":"#/components/schemas/Property"},"newContent":{"$ref":"#/components/schemas/PropertyNewContent"},"previousContent":{"$ref":"#/components/schemas/PropertyPreviousContent"},"changeType":{"$ref":"#/components/schemas/PropertyChangeTypeTechnicalKey"}}}},"components/schemas/PropertyChangeClassification":{"id":"components/schemas/PropertyChangeClassification","kind":"json-schema","title":"PropertyChangeClassification","data":{"type":"object","description":"Property change classification.","properties":{"propertyChange":{"$ref":"#/components/schemas/PropertyChangeClassificationRequest"},"changeClassification":{"$ref":"#/components/schemas/schemas-PropertyChangeClassification"},"status":{"$ref":"#/components/schemas/PropertyChangeClassificationStatus"},"rule":{"$ref":"#/components/schemas/PropertyChangeClassificationRule"}}}},"components/schemas/PropertyChangeClassificationRule":{"id":"components/schemas/PropertyChangeClassificationRule","kind":"json-schema","title":"PropertyChangeClassificationRule","data":{"type":"object","description":"Rule used to classify property change.","properties":{"url":{"$ref":"#/components/schemas/PropertyChangeClassificationRuleUrl"}}}},"components/schemas/PropertyChangeClassificationRuleUrl":{"id":"components/schemas/PropertyChangeClassificationRuleUrl","kind":"json-schema","title":"PropertyChangeClassificationRuleUrl","data":{"type":"string","description":"Url of rule.","example":"All available urls of the rules can be found [here](https://meta.cdq.com/Category:UpdateClassification)."}},"components/schemas/PropertyChangeClassificationStatus":{"id":"components/schemas/PropertyChangeClassificationStatus","kind":"json-schema","title":"PropertyChangeClassificationStatus","data":{"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"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNSUPPORTED_CONCEPT"},"children":[]}]}]}]}],"example":"OK"}},"components/schemas/TransformToPropertyChangesResult":{"id":"components/schemas/TransformToPropertyChangesResult","kind":"json-schema","title":"TransformToPropertyChangesResult","data":{"type":"object","description":"Result of transforming Business Partner to Property Changes.","properties":{"businessPartner":{"$ref":"#/components/schemas/BusinessPartner"},"propertyChanges":{"type":"array","description":"List of property changes.","items":{"$ref":"#/components/schemas/PropertyChange2"}}}}},"components/schemas/VatPayerStatus":{"id":"components/schemas/VatPayerStatus","kind":"json-schema","title":"VatPayerStatus","data":{"type":"object","description":"Shows whether the Business Partner is a VAT payer.","properties":{"publicationDate":{"$ref":"#/components/schemas/VatPayerStatusPublicationDate"},"status":{"$ref":"#/components/schemas/PayerStatus"},"registrationAuthority":{"$ref":"#/components/schemas/RegistrationAuthority"}}}},"components/schemas/RegistrationAuthority":{"id":"components/schemas/RegistrationAuthority","kind":"json-schema","title":"RegistrationAuthority","data":{"type":"object","description":"Shows the registration authority of the Business Partner.","properties":{"registrationAuthorityId":{"$ref":"#/components/schemas/RegistrationAuthorityId"},"registrationAuthorityEntityId":{"$ref":"#/components/schemas/RegistrationAuthorityEntityId"},"otherRegistrationAuthorityId":{"$ref":"#/components/schemas/OtherRegistrationAuthorityId"}}}},"components/schemas/PayerStatus":{"id":"components/schemas/PayerStatus","kind":"json-schema","title":"PayerStatus","data":{"type":"object","description":"Payer Status.","properties":{"name":{"$ref":"#/components/schemas/PayerStatusName"},"technicalKey":{"$ref":"#/components/schemas/PayerStatusTechnicalKey"}}}},"components/schemas/ProcessingStatus":{"id":"components/schemas/ProcessingStatus","kind":"json-schema","title":"ProcessingStatus","data":{"type":"object","description":"Processing status.","properties":{"technicalKey":{"$ref":"#/components/schemas/ProcessingStatusTechnicalKey"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"}}}},"components/schemas/BusinessPartnersSort":{"id":"components/schemas/BusinessPartnersSort","kind":"json-schema","title":"BusinessPartnersSort","data":{"type":"string","description":"Sort business partners by id (default, ascending only) or lastModifiedAt (ascending or descending).","example":"-lastModifiedAt"}},"components/schemas/UpdateClassificationConfiguration":{"id":"components/schemas/UpdateClassificationConfiguration","kind":"json-schema","title":"UpdateClassificationConfiguration","data":{"type":"object","description":"Model that allows customization of update classification rules.","properties":{"updateClassificationRules":{"type":"array","description":"List of update classification rules, each linked to customer-provided classification keys.","items":{"$ref":"#/components/schemas/UpdateClassificationRule"}}}}},"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/UpdateClassificationRule":{"id":"components/schemas/UpdateClassificationRule","kind":"json-schema","title":"UpdateClassificationRule","data":{"type":"object","description":"Rule for update classification.","properties":{"technicalKey":{"$ref":"#/components/schemas/UpdateClassificationRuleTechnicalKey"},"classification":{"$ref":"#/components/schemas/UpdateClassification"}}}},"components/schemas/UpdateClassificationRuleSearchResult":{"id":"components/schemas/UpdateClassificationRuleSearchResult","kind":"json-schema","title":"UpdateClassificationRuleSearchResult","data":{"type":"object","description":"Rule for update classification.","properties":{"technicalKey":{"$ref":"#/components/schemas/UpdateClassificationRuleTechnicalKey"},"classification":{"$ref":"#/components/schemas/UpdateClassificationSearchResult"}}}},"components/schemas/UpdateClassificationRuleTechnicalKey":{"id":"components/schemas/UpdateClassificationRuleTechnicalKey","kind":"json-schema","title":"UpdateClassificationRuleTechnicalKey","data":{"type":"string","description":"Unique identifier for the update classification rule.","example":"UPDATE_RULE_000035"}},"components/schemas/UpdateClassification":{"id":"components/schemas/UpdateClassification","kind":"json-schema","title":"UpdateClassification","data":{"type":"object","description":"Container for classification details.","properties":{"technicalKey":{"$ref":"#/components/schemas/UpdateClassificationTechnicalKey"}}}},"components/schemas/UpdateClassificationSearchResult":{"id":"components/schemas/UpdateClassificationSearchResult","kind":"json-schema","title":"UpdateClassificationSearchResult","data":{"type":"object","description":"Default update classification with reason.","properties":{"reason":{"$ref":"#/components/schemas/UpdateClassificationReason"},"technicalKey":{"$ref":"#/components/schemas/UpdateClassificationTechnicalKey"}}}},"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/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/TransactionFeaturesOn":{"id":"components/schemas/TransactionFeaturesOn","kind":"json-schema","title":"TransactionFeaturesOn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features to be enabled. Do not use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATE_TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMMIT_TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the same time."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/TransactionFeatureParam"}}},"components/schemas/TransactionFeatureParam":{"id":"components/schemas/TransactionFeatureParam","kind":"json-schema","title":"TransactionFeatureParam","data":{"type":"string","description":"Feature used to control transaction process.","example":"CREATE_TRANSACTION","enum":["CREATE_TRANSACTION","COMMIT_TRANSACTION"],"x-enumDescriptions":{"CREATE_TRANSACTION":"Creates a new transaction and makes the current request a part of it. By default turned off.","COMMIT_TRANSACTION":"Commit transaction. By default turned off."}}},"components/schemas/WorkspaceConfigurationSearchResult":{"id":"components/schemas/WorkspaceConfigurationSearchResult","kind":"json-schema","title":"WorkspaceConfigurationSearchResult","data":{"type":"object","description":"Allows to search for and find specific configurations.","properties":{"id":{"$ref":"#/components/schemas/ConfigurationId"},"name":{"$ref":"#/components/schemas/ConfigurationName"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedBy"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"}}}},"components/schemas/BusinessPartnerDisclosed":{"id":"components/schemas/BusinessPartnerDisclosed","kind":"json-schema","title":"BusinessPartnerDisclosed","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A flag to indicate whether the Business Partner should participate in the sharing or not."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this Business Partner might be used to create a new entry or update an existing entry in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"community pool. Otherwise, it will not be considered for the sharing process. For more details, you can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/business-partner-storages/paths/~1v4~1storages~1%7Bstorageid%7D~1sharingscopes/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sharing Scopes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MARKED_FOR_DELETION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Business Partners profile tag overrides disclosure. Business Partners with this tag are not shared, regardless of the disclosed value."},"children":[]}]}]}]}],"example":"false"}},"components/schemas/BusinessPartnerDataSource":{"id":"components/schemas/BusinessPartnerDataSource","kind":"json-schema","title":"BusinessPartnerDataSource","data":{"type":"string","description":"Name or ID of a data source. Reflects the associated external system where the record originates from.","example":"\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\""}},"components/schemas/BusinessPartnerRecord":{"id":"components/schemas/BusinessPartnerRecord","kind":"json-schema","title":"BusinessPartnerRecord","data":{"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/BusinessPartnerResults":{"id":"components/schemas/BusinessPartnerResults","kind":"json-schema","title":"BusinessPartnerResults","data":{"type":"object","deprecated":true,"description":"Business Partner Result.","properties":{"businessPartnerCurationResult":{"$ref":"#/components/schemas/BusinessPartnerCurationResult"},"categorizationResult":{"$ref":"#/components/schemas/CategorizationResult"},"validationResult":{"$ref":"#/components/schemas/ValidationResult"}}}},"components/schemas/BusinessPartnerCurationResult":{"id":"components/schemas/BusinessPartnerCurationResult","kind":"json-schema","title":"BusinessPartnerCurationResult","data":{"type":"object","description":"Result of Business Partner Curation.","deprecated":true,"properties":{"curatedBusinessPartner":{"$ref":"#/components/schemas/BusinessPartner"}}}},"components/schemas/CategorizationResult":{"id":"components/schemas/CategorizationResult","kind":"json-schema","title":"CategorizationResult","data":{"type":"object","description":"Result of Categorization.","deprecated":true,"properties":{"categories":{"type":"array","description":"List of categories.","items":{"$ref":"#/components/schemas/Category"}}}}},"components/schemas/Category":{"id":"components/schemas/Category","kind":"json-schema","title":"Category","data":{"type":"object","description":"Category of a Business Partner.","deprecated":true,"properties":{"categorized":{"type":"boolean","description":"Toggle to indicate whether the Business Partner is categorized or not.","example":"true"},"key":{"type":"string","description":"Key of the category.","example":"CDQ.BP.INDUSTRY"},"label":{"type":"string","description":"Label of the category.","example":"Industry"},"score":{"type":"number","format":"float","description":"Score of the category.","example":"0.8"}}}},"components/schemas/AddressResults":{"id":"components/schemas/AddressResults","kind":"json-schema","title":"AddressResults","data":{"type":"object","deprecated":true,"description":"Address Results. No longer supported for new integrations. Use reading results endpoint of respective API.","properties":{"curationResult":{"$ref":"#/components/schemas/AddressCurationResult"},"goldenRecordGenerationResult":{"$ref":"#/components/schemas/GoldenRecordGenerationResult"},"lookupResults":{"$ref":"#/components/schemas/LookupResults"},"validationResult":{"$ref":"#/components/schemas/ValidationResult"}}}},"components/schemas/AddressCurationResult":{"id":"components/schemas/AddressCurationResult","kind":"json-schema","title":"AddressCurationResult","data":{"type":"object","description":"Result of Address Curation.","deprecated":true,"properties":{"accuracyIndicator":{"type":"integer","format":"int32","description":"Measure used to assess the degree of accuracy in a given context.","example":"5"},"changes":{"type":"array","description":"List of changes.","items":{"type":"string","description":"Change.","example":"Deprecated"}},"curatedAddress":{"$ref":"#/components/schemas/Address"},"curationLevel":{"$ref":"#/components/schemas/schemas-CurationLevel"},"requestSimilarity":{"$ref":"#/components/schemas/RequestSimilarity"},"response":{"$ref":"#/components/schemas/AddressCurationResponse"}}}},"components/schemas/RequestSimilarity":{"id":"components/schemas/RequestSimilarity","kind":"json-schema","title":"RequestSimilarity","data":{"type":"object","description":"Request Similarity.","deprecated":true,"properties":{"geoCoordinates":{"type":"boolean","description":"Geo Coordinates.","example":"true"},"locality":{"type":"number","format":"double","description":"Locality.","example":"1.0"},"overall":{"type":"number","format":"double","description":"Overall.","example":"1.0"},"postCode":{"type":"number","format":"double","description":"Post Code.","example":"1.0"},"thoroughfare":{"type":"number","format":"double","description":"Thoroughfare.","example":"1.0"}}}},"components/schemas/AddressCurationResponse":{"id":"components/schemas/AddressCurationResponse","kind":"json-schema","title":"AddressCurationResponse","data":{"type":"object","description":"Address Curation Response.","deprecated":true,"properties":{"message":{"type":"string","description":"Additional explanations for status - especially for the FAILED case.","example":"Deprecated"},"status":{"type":"string","description":"Can be OK or FAILED - default is OK (use enum in request objects).","example":"OK"},"timestamp":{"$ref":"#/components/schemas/StatusTimestamp"}}}},"components/schemas/GoldenRecordGenerationResult":{"id":"components/schemas/GoldenRecordGenerationResult","kind":"json-schema","title":"GoldenRecordGenerationResult","data":{"type":"object","description":"Result of Golden Record Generation.","deprecated":true,"properties":{"explanations":{"type":"array","description":"List of explanations.","items":{"type":"string","description":"Explanation.","example":"No errors have been found"}},"goldenRecord":{"$ref":"#/components/schemas/BusinessPartner"},"originalBusinessPartner":{"$ref":"#/components/schemas/BusinessPartner"},"originalDataDefects":{"type":"array","description":"List of original data defects.","items":{"$ref":"#/components/schemas/DataDefect"}},"referenceBusinesspartners":{"type":"array","description":"List of reference business partners.","items":{"$ref":"#/components/schemas/MatchingContainer"}},"remainingDataDefects":{"type":"array","description":"List of remaining data defects.","items":{"$ref":"#/components/schemas/DataDefect"}}}}},"components/schemas/MatchingContainer":{"id":"components/schemas/MatchingContainer","kind":"json-schema","title":"MatchingContainer","data":{"type":"object","description":"Matching Container.","deprecated":true,"properties":{"businessPartner":{"$ref":"#/components/schemas/BusinessPartner"},"matchScore":{"type":"number","format":"double","description":"Match score.","example":"0.8"},"matchingExplanation":{"type":"string","description":"Explanation for matching score value.","example":"{'BP: [overall: [PL_NIP: 0.89; overall: 0.89;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]'}"},"matchingSource":{"type":"string","description":"Matching source.","example":"DataSource"},"subscribed":{"type":"boolean","description":"Subscribed.","example":"true"}}}},"components/schemas/LookupResults":{"id":"components/schemas/LookupResults","kind":"json-schema","title":"LookupResults","data":{"type":"object","description":"Lookup Results.","deprecated":true,"properties":{"lookupMatches":{"type":"array","description":"List of lookup matches.","items":{"$ref":"#/components/schemas/LookupMatch"}}}}},"components/schemas/LookupMatch":{"id":"components/schemas/LookupMatch","kind":"json-schema","title":"LookupMatch","data":{"type":"object","description":"Lookup Match.","deprecated":true,"properties":{"address":{"$ref":"#/components/schemas/Address"},"alei":{"type":"string","description":"ALEI prefix of reference data source e.g. CH.UIDR","example":"CH.UIDR"},"businessPartner":{"$ref":"#/components/schemas/BusinessPartner"},"cdqId":{"type":"string","description":"Unique identifier for the Business Partner.","example":"VIES:PL8660001429"},"inactive":{"type":"boolean","description":"Inactive.","example":"true"},"matchingExplanation":{"type":"string","description":"Explanation for matching score value.","example":"{'BP: [overall: [PL_NIP: 0.89; overall: 0.89;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]'}"},"matchingScore":{"type":"string","description":"Shows numerical value of similarity between Business Partners or address stored in the Data Mirror and the Business Partner from the request.","example":"0.9"},"businessPartnerMatchingScore":{"type":"number","format":"double","description":"Business partner matching score.","example":"0.8"},"addressMatchingScore":{"type":"number","format":"double","description":"Address matching score.","example":"0.8"},"responseMetadata":{"$ref":"#/components/schemas/ReferenceResponseMetadata"},"source":{"type":"string","description":"Reference data source.","example":"VIES"}}}},"components/schemas/ReferenceResponseMetadata":{"id":"components/schemas/ReferenceResponseMetadata","kind":"json-schema","title":"ReferenceResponseMetadata","data":{"type":"object","description":"Reference Response Metadata.","deprecated":true,"properties":{"responseCurated":{"type":"boolean","description":"Response parameter informing whether the response was curated.","example":"true"}}}},"components/schemas/ValidationResult":{"id":"components/schemas/ValidationResult","kind":"json-schema","title":"ValidationResult","data":{"type":"object","description":"Result of Validation.","deprecated":true,"properties":{"dataDefects":{"type":"array","description":"List of Data Defects.","items":{"$ref":"#/components/schemas/DataDefect"}},"fixProposals":{"type":"array","description":"List of Fix Proposals.","items":{"$ref":"#/components/schemas/FixProposal"}}}}},"components/schemas/FixProposal":{"id":"components/schemas/FixProposal","kind":"json-schema","title":"FixProposal","data":{"type":"object","description":"Fix Proposal.","deprecated":true,"properties":{"addresses":{"type":"array","description":"List of Addresses.","items":{"$ref":"#/components/schemas/Address"}},"identifiers":{"type":"array","description":"List of Identifiers.","items":{"$ref":"#/components/schemas/Identifier"}},"names":{"type":"array","description":"List of Names.","items":{"$ref":"#/components/schemas/Name"}}}}},"components/schemas/DataDefect":{"id":"components/schemas/DataDefect","kind":"json-schema","title":"DataDefect","data":{"type":"object","description":"Data Defect.","deprecated":true,"properties":{"attributes":{"type":"array","description":"List of Attributes.","items":{"type":"string","description":"Attribute name.","example":"Deprecated"}},"businessRule":{"type":"string","description":"Business rule.","example":"Deprecated"},"entity":{"type":"string","description":"Entity name.","example":"Deprecated"},"errorCode":{"type":"integer","format":"int32","description":"Error code.","example":"0"},"fixProposal":{"type":"string","description":"Fix proposal.","example":"Deprecated"},"fixProposalJson":{"type":"string","description":"Stringified JSON of a fix proposal.","example":"Deprecated"},"violationLevel":{"type":"string","description":"Violation level.","example":"NO_DEFECT","enum":["NO_DEFECT","INFO","WARNING","ERROR"],"x-enumDescriptions":{"NO_DEFECT":"No defect.","INFO":"Informational message.","WARNING":"Warning message.","ERROR":"Error message."}},"violationMessage":{"type":"string","description":"Detailed description of what has been violated in the applied data quality rule.","example":"Business partner misses an optional D-U-N-S number."}}}},"components/schemas/BusinessPartnerStorageMetadataUpdate":{"id":"components/schemas/BusinessPartnerStorageMetadataUpdate","kind":"json-schema","title":"BusinessPartnerStorageMetadataUpdate","data":{"type":"object","description":"Update of the Business Partner Storage metadata.","properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerStorageName"},"labels":{"type":"array","description":"List of Storages labels.","maxItems":10,"uniqueItems":true,"items":{"$ref":"#/components/schemas/StorageLabels"}},"dataMatchingDefinitionId":{"$ref":"#/components/schemas/DataMatchingDefinitionId"},"sharedWithOrganization":{"$ref":"#/components/schemas/SharedWithOrganization"}}}},"components/schemas/BusinessPartnerStorageMetadata":{"id":"components/schemas/BusinessPartnerStorageMetadata","kind":"json-schema","title":"BusinessPartnerStorageMetadata","data":{"type":"object","description":"Metadata for Business Partner Storage.","properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"name":{"$ref":"#/components/schemas/BusinessPartnerStorageName"},"eventStoreId":{"$ref":"#/components/schemas/EventStoreId"},"decisionLogId":{"$ref":"#/components/schemas/DecisionLogId"},"domain":{"$ref":"#/components/schemas/Domain"},"organization":{"$ref":"#/components/schemas/OrganizationId"},"user":{"$ref":"#/components/schemas/UserId"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"expiresAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when storage expires."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":"a date when a storage expires,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEVER when storage is a Data Mirror or has been created including NEVER_EXPIRE feature."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiry date is calculated based on the date of last write operation related"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to a storage (upsert of data, update of data sources, executed job) plus 6 months,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refreshed as most 2 weeks before previous storage expiration date."},"children":[]}]}]}],"example":"2026-10-21T13:37:18Z"},"dataMatchingDefinitionId":{"$ref":"#/components/schemas/DataMatchingDefinitionId"},"dataSources":{"type":"array","description":"List of Data Sources.","items":{"$ref":"#/components/schemas/DataSource"}},"dataMonitors":{"type":"array","description":"List of data monitors.","items":{"$ref":"#/components/schemas/DataMonitor"}},"numberOfCountries":{"$ref":"#/components/schemas/NumberOfCountries"},"numberOfRecords":{"$ref":"#/components/schemas/NumberOfRecords"},"countryStatistics":{"type":"array","items":{"$ref":"#/components/schemas/CountryStatistic"}},"originalFileHeader":{"type":"array","description":"List of headers used for a modification of metadata.","items":{"type":"string","description":"Header of the last file that was used to import data into this storage.","example":"BusinessPartnerId, Name, Address"}},"originalFileName":{"$ref":"#/components/schemas/OriginalFileName"},"results":{"$ref":"#/components/schemas/Results"},"status":{"$ref":"#/components/schemas/StorageMetadataStatus"},"statusMessage":{"$ref":"#/components/schemas/StorageMetadataStatusMessage"},"sharedWithOrganization":{"$ref":"#/components/schemas/SharedWithOrganization"},"labels":{"type":"array","description":"Labels to categorize the storage.","maxItems":10,"uniqueItems":true,"items":{"$ref":"#/components/schemas/StorageLabels"}}}}},"components/schemas/NumberOfCountries":{"id":"components/schemas/NumberOfCountries","kind":"json-schema","title":"NumberOfCountries","data":{"type":"integer","format":"int64","description":"Number of countries in the Business Partner Storage.","example":"12"}},"components/schemas/NumberOfRecords":{"id":"components/schemas/NumberOfRecords","kind":"json-schema","title":"NumberOfRecords","data":{"type":"integer","format":"int64","description":"Number of records in the Business Partner Storage.","example":"500"}},"components/schemas/OriginalFileName":{"id":"components/schemas/OriginalFileName","kind":"json-schema","title":"OriginalFileName","data":{"type":"string","description":"Name of the last file that was used to import data into this Business Partner Storage.","example":"business-partner.csv"}},"components/schemas/StorageMetadataStatus":{"id":"components/schemas/StorageMetadataStatus","kind":"json-schema","title":"StorageMetadataStatus","data":{"type":"string","description":"Status of a Business Partner Storage.","example":"FILE_IMPORTED_SUCCESSFULLY"}},"components/schemas/StorageMetadataStatusMessage":{"id":"components/schemas/StorageMetadataStatusMessage","kind":"json-schema","title":"StorageMetadataStatusMessage","data":{"type":"string","description":"Details related to status.","example":"BusinessPartner batch could not be upserted into Business Partner Storage."}},"components/schemas/SharedWithOrganization":{"id":"components/schemas/SharedWithOrganization","kind":"json-schema","title":"SharedWithOrganization","data":{"type":"boolean","description":"Indicates if this Business Partner Storage is shared with all users of the same organization","example":"true"}},"components/schemas/EventStoreId":{"id":"components/schemas/EventStoreId","kind":"json-schema","title":"EventStoreId","data":{"type":"string","description":"Internal ID of Event Store.","example":"72d6900fce6b326123f5d9d91049e3e6"}},"components/schemas/Domain":{"id":"components/schemas/Domain","kind":"json-schema","title":"Domain","data":{"type":"string","deprecated":true,"description":"Domain of a Business Partner Storage.","example":"BusinessPartner"}},"components/schemas/DataMatchingDefinitionId":{"id":"components/schemas/DataMatchingDefinitionId","kind":"json-schema","title":"DataMatchingDefinitionId","data":{"type":"string","description":"ID of related data matching definition that is used for matching lookup candidates for internal lookup of this Business Partner Storage.","example":"6400955811c68a034bcef311"}},"components/schemas/DataMapperDefinitionId":{"id":"components/schemas/DataMapperDefinitionId","kind":"json-schema","title":"DataMapperDefinitionId","data":{"type":"string","description":"ID of related Data Mapper Definition that is used for mapping data of this Business Partner Storage.","example":"6440dba32b30176c5917b1b7"}},"components/schemas/DataTransformationDefinitionId":{"id":"components/schemas/DataTransformationDefinitionId","kind":"json-schema","title":"DataTransformationDefinitionId","data":{"type":"string","description":"ID of related Data Transformation Definition that is used for mapping data of this Business Partner Storage.","example":"6440dba32b30176c5917b1b7"}},"components/schemas/Prefix":{"id":"components/schemas/Prefix","kind":"json-schema","title":"Prefix","data":{"type":"string","description":"Additional prefix for data source name.","example":"Custom prefix"}},"components/schemas/StorageLabels":{"id":"components/schemas/StorageLabels","kind":"json-schema","title":"StorageLabels","data":{"type":"string","description":"Label of a Business Partner Storage.","example":"Custom Storage Name","maxLength":50}},"components/schemas/MappingDisclosure":{"id":"components/schemas/MappingDisclosure","kind":"json-schema","title":"MappingDisclosure","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether disclosed field is set via Data Mapper Definition (true) or via Sharing Scopes (false). For more details, you can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/data-mapping/paths/~1datamapperdefinitions/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Mapper Definition"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/apis/data-exchange-api/api-v5/business-partner-storages/paths/~1v4~1storages~1%7Bstorageid%7D~1sharingscopes/post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sharing Scopes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".\""},"children":[]}]}]}],"type":"boolean","example":"true"}},"components/schemas/NumberOfPages":{"id":"components/schemas/NumberOfPages","kind":"json-schema","title":"NumberOfPages","data":{"type":"integer","format":"int32","description":"Number of pages.","example":"10"}},"components/schemas/FeatureStatus":{"id":"components/schemas/FeatureStatus","kind":"json-schema","title":"FeatureStatus","data":{"type":"object","description":"Status of a feature.","properties":{"status":{"$ref":"#/components/schemas/FeatureStatusStatus"}}}},"components/schemas/DataSource":{"id":"components/schemas/DataSource","kind":"json-schema","title":"DataSource","data":{"type":"object","description":"A sub-container of Data Storage/Data Mirror. Few data sources can have different data, mappings, and data monitors within the same data mirror.","nullable":false,"properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"lastUpdatedAt":{"$ref":"#/components/schemas/ModifiedAt"},"name":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceName"},"dataMapperDefinitionId":{"$ref":"#/components/schemas/DataMapperDefinitionId"},"mappingDisclosure":{"$ref":"#/components/schemas/MappingDisclosure"}}}},"components/schemas/DataSourceParam":{"id":"components/schemas/DataSourceParam","kind":"json-schema","title":"DataSourceParam","data":{"type":"object","description":"A sub-container of Data Storage/Data Mirror. Few data sources can have different data, mappings, and data monitors within the same data mirror.","nullable":false,"properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"lastUpdatedAt":{"$ref":"#/components/schemas/ModifiedAt"},"name":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceName"},"dataMapperDefinitionId":{"$ref":"#/components/schemas/DataMapperDefinitionId"}}}},"components/schemas/DataSourceCreate":{"id":"components/schemas/DataSourceCreate","kind":"json-schema","title":"DataSourceCreate","data":{"type":"object","description":"Create the Data Source.","nullable":false,"properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceName"},"dataMapperDefinitionId":{"$ref":"#/components/schemas/DataMapperDefinitionId"}}}},"components/schemas/DataSourceCreateFeatureParam":{"id":"components/schemas/DataSourceCreateFeatureParam","kind":"json-schema","title":"DataSourceCreateFeatureParam","data":{"type":"string","description":"Modifies behavior of the data source creation process.","example":"FORCE_CDQ_POOL_DATA_SOURCE_CREATE","enum":["FORCE_CDQ_POOL_DATA_SOURCE_CREATE"],"x-enumDescriptions":{"FORCE_CDQ_POOL_DATA_SOURCE_CREATE":"Enables creation of CDQ.POOL data source, only for restricted users."}}},"components/schemas/DataSourceUpdate":{"id":"components/schemas/DataSourceUpdate","kind":"json-schema","title":"DataSourceUpdate","data":{"type":"object","description":"Update Data Source's records with new updates from the reference Data Source.","nullable":false,"properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceName"},"dataMapperDefinitionId":{"$ref":"#/components/schemas/DataMapperDefinitionId"}}}},"components/schemas/DataSourceUpdateFeatureParam":{"id":"components/schemas/DataSourceUpdateFeatureParam","kind":"json-schema","title":"DataSourceUpdateFeatureParam","data":{"type":"string","description":"Modifies behavior of the data source update process.","example":"FORCE_CDQ_POOL_DATA_SOURCE_UPDATE","enum":["FORCE_CDQ_POOL_DATA_SOURCE_UPDATE"],"x-enumDescriptions":{"FORCE_CDQ_POOL_DATA_SOURCE_UPDATE":"Enables update of CDQ.POOL data source, only for restricted users."}}},"components/schemas/DataSourceUpdateResult":{"id":"components/schemas/DataSourceUpdateResult","kind":"json-schema","title":"DataSourceUpdateResult","data":{"type":"object","description":"Result report of the Data Source update.","properties":{"dataSource":{"$ref":"#/components/schemas/DataSourceParam"},"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 - The Data Source 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 - The Data Source is not found."},"children":[]}]}]}]}],"example":"OK"}}}},"components/schemas/DataSourceUpserts":{"id":"components/schemas/DataSourceUpserts","kind":"json-schema","title":"DataSourceUpserts","data":{"type":"object","description":"Upsert Data Source's records with updates if the record exists in the Data Source. Otherwise, the record is inserted.","required":["dataSources"],"properties":{"dataSources":{"type":"array","description":"List of Data Sources.","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/DataSourceParam"}}}}},"components/schemas/DataSourceUpsertsResult":{"id":"components/schemas/DataSourceUpsertsResult","kind":"json-schema","title":"DataSourceUpsertsResult","data":{"type":"object","description":"List of Data Source upsert results.","properties":{"created":{"$ref":"#/components/schemas/UpsertResultCreated"},"updated":{"$ref":"#/components/schemas/UpsertResultUpdated"},"failed":{"$ref":"#/components/schemas/UpsertResultFailed"}}}},"components/schemas/DataSourceDeleteFeatureParam":{"id":"components/schemas/DataSourceDeleteFeatureParam","kind":"json-schema","title":"DataSourceDeleteFeatureParam","data":{"type":"string","description":"Modifies behavior of the data source deletion process.","example":"FORCE_CDQ_POOL_DATA_SOURCE_DELETE","enum":["FORCE_CDQ_POOL_DATA_SOURCE_DELETE"],"x-enumDescriptions":{"FORCE_CDQ_POOL_DATA_SOURCE_DELETE":"Enables deletion of CDQ.POOL data source, only for restricted users."}}},"components/schemas/UpsertResultCreated":{"id":"components/schemas/UpsertResultCreated","kind":"json-schema","title":"UpsertResultCreated","data":{"type":"integer","format":"int64","description":"Number of created Data Sources for monitoring.","example":"4"}},"components/schemas/UpsertResultUpdated":{"id":"components/schemas/UpsertResultUpdated","kind":"json-schema","title":"UpsertResultUpdated","data":{"type":"integer","format":"int64","description":"Number of updated Data Sources for monitoring.","example":"0"}},"components/schemas/UpsertResultFailed":{"id":"components/schemas/UpsertResultFailed","kind":"json-schema","title":"UpsertResultFailed","data":{"type":"integer","format":"int64","description":"Number of failed updates.","example":"4"}},"components/schemas/CountryStatistic":{"id":"components/schemas/CountryStatistic","kind":"json-schema","title":"CountryStatistic","data":{"type":"object","description":"Stores information about the number of records associated with the country.","properties":{"countryCode":{"$ref":"#/components/schemas/CountryShortName"},"numberOfRecords":{"$ref":"#/components/schemas/NumberOfRecords"}}}},"components/schemas/Report":{"id":"components/schemas/Report","kind":"json-schema","title":"Report","data":{"type":"object","description":"Report of a Business Partner Storage.","properties":{"creationTimestamp":{"$ref":"#/components/schemas/CreatedAt"},"description":{"type":"string","description":"Description of the Report.","example":"Report description"},"name":{"type":"string","description":"Display Name of the Report.","example":"Report name"},"type":{"type":"string","description":"Type of the Report.","example":"Report type"},"url":{"type":"string","description":"URL of the Report.","example":"https://www.cdq.com"}}}},"components/schemas/ResultItem":{"id":"components/schemas/ResultItem","kind":"json-schema","title":"ResultItem","data":{"type":"object","description":"Result Item.","properties":{"country":{"$ref":"#/components/schemas/CountryShortName"},"label":{"type":"string","description":"Label of the Result Item.","example":"Result Item label"},"numberOfRecords":{"$ref":"#/components/schemas/NumberOfRecords"},"type":{"type":"string","description":"Type of the Result Item.","example":"Result Item type"}}}},"components/schemas/CountStoragesFeatureParam":{"id":"components/schemas/CountStoragesFeatureParam","kind":"json-schema","title":"CountStoragesFeatureParam","data":{"type":"string","description":"Modifies behavior of a counting Business Partner Storages.","example":"INCLUDE_USER","enum":["INCLUDE_ORGANIZATION","INCLUDE_USER","INCLUDE_WORKSPACES"],"x-enumDescriptions":{"INCLUDE_ORGANIZATION":"Includes current organization Business Partner Storages count. By default, deactivated.","INCLUDE_USER":"Includes current user Business Partner Storages. By default, turned on.","INCLUDE_WORKSPACES":"Includes workspaces Business Partner Storages count current or provided by parameters. By default, deactivated."}}},"components/schemas/BusinessPartnerStorageCount":{"id":"components/schemas/BusinessPartnerStorageCount","kind":"json-schema","title":"BusinessPartnerStorageCount","data":{"type":"object","description":"Number of Business Partner Storages.","properties":{"organization":{"$ref":"#/components/schemas/BusinessPartnerStorageCountOrganization"},"workspace":{"$ref":"#/components/schemas/BusinessPartnerStorageCountWorkspace"},"user":{"$ref":"#/components/schemas/BusinessPartnerStorageCountUser"},"value":{"$ref":"#/components/schemas/BusinessPartnerStorageCountValue"}}}},"components/schemas/BusinessPartnerStorageCountOrganization":{"id":"components/schemas/BusinessPartnerStorageCountOrganization","kind":"json-schema","title":"BusinessPartnerStorageCountOrganization","data":{"type":"object","description":"Number of Business Partner Storages in the organization.","properties":{"id":{"$ref":"#/components/schemas/OrganizationId"}}}},"components/schemas/BusinessPartnerStorageCountWorkspace":{"id":"components/schemas/BusinessPartnerStorageCountWorkspace","kind":"json-schema","title":"BusinessPartnerStorageCountWorkspace","data":{"type":"object","description":"Number of Business Partner Storages in the workspace.","properties":{"id":{"$ref":"#/components/schemas/WorkspaceId"}}}},"components/schemas/BusinessPartnerStorageCountUser":{"id":"components/schemas/BusinessPartnerStorageCountUser","kind":"json-schema","title":"BusinessPartnerStorageCountUser","data":{"type":"object","description":"Number of Business Partner Storages for the user.","properties":{"id":{"$ref":"#/components/schemas/UserId"}}}},"components/schemas/BusinessPartnerStorageCountValue":{"id":"components/schemas/BusinessPartnerStorageCountValue","kind":"json-schema","title":"BusinessPartnerStorageCountValue","data":{"type":"integer","format":"int32","description":"Number of Business Partner Storages.","example":"10"}},"components/schemas/UpsertFailureLog":{"id":"components/schemas/UpsertFailureLog","kind":"json-schema","title":"UpsertFailureLog","data":{"type":"object","description":"Log of a failed upsert.","properties":{"id":{"type":"string","description":"ID of a failed upsert.","example":"567326478287468742"},"externalId":{"type":"string","description":"ID of the failed upsert in the external system where the record originates from.","example":"LFA1.1234567"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"message":{"type":"string","description":"Message displayed in the failure log.","example":"This record could not be stored due to timeout."}}}},"components/schemas/BusinessPartnersClearResult":{"id":"components/schemas/BusinessPartnersClearResult","kind":"json-schema","title":"BusinessPartnersClearResult","data":{"type":"object","description":"Result of deleting all Business Partners for the Business Partner Storage.","properties":{"numberOfDeletes":{"$ref":"#/components/schemas/NumberOfDeletes"}}}},"components/schemas/BusinessPartnersDeleteRequest":{"id":"components/schemas/BusinessPartnersDeleteRequest","kind":"json-schema","title":"BusinessPartnersDeleteRequest","data":{"type":"object","description":"Request for deleting selected business partners for the Data Source.","properties":{"dataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"businessPartners":{"type":"array","description":"List of Business Partners to be deleted.","maxItems":1000,"items":{"type":"object","description":"Business Partner to be deleted.","properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerId"},"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"dataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}}}},"featuresOn":{"type":"array","description":"List of features to be used during delete.","items":{"$ref":"#/components/schemas/DeleteFeatureParam"}}}}},"components/schemas/ProfileTypeParam":{"id":"components/schemas/ProfileTypeParam","kind":"json-schema","title":"ProfileTypeParam","data":{"type":"string","description":"Profile type to be set during to delete.","example":"STANDARD","enum":["STANDARD","FEATURES_OFF"],"x-enumDescriptions":{"STANDARD":"Standard profile to be used during delete.","FEATURES_OFF":"All features are deactivated."}}},"components/schemas/DeleteFeatureParam":{"id":"components/schemas/DeleteFeatureParam","kind":"json-schema","title":"DeleteFeatureParam","data":{"type":"string","description":"Feature to be used during delete.","example":"DELETE_BY_EXTERNAL_ID","enum":["DELETE_BY_EXTERNAL_ID","DELETE_BUSINESS_PARTNER_DATA","DELETE_LINKS"],"x-enumDescriptions":{"DELETE_BY_EXTERNAL_ID":"Deletion is done by external ID.","DELETE_BUSINESS_PARTNER_DATA":"Deletion of Business Partner data.","DELETE_LINKS":"Deletion of links."}}},"components/schemas/BusinessPartnersDeleteResult":{"id":"components/schemas/BusinessPartnersDeleteResult","kind":"json-schema","title":"BusinessPartnersDeleteResult","data":{"type":"object","description":"Result of deleting selected Business Partners for the Data Source.","properties":{"numberOfDeletes":{"$ref":"#/components/schemas/NumberOfDeletes"},"numberOfFailures":{"$ref":"#/components/schemas/NumberOfFailures"},"failures":{"type":"array","description":"List of failures.","items":{"$ref":"#/components/schemas/DeleteFailureLog"}},"numberOfSkipped":{"$ref":"#/components/schemas/NumberOfSkipped"},"skipped":{"type":"array","description":"List of requested items that were well-formed but didn't match any existing Business Partner.","items":{"$ref":"#/components/schemas/DeleteSkipLog"}}}}},"components/schemas/BusinessPartnersCopyJobCreate":{"id":"components/schemas/BusinessPartnersCopyJobCreate","kind":"json-schema","title":"BusinessPartnersCopyJobCreate","data":{"type":"object","description":"Business Partner Copy Job create.","properties":{"targetStorageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"dataSourceName":{"type":"string","description":"New data source name","example":"generated:token"}}}},"components/schemas/BusinessPartnersCopyJob":{"id":"components/schemas/BusinessPartnersCopyJob","kind":"json-schema","title":"BusinessPartnersCopyJob","data":{"type":"object","description":"Business Partner Copy Job is used to initialize copy of a Business Partner Data Source.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"targetStorageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"targetDataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"status":{"$ref":"#/components/schemas/JobStatusResult"},"statusMessage":{"$ref":"#/components/schemas/JobStatusMessage"}}}},"components/schemas/NumberOfDeletes":{"id":"components/schemas/NumberOfDeletes","kind":"json-schema","title":"NumberOfDeletes","data":{"type":"integer","description":"Number of deleted Business Partners.","example":"50"}},"components/schemas/NumberOfFailures":{"id":"components/schemas/NumberOfFailures","kind":"json-schema","title":"NumberOfFailures","data":{"type":"integer","description":"Number of failures during deletion.","example":"0"}},"components/schemas/NumberOfSkipped":{"id":"components/schemas/NumberOfSkipped","kind":"json-schema","title":"NumberOfSkipped","data":{"type":"integer","description":"Number of requested items skipped during deletion because they didn't match any existing Business Partner.","example":"0"}},"components/schemas/DeleteFailureLog":{"id":"components/schemas/DeleteFailureLog","kind":"json-schema","title":"DeleteFailureLog","data":{"type":"object","description":"Log of a failed delete operation containing Business Partner ID, Data Source ID, external ID and error message.","properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerId"},"dataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"message":{"type":"string","description":"Error message.","example":"This record could not be stored due to timeout."}}}},"components/schemas/DeleteSkipLog":{"id":"components/schemas/DeleteSkipLog","kind":"json-schema","title":"DeleteSkipLog","data":{"type":"object","description":"Log of a skipped delete operation, including the Business Partner ID, Data Source ID, external ID, and status, as submitted in the request.","properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerId"},"dataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"externalId":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"status":{"$ref":"#/components/schemas/DeleteSkipLogStatus"}}}},"components/schemas/DeleteSkipLogStatus":{"id":"components/schemas/DeleteSkipLogStatus","kind":"json-schema","title":"DeleteSkipLogStatus","data":{"type":"object","description":"Status explaining why the requested item was skipped.","properties":{"technicalKey":{"$ref":"#/components/schemas/StatusDetailTechnicalKey"},"message":{"$ref":"#/components/schemas/StatusDetailMessage"}}}},"components/schemas/BusinessPartnerResultPatch":{"id":"components/schemas/BusinessPartnerResultPatch","kind":"json-schema","title":"BusinessPartnerResultPatch","data":{"type":"object","description":"Patch for Business Partner Result.","properties":{"addressResultPatches":{"type":"array","description":"List of Address Result Patches.","items":{"$ref":"#/components/schemas/AddressResultPatch"}},"businessPartnerResults":{"$ref":"#/components/schemas/BusinessPartnerResults"},"id":{"$ref":"#/components/schemas/BusinessPartnerId"}}}},"components/schemas/AddressResultPatch":{"id":"components/schemas/AddressResultPatch","kind":"json-schema","title":"AddressResultPatch","data":{"type":"object","description":"Patch for Address Result.","properties":{"addressResults":{"$ref":"#/components/schemas/AddressResults"},"id":{"type":"string","minLength":1,"description":"Unique identifier for the address which was used for the linkage in the POOL.","example":"0"}}}},"components/schemas/DataMapperDefinition":{"id":"components/schemas/DataMapperDefinition","kind":"json-schema","title":"DataMapperDefinition","data":{"type":"object","description":"Definition of a Data Mapper.","properties":{"id":{"$ref":"#/components/schemas/DataMapperDefinitionId"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"lastUpdatedAt":{"type":"string","deprecated":true,"description":"Deprecated, please use modifiedAt instead.","example":"2026-10-21T13:37:18Z"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"modifiedBy":{"$ref":"#/components/schemas/ModifiedBy"},"creatorUsername":{"type":"string","description":"Username of the creator of the Data Mapper Definition.","example":"john.doe"},"creatorOrganization":{"type":"string","description":"Organization of the creator of the Data Mapper Definition.","example":"cdq"},"shareWithOrganization":{"type":"boolean","description":"Toggle to enable that the Data Mapper Definition is shared with the whole organization.","example":"true"},"labels":{"type":"array","description":"List of labels.","maxItems":10,"uniqueItems":true,"items":{"$ref":"#/components/schemas/StorageLabels"}},"name":{"type":"string","description":"Name of the Data Mapper Definition.","example":"Custom name of Data Mapper"},"valueMappings":{"type":"array","description":"List of Value Mappings.","items":{"$ref":"#/components/schemas/ValueMapping"}},"inputMapping":{"$ref":"#/components/schemas/BusinessPartnerMappingRule"},"outputMapping":{"$ref":"#/components/schemas/BusinessPartnerMappingRule"}}}},"components/schemas/CustomTransformation":{"id":"components/schemas/CustomTransformation","kind":"json-schema","title":"CustomTransformation","data":{"type":"object","description":"Custom transformation. The input of the transformation is the full raw data the output just the result string.","properties":{"name":{"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 script. This name should be used to define in which mapping this transformation should be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"customTransformations\": [\n    {\n      \"name\": \"lv_locality_transformation\"\n      \"code\": \"def transform(raw_data):\\r\\n                json_result = json.loads(raw_data)\\r\\n                return json_result[\\\"address\\\"].split(\",\")[0]\"\n    },\n    {\n              \"name\": \"lv_thoroughfare_transformation\"\n              \"code\": \"def transform(raw_data):\\r\\n                json_result = json.loads(raw_data)\\r\\n                return json_result[\\\"address\\\"].split(\",\")[1]\"\n     }\n  ]\n...\n  \"inputMapping\": {\n    \"businessPartnerAttributeMappings\": [\n      {\n        \"sourceAttributes\": [\n          \"businessPartner.record\"\n        ], // when all raw data should be provided then use $\n        \"targetAttributes\": [\n          \"businessPartner.externalId\"\n        ],\n        \"transformations\": [\n          {\n            \"type\" : \"CUSTOM\",\n            \"parameters\": [\n              {\n                \"key\" : \"transformationName\",\n                \"value\" : \"lv_locality_transformation\"\n              }\n            ]\n          }\n        ]\n      },\n      {\n        \"sourceAttributes\": [\n            \"businessPartner.record\"\n        ],\n        \"targetAttributes\": [\n          \"address.localities[0].value\"\n        ],\n        \"transformations\": [\n          {\n            \"type\" : \"CUSTOM\",\n            \"parameters\": [\n              {\n                \"key\" : \"transformationName\",\n                \"value\" : \"lv_locality_transformation\"\n              }\n            ]\n          }\n        ]\n      },\n    {\n      \"sourceAttributes\": [\n          \"businessPartner.record\" or \"$\"\n      ],\n      \"targetAttributes\": [\n          \"address.thoroughfare[0].value\",\n          \"address.thoroughfare[1].value\"\n      ],\n      \"transformations\": [\n        {\n          \"type\" : \"CUSTOM\",\n          \"parameters\": [\n            {\n              \"key\" : \"transformationName\",\n              \"value\" : \"lv_thoroughfare_transformation\"\n            }\n          ]\n        }\n      ]\n    }\n    ]\n  }\n\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"customTransformations\": [\n    {\n      \"name\": \"lv_locality_transformation\"\n      \"code\": \"def transform(raw_data):\\r\\n                json_result = json.loads(raw_data)\\r\\n                return json_result[\\\"address\\\"].split(\",\")[0]\"\n    },\n    {\n              \"name\": \"lv_thoroughfare_transformation\"\n              \"code\": \"def transform(raw_data):\\r\\n                json_result = json.loads(raw_data)\\r\\n                return json_result[\\\"address\\\"].split(\",\")[1]\"\n     }\n  ]\n...\n  \"inputMapping\": {\n    \"businessPartnerAttributeMappings\": [\n      {\n        \"sourceAttributes\": [\n          \"businessPartner.record\"\n        ], // when all raw data should be provided then use $\n        \"targetAttributes\": [\n          \"businessPartner.externalId\"\n        ],\n        \"transformations\": [\n          {\n            \"type\" : \"CUSTOM\",\n            \"parameters\": [\n              {\n                \"key\" : \"transformationName\",\n                \"value\" : \"lv_locality_transformation\"\n              }\n            ]\n          }\n        ]\n      },\n      {\n        \"sourceAttributes\": [\n            \"businessPartner.record\"\n        ],\n        \"targetAttributes\": [\n          \"address.localities[0].value\"\n        ],\n        \"transformations\": [\n          {\n            \"type\" : \"CUSTOM\",\n            \"parameters\": [\n              {\n                \"key\" : \"transformationName\",\n                \"value\" : \"lv_locality_transformation\"\n              }\n            ]\n          }\n        ]\n      },\n    {\n      \"sourceAttributes\": [\n          \"businessPartner.record\" or \"$\"\n      ],\n      \"targetAttributes\": [\n          \"address.thoroughfare[0].value\",\n          \"address.thoroughfare[1].value\"\n      ],\n      \"transformations\": [\n        {\n          \"type\" : \"CUSTOM\",\n          \"parameters\": [\n            {\n              \"key\" : \"transformationName\",\n              \"value\" : \"lv_thoroughfare_transformation\"\n            }\n          ]\n        }\n      ]\n    }\n    ]\n  }\n\n}\n"},"children":[]}]}],"example":"lv_locality_transformation"},"code":{"type":"string","description":"The code of the given script.","example":"{Script example in the description.}"}}}},"components/schemas/BusinessPartnerMappingRule":{"id":"components/schemas/BusinessPartnerMappingRule","kind":"json-schema","title":"BusinessPartnerMappingRule","data":{"type":"object","description":"Maps a Business Partner data from raw data to CDQ data model.","properties":{"businessPartnerAttributeMappings":{"type":"array","description":"List of Business Partner Attribute Mappings.","items":{"$ref":"#/components/schemas/AttributeMappingRule"}},"addressesAttributeMappings":{"type":"array","description":"Maps an address attribute from raw data to CDQ data model.","items":{"type":"array","description":"List of Address Attribute Mappings.","items":{"$ref":"#/components/schemas/AttributeMappingRule"}}}}}},"components/schemas/BusinessPartnerMappingRuleParam":{"id":"components/schemas/BusinessPartnerMappingRuleParam","kind":"json-schema","title":"BusinessPartnerMappingRuleParam","data":{"type":"object","description":"Maps Business Partner data from raw data to the CDQ data model.","properties":{"businessPartnerAttributeMappings":{"type":"array","description":"List of Business Partner Attribute Mappings.","items":{"$ref":"#/components/schemas/AttributeMappingRuleParam"}},"addressesAttributeMappings":{"type":"array","description":"Maps an address attribute from raw data to the CDQ data model.","items":{"type":"array","description":"List of Address Attribute Mappings.","items":{"$ref":"#/components/schemas/AttributeMappingRuleParam"}}}}}},"components/schemas/AttributeMappingRule":{"id":"components/schemas/AttributeMappingRule","kind":"json-schema","title":"AttributeMappingRule","data":{"type":"object","description":"Maps an attribute from raw data to CDQ data model.","properties":{"sourceConstant":{"type":"string","description":"Assigns a fix value at path defined in targetAttributes.","example":"LOCAL"},"sourceAttributes":{"type":"array","description":"List of source attributes.","items":{"type":"string","description":"The input attributes, respectively the paths of these attributes in the data source.","example":"Name"}},"targetAttributes":{"type":"array","description":"List of target attributes.","items":{"type":"string","description":"The target attributes, respectively the paths of these attributes in the CDQ data model.","example":"businessPartner.names[0].value"}},"targetAttributeTypes":{"type":"array","description":"List of target attribute types.","items":{"type":"string","description":"If there is a typified concept, e.g. identifiers, the target type can be specified.","example":"LOCAL"}},"countryScopes":{"type":"array","description":"List of country scopes.","items":{"type":"string","description":"If there is a country scope, e.g. for addresses, the country scope can be specified.","example":"DE"}},"selectionType":{"$ref":"#/components/schemas/SourceSelectionType"},"separationType":{"$ref":"#/components/schemas/SourceSeparationType"},"isMandatoryAttribute":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define if the attribute is mandatory or optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the attribute is mandatory."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the attribute is optional."},"children":[]}]}]}],"example":"true"},"valueMapping":{"type":"string","description":"Maps a cons from raw data to CDQ data model.","example":"INTERNATIONAL"},"defaultValue":{"type":"string","description":"Defines default values applied for fields, for which no value was provided.","example":"GB"},"transformations":{"type":"array","description":"List of transformations.","items":{"$ref":"#/components/schemas/Transformation"},"maxItems":10}}}},"components/schemas/AttributeMappingRuleParam":{"id":"components/schemas/AttributeMappingRuleParam","kind":"json-schema","title":"AttributeMappingRuleParam","data":{"type":"object","description":"Maps an attribute from raw data to the CDQ data model.","properties":{"sourceConstant":{"type":"string","description":"Assigns a fixed value at the path defined in targetAttributes.","example":"LOCAL"},"sourceAttributes":{"type":"array","description":"List of source attributes.","items":{"type":"string","description":"The input attributes, respectively the paths of these attributes in the data source.","example":"Name"}},"targetAttributes":{"type":"array","description":"List of target attributes.","items":{"type":"string","description":"The target attributes, respectively the paths of these attributes in the CDQ data model.","example":"businessPartner.names[0].value"}},"targetAttributeTypes":{"type":"array","description":"List of target attribute types.","items":{"type":"string","description":"If there is a typified concept, e.g. identifiers, the target type can be specified.","example":"LOCAL"}},"countryScopes":{"type":"array","description":"List of country scopes.","items":{"type":"string","description":"If there is a country scope, e.g., for addresses, the country scope can be specified.","example":"DE"}},"selectionType":{"$ref":"#/components/schemas/SourceSelectionTypeParam"},"separationType":{"$ref":"#/components/schemas/SourceSeparationTypeParam"},"isMandatoryAttribute":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define if the attribute is mandatory or optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the attribute is mandatory."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the attribute is optional."},"children":[]}]}]}],"example":"true"},"valueMapping":{"type":"string","description":"Maps a cons from raw data to the CDQ data model.","example":"INTERNATIONAL"},"defaultValue":{"type":"string","description":"Defines default values applied for fields, for which no value was provided.","example":"GB"},"transformations":{"type":"array","description":"List of transformations.","items":{"$ref":"#/components/schemas/TransformationParam"},"maxItems":10}}}},"components/schemas/Transformation":{"id":"components/schemas/Transformation","kind":"json-schema","title":"Transformation","data":{"type":"object","description":"Transformation of the source value. The source value is the value of the source attribute.","properties":{"type":{"$ref":"#/components/schemas/TransformationType"},"parameters":{"type":"array","description":"Depending on the Transformation Type, different parameters can be given.","items":{"$ref":"#/components/schemas/TransformationParameter"}}}}},"components/schemas/TransformationParam":{"id":"components/schemas/TransformationParam","kind":"json-schema","title":"TransformationParam","data":{"type":"object","description":"Transformation of the source value. The source value is the value of the source attribute.","properties":{"type":{"$ref":"#/components/schemas/TransformationTypeParam"},"parameters":{"type":"array","description":"Depending on the Transformation Type different parameters can be given.","items":{"$ref":"#/components/schemas/TransformationParameter"}}}}},"components/schemas/TransformationParameter":{"id":"components/schemas/TransformationParameter","kind":"json-schema","title":"TransformationParameter","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters for the Transformation."},"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":"UPPER_CASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - no parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOWER_CASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - no parameters"},"children":[]}]}]}]}],"properties":{"key":{"type":"string","description":"Transformation parameter key.","example":"transformationName"},"value":{"type":"string","description":"Value of the parameter.","example":"lv_locality_transformation"}}}},"components/schemas/TransformationTypeParam":{"id":"components/schemas/TransformationTypeParam","kind":"json-schema","title":"TransformationTypeParam","data":{"type":"string","description":"Define the Transformation Type.","example":"UPPER_CASE","enum":["UPPER_CASE","LOWER_CASE"],"x-enumDescriptions":{"UPPER_CASE":"Converts the value to upper case.","LOWER_CASE":"Converts the value to lower case."}}},"components/schemas/TransformationType":{"id":"components/schemas/TransformationType","kind":"json-schema","title":"TransformationType","data":{"type":"string","description":"Define the Transformation Type.","example":"UPPER_CASE"}},"components/schemas/SourceSelectionType":{"id":"components/schemas/SourceSelectionType","kind":"json-schema","title":"SourceSelectionType","data":{"type":"string","description":"Defines how attribute values should be concatenated.","example":"COMMA"}},"components/schemas/SourceSeparationType":{"id":"components/schemas/SourceSeparationType","kind":"json-schema","title":"SourceSeparationType","data":{"type":"string","description":"Define how the source value should be separated.","example":"LENGTH"}},"components/schemas/SourceSelectionTypeParam":{"id":"components/schemas/SourceSelectionTypeParam","kind":"json-schema","title":"SourceSelectionTypeParam","data":{"type":"string","description":"Defines how attribute values should be concatenated.","example":"COMMA","enum":["COMMA","EMPTY","HYPHEN","SEMICOLON","SPACE","XOR"],"x-enumDescriptions":{"COMMA":"Selects the first value before the first comma.","EMPTY":"Selects the first value before the first empty space.","HYPHEN":"Selects the first value before the first hyphen.","SEMICOLON":"Selects the first value before the first semicolon.","SPACE":"Selects the first value before the first space.","XOR":"Selects the first value before the first comma, hyphen, semicolon or space."}}},"components/schemas/SourceSeparationTypeParam":{"id":"components/schemas/SourceSeparationTypeParam","kind":"json-schema","title":"SourceSeparationTypeParam","data":{"type":"string","description":"Define how the source value should be separated.","example":"LENGTH","enum":["LENGTH"],"x-enumDescriptions":{"LENGTH":"Selects the first value with the given length."}}},"components/schemas/DataMapperDefinitionRequest":{"id":"components/schemas/DataMapperDefinitionRequest","kind":"json-schema","title":"DataMapperDefinitionRequest","data":{"type":"object","description":"Request to create a new Data Mapper Definition.","required":["name","inputMapping"],"properties":{"name":{"type":"string","description":"Name of the Data Mapper Definition.","example":"Custom Data Mapper Definition"},"labels":{"type":"array","description":"Labels to categorize the Data Mapper Definition.","items":{"type":"string","description":"Label to categorize the Data Mapper Definition.","example":"Custom Data Mapper Label"}},"shareWithOrganization":{"type":"boolean","description":"Toggle to enable that the Data Mapper Definition is shared with the whole organization.","example":"true"},"valueMappings":{"type":"array","description":"List of value mappings.","items":{"$ref":"#/components/schemas/ValueMapping"}},"inputMapping":{"$ref":"#/components/schemas/BusinessPartnerMappingRuleParam"},"outputMapping":{"$ref":"#/components/schemas/BusinessPartnerMappingRuleParam"}}}},"components/schemas/ValueMapping":{"id":"components/schemas/ValueMapping","kind":"json-schema","title":"ValueMapping","data":{"type":"object","description":"Maps a cons from raw data to CDQ data model.","properties":{"sourceValue":{"type":"string","description":"The source value for a value mapping.","example":"en"},"targetValue":{"type":"string","description":"The target value for a value mapping.","example":"INTERNATIONAL"},"targetAttribute":{"type":"string","description":"The target attribute value (Business Partner or address) in the CDQ data model.","example":"address.version.characterSet"}}}},"components/schemas/DataMapperDefinitionPage":{"id":"components/schemas/DataMapperDefinitionPage","kind":"json-schema","title":"DataMapperDefinitionPage","data":{"type":"object","description":"Page of Data Mapper Definitions details.","properties":{"numberOfPages":{"$ref":"#/components/schemas/NumberOfPages"},"page":{"$ref":"#/components/schemas/Page"},"pageSize":{"$ref":"#/components/schemas/PageSize"},"total":{"$ref":"#/components/schemas/PageTotal"},"values":{"type":"array","description":"List of Data Mapper Definitions.","items":{"$ref":"#/components/schemas/DataMapperDefinition"}}}}},"components/schemas/TransformRequest":{"id":"components/schemas/TransformRequest","kind":"json-schema","title":"TransformRequest","data":{"deprecated":true,"type":"object","description":"Request to transform raw data to CDQ data model.","properties":{"recordsAsJsonString":{"type":"array","description":"The records to be transformed as json string.","items":{"type":"string","description":"The record to be transformed as json string.","example":"{\"address\": \"Musterstrasse 1, 12345 Musterstadt\"}"}}}}},"components/schemas/ImportJob":{"id":"components/schemas/ImportJob","kind":"json-schema","title":"ImportJob","data":{"type":"object","description":"An Import Job is used to import raw data into the Data Mirror. Job is executed asynchronously. The result of the Import Job can be retrieved by the Job ID.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"name":{"$ref":"#/components/schemas/JobName"},"description":{"$ref":"#/components/schemas/JobDescription"},"domain":{"$ref":"#/components/schemas/Domain"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"progress":{"$ref":"#/components/schemas/JobProgress"},"status":{"$ref":"#/components/schemas/JobStatus"},"statusMessage":{"$ref":"#/components/schemas/JobStatusMessage"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"dataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"dataMapperDefinitionId":{"$ref":"#/components/schemas/DataMapperDefinitionId"},"externalIdColumn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the column which will be mapped to external ID. This is required if feature UPSERT_BY_EXTERNAL_ID is activated."},"children":[]}]}]}],"example":"BP_EXTERNAL_ID"},"featureOn":{"type":"array","description":"List of features which are activated for the Import Job.","items":{"type":"string","description":"Feature activated during the Import Job.","example":"UPSERT_BY_EXTERNAL_ID"}},"result":{"$ref":"#/components/schemas/ImportJobResult"}}}},"components/schemas/ImportJobResult":{"id":"components/schemas/ImportJobResult","kind":"json-schema","title":"ImportJobResult","data":{"type":"object","description":"The result of the Import Job.","properties":{"statistics":{"$ref":"#/components/schemas/ImportJobStatistics"}}}},"components/schemas/ImportJobStatistics":{"id":"components/schemas/ImportJobStatistics","kind":"json-schema","title":"ImportJobStatistics","data":{"type":"object","description":"The statistics of the Import Job.","properties":{"numberOfInserts":{"type":"integer","format":"int32","description":"Number of inserted Business Partners.","example":"10"},"numberOfUpdates":{"type":"integer","format":"int32","description":"Number of updated Business Partners.","example":"10"},"numberOfFailed":{"type":"integer","format":"int32","description":"Number of failed Business Partners.","example":"10"},"skipped":{"type":"array","description":"List of skipped lines and other errors.","items":{"$ref":"#/components/schemas/CorruptedLineResult"}},"skippedStartAfter":{"type":"string","description":"The line number of the first skipped line.","example":"10"},"skippedNextStartAfter":{"type":"string","description":"The line number of the next skipped line.","example":"20"}}}},"components/schemas/CorruptedLineResult":{"id":"components/schemas/CorruptedLineResult","kind":"json-schema","title":"CorruptedLineResult","data":{"type":"object","description":"The result of a corrupted line or other errors that occurred during the import job.","properties":{"line":{"type":"integer","format":"int64","description":"The line number of the corrupted line.","example":"10"},"column":{"type":"integer","format":"int32","description":"The column number of the corrupted line.","example":"10"},"businessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerId"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"message":{"type":"string","description":"Details about failure.","example":"Invalid path 'Postal code' (Use bracket notation...)"}}}},"components/schemas/TransformationJob":{"id":"components/schemas/TransformationJob","kind":"json-schema","title":"TransformationJob","data":{"type":"object","description":"A Transformation Job is used to transform raw data into CDQ Data Model, and it is based on a Data Mapper Definition.\nJob is executed asynchronously. The result of the Transformation Job can be retrieved by the Job ID.\n","properties":{"id":{"$ref":"#/components/schemas/JobId"},"domain":{"$ref":"#/components/schemas/Domain"},"name":{"$ref":"#/components/schemas/JobName"},"description":{"$ref":"#/components/schemas/JobDescription"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"progress":{"$ref":"#/components/schemas/JobProgress"},"status":{"$ref":"#/components/schemas/JobStatusResult"},"statusMessage":{"type":"string","description":"The status message contains the error message if the transformation job failed.","example":"DataSource [5e2874fb8d2a7400011acee1] has no DataMapperDefinition attached and no alternative dataMapperDefinitionId was passed to the job"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"dataMapperDefinitionId":{"$ref":"#/components/schemas/DataMapperDefinitionId"},"featuresOn":{"type":"array","items":{"$ref":"#/components/schemas/TransformationJobFeature"}},"result":{"$ref":"#/components/schemas/TransformationJobResult"}}}},"components/schemas/TransformationJobResult":{"id":"components/schemas/TransformationJobResult","kind":"json-schema","title":"TransformationJobResult","data":{"type":"object","description":"The result of a Transformation Job.","properties":{"statistics":{"$ref":"#/components/schemas/TransformationJobStatistics"}}}},"components/schemas/TransformationJobStatistics":{"id":"components/schemas/TransformationJobStatistics","kind":"json-schema","title":"TransformationJobStatistics","data":{"type":"object","description":"The statistics of a transformation job.","properties":{"numberOfRecords":{"$ref":"#/components/schemas/NumberOfRecords"},"numberOfFailed":{"type":"integer","format":"int64","description":"The number of failed transformation.","example":"10"},"numberOfInvalidMappings":{"type":"integer","format":"int64","description":"The number of records that failed because of invalid mappings.","example":"3"},"failures":{"type":"array","description":"List of failures.","items":{"$ref":"#/components/schemas/TransformationJobFailure"}},"failuresStartAfter":{"type":"string","description":"The ID which is used to read the page of failures.","example":"NmEyOThlMGM4MTAyNTI3NWM2M2M1Y2I3"},"failuresNextStartAfter":{"type":"string","description":"Provides a value to be used as a startAfter in next page request.","example":"NmEyOThlMGM4MTAyNTI3NWM2M2M1Y2I3"}}}},"components/schemas/TransformationJobFailure":{"id":"components/schemas/TransformationJobFailure","kind":"json-schema","title":"TransformationJobFailure","data":{"type":"object","description":"Information about a failure during a transformation job.","properties":{"businessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerId"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"message":{"type":"string","description":"Details about why the record failed.","example":"Invalid path 'Postal code' (Use bracket notation...)"}}}},"components/schemas/EventCreateFeatureParam":{"id":"components/schemas/EventCreateFeatureParam","kind":"json-schema","title":"EventCreateFeatureParam","data":{"type":"string","description":"Feature to be used during the Event creation.","example":"INITIALIZE","enum":["INITIALIZE","NO_PERSISTENCE"],"x-enumDescriptions":{"INITIALIZE":"Used only when the Business Partner Storage has never had UPDATES feature. Creates only BusinessPartnerCreated events without checking for existing BusinessPartnerEvents. Goal is to speed up setting UPDATES feature.","NO_PERSISTENCE":"Do not persist events. Execution is performed for test and debug purposes to check e.g. if no events are missing."}}},"components/schemas/StorageDeleteFeatureParam":{"id":"components/schemas/StorageDeleteFeatureParam","kind":"json-schema","title":"StorageDeleteFeatureParam","data":{"type":"string","description":"Feature to be used during the Storage delete.","example":"FORCE_DATA_MIRROR","enum":["FORCE_DATA_MIRROR"],"x-enumDescriptions":{"FORCE_DATA_MIRROR":"Delete the data mirror of the Business Partner Storage. This will delete all data of the Business Partner Storage and all events."}}},"components/schemas/ToggleUpdateMonitoringJobRequest":{"id":"components/schemas/ToggleUpdateMonitoringJobRequest","kind":"json-schema","title":"ToggleUpdateMonitoringJobRequest","data":{"type":"object","description":"Parameter to describe if the Business Partners should be activated for update monitoring (true) or deactivated (false) for non-commercial reference data sources.","required":["enable","storageId","dataSourceId"],"properties":{"enable":{"$ref":"#/components/schemas/ToggleUpdateMonitoringRequestEnable"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"name":{"maxLength":50,"$ref":"#/components/schemas/JobName"},"description":{"maxLength":200,"$ref":"#/components/schemas/JobDescription"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"countryShortName":{"$ref":"#/components/schemas/CountryShortName"}}}},"components/schemas/ToggleUpdateMonitoringJobResult":{"id":"components/schemas/ToggleUpdateMonitoringJobResult","kind":"json-schema","title":"ToggleUpdateMonitoringJobResult","data":{"type":"object","description":"Result of the Toggle Update Monitoring job with the status.","properties":{"job":{"$ref":"#/components/schemas/ToggleUpdateMonitoringJob"},"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":" - Toggle Update Monitoring Job 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":" - Toggle Update Monitoring Job with that ID has not been found"},"children":[]}]}]}]}],"example":"OK"}}}},"components/schemas/ToggleUpdateMonitoringJob":{"id":"components/schemas/ToggleUpdateMonitoringJob","kind":"json-schema","title":"ToggleUpdateMonitoringJob","data":{"type":"object","description":"Result of the Toggle Update Monitoring job.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"progress":{"$ref":"#/components/schemas/JobProgress"},"status":{"$ref":"#/components/schemas/JobStatusResult"},"statusMessage":{"$ref":"#/components/schemas/JobStatusMessage"},"enable":{"$ref":"#/components/schemas/ToggleUpdateMonitoringRequestEnable"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"dataSourceId":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"countryShortName":{"$ref":"#/components/schemas/CountryShortName"}}}},"components/schemas/BusinessPartnerUpdatesReportSummary":{"id":"components/schemas/BusinessPartnerUpdatesReportSummary","kind":"json-schema","title":"BusinessPartnerUpdatesReportSummary","data":{"type":"object","description":"Summary of the Business Partner Updates Report.","properties":{"numberOfUpdates":{"type":"integer","description":"Number of updates.","example":"10"},"numberOfCountries":{"type":"integer","description":"The number of countries.","example":"10"}}}},"components/schemas/JobStatusResult":{"id":"components/schemas/JobStatusResult","kind":"json-schema","title":"JobStatusResult","data":{"type":"string","description":"Job execution status.","example":"RUNNING"}},"components/schemas/JobStatus":{"id":"components/schemas/JobStatus","kind":"json-schema","title":"JobStatus","data":{"type":"string","description":"Job execution status.","example":"RUNNING","enum":["ARCHIVED","UNKNOWN","CREATED","PERSISTED","SCHEDULED","WAITING","COULDNT_START","RUNNING","FINISHED","DIED","CANCELED","FAILED"],"x-enumDescriptions":{"ARCHIVED":"Job has been archived.","UNKNOWN":"Job becomes in unknown status.","CREATED":"Job has been created.","PERSISTED":"Job metadata has been persisted.","SCHEDULED":"Job has been scheduled for execution.","WAITING":"Job is waiting for being scheduled.","COULDNT_START":"Job could not be started.","RUNNING":"Job is being executed.","FINISHED":"Job has finished.","DIED":"Job was scheduled and started running but died unexpectedly.","CANCELED":"Job has been canceled due to invalid input configuration.","FAILED":"Job has failed."}}},"components/schemas/TransformationJobRequest":{"id":"components/schemas/TransformationJobRequest","kind":"json-schema","title":"TransformationJobRequest","data":{"type":"object","description":"A Transformation Job is used to transform raw data into CDQ data model, and it is based on a Data Mapper Definition.\nThe Transformation Job is executed asynchronously. The result of the Transformation Job can be retrieved by the Job ID.\n","properties":{"name":{"maxLength":50,"$ref":"#/components/schemas/JobName"},"description":{"maxLength":200,"$ref":"#/components/schemas/JobDescription"},"dataSourceId":{"type":"string","description":"Unique identifier for a Data Source of the Storage. \n\nIf set, only the records that belong to the data source identified by this ID are transformed.\nBy default, all records of the Business Partner Storage (means from all data sources) are transformed.\n","example":"648824a691d8d2503d65103e"},"countries":{"type":"array","description":"List of countries for which the records should be transformed.","items":{"$ref":"#/components/schemas/TransformationJobRequestCountry"}},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"dataMapperDefinitionId":{"$ref":"#/components/schemas/DataMapperDefinitionId"},"startAfter":{"type":"string","description":"Processes transformation of records starting from the ID 'startAfter'.","example":"NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm"},"businessPartnerIds":{"type":"array","description":"List of Business Partner IDs to be transformed.","items":{"$ref":"#/components/schemas/BusinessPartnerId"}},"featuresOn":{"type":"array","items":{"$ref":"#/components/schemas/TransformationJobFeatureParam"}}},"required":["storageId"]}},"components/schemas/TransformationJobRequestCountry":{"id":"components/schemas/TransformationJobRequestCountry","kind":"json-schema","title":"TransformationJobRequestCountry","data":{"type":"object","description":"Country code (ISO 3166-1 alpha-2) for which the records should be transformed.","required":["shortName"],"properties":{"shortName":{"$ref":"#/components/schemas/CountryShortName"}}}},"components/schemas/TransformationJobFeature":{"id":"components/schemas/TransformationJobFeature","kind":"json-schema","title":"TransformationJobFeature","data":{"type":"string","description":"Modifies behavior of a transformation job.","example":"UPSERT_CHANGES_ONLY"}},"components/schemas/TransformationJobFeatureParam":{"id":"components/schemas/TransformationJobFeatureParam","kind":"json-schema","title":"TransformationJobFeatureParam","data":{"type":"string","description":"Modifies behavior of a transformation job.","example":"UPSERT_CHANGES_ONLY","enum":["ENABLE_EXTERNAL_ID_UPDATE","UPSERT_CHANGES_ONLY"],"x-enumDescriptions":{"ENABLE_EXTERNAL_ID_UPDATE":"Enables to update external ID of a Business Partner.","UPSERT_CHANGES_ONLY":"Performs transformation only for business partners, for which changes in the mapping are relevant. By default, all records of the storage are transformed."}}},"components/schemas/ApiError":{"id":"components/schemas/ApiError","kind":"json-schema","title":"ApiError","data":{"type":"object","description":"Detailed information about API errors.","properties":{"id":{"$ref":"#/components/schemas/ApiErrorId"},"code":{"$ref":"#/components/schemas/ApiErrorCode"},"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/ApiErrorId":{"id":"components/schemas/ApiErrorId","kind":"json-schema","title":"ApiErrorId","data":{"type":"string","description":"Unique identifier of the error.","example":"5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a"}},"components/schemas/ApiErrorCode":{"id":"components/schemas/ApiErrorCode","kind":"json-schema","title":"ApiErrorCode","data":{"type":"integer","deprecated":true,"description":"Use 'status' instead.","example":"400"}},"components/schemas/DnbImportJobFeature":{"id":"components/schemas/DnbImportJobFeature","kind":"json-schema","title":"DnbImportJobFeature","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modifies behavior of a D&B Import Job."},"children":[]}]}]}],"example":"ENRICH_COMMERCIAL_ULTIMATE","enum":["ENRICH_COMMERCIAL_ULTIMATE","ENABLE_PARTIAL_QUOTA_CONSUMPTION","SKIP_DNB_IMPORT","INCREMENT","ACTIVATE_MASTER_DATA_EXTENDED"],"x-enumDescriptions":{"ENRICH_COMMERCIAL_ULTIMATE":"Enriches Commercial Ultimate.","ENABLE_PARTIAL_QUOTA_CONSUMPTION":"Enables to run import job on a remaining quota when full quota not available.","SKIP_DNB_IMPORT":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Skips requesting D&B data from D&B services. Can be used to enrich only Commercial Ultimate."},"children":[]}]}]}],"INCREMENT":"Continue processing after the last processed result with a goal to run on newly created Business Partners from a Business Partner Storage.","ACTIVATE_MASTER_DATA_EXTENDED":"Enables to use data blocks instead of cmplek when fetching data from DNB."}}},"components/schemas/DnbCreateLODJob":{"id":"components/schemas/DnbCreateLODJob","kind":"json-schema","title":"DnbCreateLODJob","data":{"type":"object","description":"Job for creating List of Duns file.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"name":{"$ref":"#/components/schemas/JobName"},"description":{"$ref":"#/components/schemas/JobDescription"},"progress":{"$ref":"#/components/schemas/JobProgress"},"status":{"$ref":"#/components/schemas/JobStatusResult"},"statusMessage":{"type":"string","description":"Message describing the status of the job.","example":"Job is running"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"attachments":{"type":"array","description":"List of attachments.","items":{"$ref":"#/components/schemas/FileResource"}}}}},"components/schemas/DnbImportJob":{"id":"components/schemas/DnbImportJob","kind":"json-schema","title":"DnbImportJob","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Job for importing data from D&B."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/JobId"},"name":{"$ref":"#/components/schemas/JobName"},"description":{"$ref":"#/components/schemas/JobDescription"},"progress":{"$ref":"#/components/schemas/JobProgress"},"status":{"$ref":"#/components/schemas/JobStatus"},"statusMessage":{"type":"string","description":"Message describing the status of the job.","example":"Job is running"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"result":{"$ref":"#/components/schemas/DnbImportJobResult"}}}},"components/schemas/DnbImportJobResult":{"id":"components/schemas/DnbImportJobResult","kind":"json-schema","title":"DnbImportJobResult","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 D&B import job."},"children":[]}]}]}],"properties":{"statistics":{"$ref":"#/components/schemas/DnbImportJobStatistics"}}}},"components/schemas/DnbImportJobStatistics":{"id":"components/schemas/DnbImportJobStatistics","kind":"json-schema","title":"DnbImportJobStatistics","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics of D&B import job."},"children":[]}]}]}],"properties":{"numberOfRecords":{"$ref":"#/components/schemas/NumberOfRecords"},"numberOfDuplicates":{"type":"number","description":"Number of duplicates in input file which have the same DUNS.","example":"5"},"numberOfInserts":{"type":"number","description":"Number of newly created records.","example":"100"},"numberOfUpdates":{"type":"number","description":"Number of updated records.","example":"100"},"numberOfFailed":{"type":"number","description":"Number of records updates / retrieves fails.","example":"50"},"numberOfQuotaExceeded":{"type":"integer","format":"int64","description":"Number of not processed records which exceeded defined quota limit.","example":"100"},"numberOfUnknown":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of non-retrieved records from D&B service."},"children":[]}]}]}],"example":"100"}}}},"components/schemas/DnbLodJobRequest":{"id":"components/schemas/DnbLodJobRequest","kind":"json-schema","title":"DnbLodJobRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters for D&B lod job."},"children":[]}]}]}],"properties":{"name":{"$ref":"#/components/schemas/JobName","maxLength":50},"description":{"$ref":"#/components/schemas/JobDescription","maxLength":200}}}},"components/schemas/FileResource":{"id":"components/schemas/FileResource","kind":"json-schema","title":"FileResource","data":{"type":"object","description":"Provide data with a file.","properties":{"url":{"$ref":"#/components/schemas/FileResourceUrl"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"}}}},"components/schemas/FileResourceUrl":{"id":"components/schemas/FileResourceUrl","kind":"json-schema","title":"FileResourceUrl","data":{"type":"string","description":"Url of the stored file.","example":"customer-uploads/cdq/john.doe%40cdq.com/file.xlsx"}},"components/schemas/MonitorStorageCleanupJob":{"id":"components/schemas/MonitorStorageCleanupJob","kind":"json-schema","title":"MonitorStorageCleanupJob","data":{"type":"object","description":"Result of Monitor Storage Cleanup job.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"progress":{"$ref":"#/components/schemas/JobProgress"},"status":{"$ref":"#/components/schemas/JobStatusResult"},"statusMessage":{"$ref":"#/components/schemas/JobStatusMessage"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"}}}},"components/schemas/SharingJob":{"id":"components/schemas/SharingJob","kind":"json-schema","title":"SharingJob","data":{"type":"object","description":"Result of Sharing job.","properties":{"id":{"$ref":"#/components/schemas/JobId"},"progress":{"$ref":"#/components/schemas/JobProgress"},"status":{"$ref":"#/components/schemas/JobStatusResult"},"statusMessage":{"$ref":"#/components/schemas/JobStatusMessage"},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"}}}},"components/schemas/RestartMonitorJobFeatureParam":{"id":"components/schemas/RestartMonitorJobFeatureParam","kind":"json-schema","title":"RestartMonitorJobFeatureParam","data":{"type":"string","description":"Features to be used during the Restart Monitor job.","example":"CDQ_POOL","enum":["CDQ_POOL","RESTART","REMOVE_DUPLICATES"],"x-enumDescriptions":{"CDQ_POOL":"Points to CDQ.POOL.","RESTART":"Performs restart on pointed sharing pool.","REMOVE_DUPLICATES":"Removes duplicates based on provided deduplication job as input.","DATA_DEFECTS":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test run for REMOVE_HAVING_DATA_DEFECTS."},"children":[]}]}]}],"REMOVE_HAVING_DATA_DEFECTS":"Removes BPs with data defects from cdq pool."}}},"components/schemas/FileUploadRequest":{"id":"components/schemas/FileUploadRequest","kind":"json-schema","title":"FileUploadRequest","data":{"type":"object","description":"Request for file upload.","properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File name which will be uploaded in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer-uploads/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directory."},"children":[]}]}]}],"example":"dq-chart.png or requestedDirectory/dq-chart.png"}},"required":["url"]}},"components/schemas/FileUploadResult":{"id":"components/schemas/FileUploadResult","kind":"json-schema","title":"FileUploadResult","data":{"type":"object","description":"Result of file upload.","properties":{"uploadLink":{"type":"string","description":"Url to file.","example":"https://file.cdq.com/customer-uploads/cdlbot/dq-chart.png"},"uploadMethod":{"type":"string","description":"Method of uploading file.","example":"PUT"},"expiresAt":{"$ref":"#/components/schemas/ExpiresAt"},"url":{"type":"string","description":"Url to file, place where it is stored.","example":"customer-uploads/cdlbot/dq-chart.png"}}}},"components/schemas/FileDeleteResponse":{"id":"components/schemas/FileDeleteResponse","kind":"json-schema","title":"FileDeleteResponse","data":{"type":"object","description":"Response for file delete.","properties":{"results":{"type":"array","description":"List of results for each file.","items":{"$ref":"#/components/schemas/FileDeleteResult"}}}}},"components/schemas/FileDeleteResult":{"id":"components/schemas/FileDeleteResult","kind":"json-schema","title":"FileDeleteResult","data":{"type":"object","description":"Result of file delete.","properties":{"url":{"type":"string","description":"Url to file.","example":"customer-uploads/cdlbot/dq-chart.png"},"status":{"type":"string","description":"File delete status.","example":"OK"},"message":{"type":"string","description":"Message with result of file delete.","example":"File has been deleted successfully"}}}},"components/schemas/FileDownloadResult":{"id":"components/schemas/FileDownloadResult","kind":"json-schema","title":"FileDownloadResult","data":{"type":"object","description":"Result of file download.","allOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"object","description":"Result of file download.","properties":{"expiresAt":{"$ref":"#/components/schemas/ExpiresAt"},"downloadLink":{"type":"string","description":"Url to file.","example":"https://file.cdq.com/customer-uploads/cdlbot/dq-chart.png"},"downloadMethod":{"type":"string","description":"Method of uploading file.","example":"GET"}}}]}},"components/schemas/FileDownloadRequest":{"id":"components/schemas/FileDownloadRequest","kind":"json-schema","title":"FileDownloadRequest","data":{"type":"object","description":"Request for file download.","required":["url"],"properties":{"url":{"type":"string","description":"ID of the file.","example":"customer-upload/user/file.xlsx"},"downloadLinkAge":{"description":"Number of milliseconds the download link is active.","type":"integer","format":"int64","default":0,"example":"0"}}}},"components/schemas/ResourcesListResult":{"id":"components/schemas/ResourcesListResult","kind":"json-schema","title":"ResourcesListResult","data":{"type":"object","description":"Page of file resources.","properties":{"startAfter":{"$ref":"#/components/schemas/FilesPageStartAfter"},"limit":{"$ref":"#/components/schemas/Limit"},"nextStartAfter":{"$ref":"#/components/schemas/FilesPageNextStartAfter"},"files":{"type":"array","description":"Array of FileResource objects.","items":{"$ref":"#/components/schemas/FileResource"}}}}},"components/schemas/FilesPageNextStartAfter":{"id":"components/schemas/FilesPageNextStartAfter","kind":"json-schema","title":"FilesPageNextStartAfter","data":{"type":"string","description":"Value of continuation token required to retrieve results from the next page. Should be passed in the next request as the \"startAfter\" parameter.","example":"1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u"}},"components/schemas/FilesPageStartAfter":{"id":"components/schemas/FilesPageStartAfter","kind":"json-schema","title":"FilesPageStartAfter","data":{"type":"string","description":"Value of continuation token from the request.","example":"1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u"}},"components/schemas/DnbRecordsUpsertFeature":{"id":"components/schemas/DnbRecordsUpsertFeature","kind":"json-schema","title":"DnbRecordsUpsertFeature","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features for D&B Records upsert."},"children":[]}]}]}],"example":"ASYNC_PROCESSING","enum":["ASYNC_PROCESSING"],"x-enumDescriptions":{"ASYNC_PROCESSING":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Save D&B Records in synchronous mode"},"children":[]}]}]}]}}},"components/schemas/DnbRecordFailureLog":{"id":"components/schemas/DnbRecordFailureLog","kind":"json-schema","title":"DnbRecordFailureLog","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log of failed D&B record."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"Unique identifier of the failed record.","example":"5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a"},"duns":{"$ref":"#/components/schemas/Duns"},"message":{"type":"string","description":"Message describing the status of the request.","example":"Fail"}}}},"components/schemas/CommercialUltimateUpdate":{"id":"components/schemas/CommercialUltimateUpdate","kind":"json-schema","title":"CommercialUltimateUpdate","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUNS number of D&B record and his new Commercial Ultimate to update."},"children":[]}]}]}],"properties":{"duns":{"$ref":"#/components/schemas/Duns"},"commercialUltimate":{"$ref":"#/components/schemas/CommercialUltimate"}},"required":["duns","commercialUltimate"]}},"components/schemas/LastSyncAt":{"id":"components/schemas/LastSyncAt","kind":"json-schema","title":"LastSyncAt","data":{"type":"string","description":"Date of last synchronization.","example":"2026-10-21T13:37:18Z"}},"components/schemas/Duns":{"id":"components/schemas/Duns","kind":"json-schema","title":"Duns","data":{"type":"string","description":"DUNS number of the record to be fetched.","example":"15-048-3782"}},"components/schemas/CommercialUltimate":{"id":"components/schemas/CommercialUltimate","kind":"json-schema","title":"CommercialUltimate","data":{"type":"object","description":"Details of the highest commercial organization in the corporate family hierarchy.","properties":{"duns":{"$ref":"#/components/schemas/Duns"},"primaryName":{"type":"string","description":"Name of the Commercial Ultimate.","example":"Dun & Bradstreet, Inc."},"primaryAddress":{"$ref":"#/components/schemas/DnBAddress"},"path":{"type":"array","description":"List of DUNS numbers that represent the path from the subject to the Commercial Ultimate.","items":{"type":"object","description":"DUNS number that represents the path from the subject to the Commercial Ultimate.","properties":{"duns":{"$ref":"#/components/schemas/Duns"},"primaryName":{"type":"string","description":"Name of the Commercial Ultimate.","example":"Dun & Bradstreet, Inc."},"parentDuns":{"$ref":"#/components/schemas/Duns"}}}}}}},"components/schemas/DnBAddress":{"id":"components/schemas/DnBAddress","kind":"json-schema","title":"DnBAddress","data":{"type":"object","description":"The details of the single primary or physical address at which the entity is located.","properties":{"language":{"type":"object","description":"The details of the language in which this address was recorded.","properties":{"description":{"type":"string","description":"The name of the language in which this address was recorded.","example":"English"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this address was recorded."},"children":[]}]}]}],"example":"39"}}},"addressCountry":{"type":"object","description":"The details of the country in which this address is located.","properties":{"name":{"type":"string","description":"The name of the country in which this address is located.","example":"United States"},"isoAlpha2Code":{"type":"string","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country in which this address is located.","example":"US"},"fipsCode":{"type":"string","description":"The Federal Information Processing Standards (FIPS) code value that identifies the country in which this address is located.","example":"US"}}},"continentalRegion":{"type":"object","description":"The details of the continental region in which this address is located.","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continental region for this address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Latin America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- North America."},"children":[]}]}]}],"example":"North America"}}},"addressLocality":{"type":"object","description":"The details of the city, town, township, village, borough, etc. in which this address is located.","properties":{"name":{"type":"string","description":"The name of the city, town, township, village, borough, etc. in which this address is located.","example":"SAN FRANCISCO"}}},"minorTownName":{"type":"string","description":"The name of the village, town or suburb when it is not a Primary Town or City (e.g., the Booker in Booker, High Wycombe).","example":"Booker"},"addressRegion":{"type":"object","description":"The details of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","properties":{"name":{"type":"string","description":"The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","example":"Booker"},"abbreviatedName":{"type":"string","description":"The shortened name of the locally governed area that forms part of a centrally governed nation. For example 'NJ' for the US State New Jersey within Country United States.","example":"CA"},"fipsCode":{"type":"string","description":"The Federal Information Processing Standards (FIPS) code value that identifies the region in which this address is located.","example":"06"}}},"addressCounty":{"type":"object","description":"The details of the county in which this address is located.","properties":{"name":{"type":"string","description":"The name of the county in which this address is located.","example":"SAN MATEO"},"fipsCode":{"type":"string","description":"The Federal Information Processing Standards (FIPS) code value that identifies the county in which this address is located.","example":"81"}}},"postalCode":{"type":"string","description":"An identifier used by the local country's postal authority to identify where this address is located.","example":"941109999"},"postalCodePosition":{"type":"object","description":"The details of the position of the Postal Code when presenting the address.","properties":{"description":{"type":"string","description":"The position of the Postal Code when presenting the address (e.g., before the Primary Town/City).","example":"Post code presented before Town/City name."},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the position of the Postal Code when presenting the address."},"children":[]}]}]}],"example":"1009"}}},"streetNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number part of the street address where the entity is located. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may be a single number, a number with an appendix, or a range of street numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the \"51 - 59C\" in the address 51 - 59C Wall Street."},"children":[]}]}]}],"example":"492"},"streetName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the street where the entity is located. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Wall Street\" in the address 51 - 59C Wall Street."},"children":[]}]}]}],"example":"KOLLER ST"},"streetAddress":{"type":"object","description":"The details of the street address where the entity is located.","properties":{"line1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"41 Central Chambers\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2."},"children":[]}]}]}],"example":"492 KOLLER ST"},"line2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Dame Court\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2."},"children":[]}]}]}],"example":"Suite 100"}}},"postOfficeBox":{"type":"object","description":"The details of the identifier issued to the entity by a private or public Postal Office for the purposes of collecting mail for the entity for subsequent collection or delivery.","properties":{"postOfficeBoxNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An identifier issued to the entity by a private or public postal office for the purposes of collecting mail for the entity for subsequent collection or delivery."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes only the identifying number (or text) and not the textual description of the PO Box type. For example the contents would be just the number 12 from \"PO Box 12\", or just the number 57 from \"PMB 57\"."},"children":[]}]}]}],"example":"5309"},"typeDescription":{"type":"string","description":"The type of the PO Box (e.g., Post Office Box, PMB).","example":"Supplied by public Post Office authority."},"typeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of PO Box."},"children":[]}]}]}],"example":"120"}}},"latitude":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latitude component of the entity's location defined as the angular distance of the primary physical address north or south from the Earth's equator expressed in decimal numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positive numbers indicate degrees north. Negative numbers indicate degrees south."},"children":[]}]}]}],"example":"37.777709"},"longitude":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The longitude component of the entity's location defined as the angular distance of the primary physical address east or west from an imaginary line (called the prime meridian) that goes from the North Pole to the South Pole expressed in decimal numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positive numbers indicate degrees east. Negative numbers indicate degrees west."},"children":[]}]}]}],"example":"-122.404624"},"geographicalPrecision":{"type":"object","description":"The details on how close the latitude and longitude coordinates for a location are to rooftop level.","properties":{"description":{"type":"string","description":"The description of how close the latitude and longitude coordinates for a location are to rooftop level.","example":"Street Segment Centroid"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify how close the latitude and longitude coordinates for a location are to \"rooftop\" level."},"children":[]}]}]}],"example":"30256"}}},"isRegisteredAddress":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the primary address is the same as the address of the entity as registered with a legal entity.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the primary address is the same as the address of the entity as registered with a legal entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the primary address is the not same as the address of the entity as registered with a legal entity."},"children":[]}]}]}],"example":"true"},"isResidentialAddress":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the Primary Address is classified as residential by the governing postal authority"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the primary address is classified as residential."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the primary address is not classified as residential."},"children":[]}]}]}],"example":"false"},"statisticalArea":{"type":"object","description":"The details of the various statistical facts associated with this address.","properties":{"cbsaName":{"type":"string","description":"The name assigned to the 5-digit CBSA (Core Based Statistical Area) assigned by US Census board to denote a geographical region with a relatively high population density at its core and close economic ties throughout the area.","example":"San Francisco-Oakland-Hayward CA"},"cbsaCode":{"type":"string","description":"The 5-digit CBSA (Core Based Statistical Area) code assigned by US Census board to denote a geographical region with a relatively high population density at its core and close economic ties throughout the area.","example":"41860"},"economicAreaOfInfluenceCode":{"type":"string","description":"A code assigned by the U.S. Bureau of Economic Analysis to identify the entity's regional market that surrounds a metropolitan or micropolitan statistical area serving as a regional center of economic activity.","example":"146"},"populationRank":{"type":"object","description":"The details of the statistical facts about population based on region's rank.","properties":{"rankNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number classifying the geographic area in which the entity is located based on the resident population."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 0 to 9"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 denotes the lowest population range; 9 denotes the highest."},"children":[]}]}]}],"example":"9"},"rankDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the population for the geographical area in which this address is located."},"children":[]}]}]}],"example":"10961"},"rankDescription":{"type":"string","description":"A range of the population for the geographical area where the entity is located.","example":"500,000 +"}}}}},"locationOwnership":{"type":"object","description":"The details of the terms under which the entity occupies the premises.","properties":{"description":{"type":"string","description":"Description of the terms under which the entity occupies the premises (e.g., owned, rented, leased).","example":"Rents"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the terms under which the entity occupies the premises."},"children":[]}]}]}],"example":"1129"}}},"premisesArea":{"type":"object","description":"The details of space the entity utilizes at this address.","properties":{"measurement":{"type":"number","description":"A number portion of the amount to of space the entity occupies at this address (e.g., the 2000 in 2000 square meters).","example":"10034"},"unitDescription":{"type":"string","description":"The measurement unit used to express the premises area measurement (e.g., acre, square meters, square feet).","example":"square foot"},"unitDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the measurement unit used to express the premises area measurement."},"children":[]}]}]}],"example":"3848"},"reliabilityDescription":{"type":"string","description":"The accuracy of the measurement (e.g., actual, estimated, modeled).","example":"Actual"},"reliabilityDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the accuracy of the measurement."},"children":[]}]}]}],"example":"9092"}}},"isManufacturingLocation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if manufacturing activity is performed at this facility by the entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity performs manufacturing activity at this facility."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity does not perform manufacturing activity at this facility."},"children":[]}]}]}],"example":"true"}}}},"components/schemas/SubscriptionUpsert":{"id":"components/schemas/SubscriptionUpsert","kind":"json-schema","title":"SubscriptionUpsert","data":{"type":"object","description":"Subscription to be upserted.","properties":{"id":{"type":"string","description":"Uniquely identifying ID of the subscription.","example":"601ab61bc840f7000186cada"},"cdqId":{"$ref":"#/components/schemas/SubscriptionCdqId"},"types":{"type":"array","description":"List of subscription types.","items":{"$ref":"#/components/schemas/SubscriptionType"},"minItems":1,"uniqueItems":true}},"required":["cdqId","types"]}},"components/schemas/SubscriptionType":{"id":"components/schemas/SubscriptionType","kind":"json-schema","title":"SubscriptionType","data":{"type":"string","description":"Type of subscription.","example":"UPDATES","enum":["UPDATES"],"x-enumDescriptions":{"UPDATES":"Subscription for updates."}}},"components/schemas/SubscriptionFailureLog":{"id":"components/schemas/SubscriptionFailureLog","kind":"json-schema","title":"SubscriptionFailureLog","data":{"type":"object","description":"Log of failed subscription.","properties":{"cdqId":{"type":"string","description":"Unique identifier for the Business Partner.","example":"VIES:PL8660001429"},"message":{"type":"string","description":"Message describing the status of the request.","example":"Fail"}}}},"components/schemas/SubscriptionMetadataRequest":{"id":"components/schemas/SubscriptionMetadataRequest","kind":"json-schema","title":"SubscriptionMetadataRequest","data":{"type":"object","description":"Parameters for fetching subscription metadata.","properties":{"cdqId":{"type":"string","description":"Unique identifier for the Business Partner.","example":"VIES:PL8660001429"},"businessPartnerId":{"$ref":"#/components/schemas/BusinessPartnerId"}}}},"components/schemas/SubscriptionMetadata":{"id":"components/schemas/SubscriptionMetadata","kind":"json-schema","title":"SubscriptionMetadata","data":{"type":"object","description":"Metadata of a subscription.","properties":{"cdqId":{"type":"string","description":"Unique identifier for the Business Partner.","example":"VIES:PL8660001429"},"subscribed":{"type":"boolean","description":"Indicates if the subscription is subscribed.","example":"true"},"numberOfSubscribers":{"type":"integer","description":"Number of subscribers.","example":"50"}}}},"components/schemas/SubscriptionCdqId":{"id":"components/schemas/SubscriptionCdqId","kind":"json-schema","title":"SubscriptionCdqId","data":{"type":"string","description":"Unique CDQ ID of the subscription.","example":"CDQ.POOL:5E580DD08E8B454820E8F67E0"}},"components/schemas/BusinessPartnerIdentityLinkAddressVersion":{"id":"components/schemas/BusinessPartnerIdentityLinkAddressVersion","kind":"json-schema","title":"BusinessPartnerIdentityLinkAddressVersion","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":{"languageTechnicalKey":{"$ref":"#/components/schemas/LanguageTechnicalKey"},"characterSetTechnicalKey":{"$ref":"#/components/schemas/CharacterSetTechnicalKey"}}}},"components/schemas/LinkageStrategy":{"id":"components/schemas/LinkageStrategy","kind":"json-schema","title":"LinkageStrategy","data":{"type":"object","description":"Strategy for linking Business Partners from different Data Sources.","properties":{"externalContext":{"$ref":"#/components/schemas/LinkageStrategyExternalContext"}}}},"components/schemas/LinkageStrategyExternalContext":{"id":"components/schemas/LinkageStrategyExternalContext","kind":"json-schema","title":"LinkageStrategyExternalContext","data":{"type":"object","description":"External Context of a Linkage Strategy.","properties":{"identifiers":{"type":"array","description":"List of identifiers of the external context.","items":{"$ref":"#/components/schemas/LinkageStrategyExternalContextIdentifier"}}}}},"components/schemas/LinkageStrategyExternalContextIdentifier":{"id":"components/schemas/LinkageStrategyExternalContextIdentifier","kind":"json-schema","title":"LinkageStrategyExternalContextIdentifier","data":{"type":"object","description":"Identifier of the external context.","properties":{"type":{"$ref":"#/components/schemas/LinkageStrategyExternalContextIdentifierType"}}}},"components/schemas/LinkageStrategyExternalContextIdentifierType":{"id":"components/schemas/LinkageStrategyExternalContextIdentifierType","kind":"json-schema","title":"LinkageStrategyExternalContextIdentifierType","data":{"type":"object","description":"Type of the external context identifier.","properties":{"technicalKey":{"$ref":"#/components/schemas/ExternalContextIdentifierTypeTechnicalKey"}}}},"components/schemas/BusinessPartnerPropertyParam":{"id":"components/schemas/BusinessPartnerPropertyParam","kind":"json-schema","title":"BusinessPartnerPropertyParam","data":{"type":"string","description":"Part of a Business Partner concept. It describes a single attribute of a concept.","example":"MINORITY_INDICATOR_VALUE","enum":["NAME_VALUE","IDENTIFIER_VALUE","MINORITY_INDICATOR_VALUE","ADMINISTRATIVE_AREA_VALUE","LOCALITY_VALUE","POST_CODE_VALUE","THOROUGHFARE_VALUE","THOROUGHFARE_NUMBER","BUSINESS_PARTNER_STATUS_TYPE","LEGAL_FORM_NAME","RECORD"],"x-enumDescriptions":{"NAME_VALUE":"Value of Name of the Business Partner.","IDENTIFIER_VALUE":"Value of Identifier of the Business Partner","MINORITY_INDICATOR_VALUE":"Value of Minority indicator of the Business Partner.","ADMINISTRATIVE_AREA_VALUE":"Value of Administrative area of the Business Partner.","LOCALITY_VALUE":"Value of Locality of the Business Partner.","POST_CODE_VALUE":"Value of Post code of the Business Partner.","THOROUGHFARE_VALUE":"Value of Thoroughfare of the Business Partner.","THOROUGHFARE_NUMBER":"Thoroughfare number of the Business Partner.","BUSINESS_PARTNER_STATUS_TYPE":"Status of the Business Partner.","LEGAL_FORM_NAME":"Legal form of the Business Partner.","RECORD":"Record status of the Business Partner."}}},"components/schemas/JobTagsList":{"id":"components/schemas/JobTagsList","kind":"json-schema","title":"JobTagsList","data":{"type":"array","description":"List of tags.","maxItems":10,"items":{"$ref":"#/components/schemas/JobTag"}}},"components/schemas/JobTags":{"id":"components/schemas/JobTags","kind":"json-schema","title":"JobTags","data":{"type":"array","description":"List of tags.","maxItems":10,"uniqueItems":true,"items":{"$ref":"#/components/schemas/JobTag"}}},"components/schemas/JobTag":{"id":"components/schemas/JobTag","kind":"json-schema","title":"JobTag","data":{"type":"string","maxLength":100,"description":"Job Tag to be used for filtering.","example":"tag1"}},"components/schemas/UpdateMonitorDataSourcesResult":{"id":"components/schemas/UpdateMonitorDataSourcesResult","kind":"json-schema","title":"UpdateMonitorDataSourcesResult","data":{"type":"object","description":"Result of the Update Monitor Data Sources operation.","properties":{"dataSources":{"type":"array","description":"List of Data Sources.","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}}}}},"components/schemas/ToggleUpdateMonitoringRequest":{"id":"components/schemas/ToggleUpdateMonitoringRequest","kind":"json-schema","title":"ToggleUpdateMonitoringRequest","data":{"type":"object","description":"Parameters for Toggle Update Monitoring job.","required":["enable","businessPartnerIds"],"properties":{"enable":{"$ref":"#/components/schemas/ToggleUpdateMonitoringRequestEnable"},"businessPartnerIds":{"type":"array","description":"List of Business Partner IDs to identify all those Business Partners that should be activated/deactivated.","minItems":1,"maxItems":1000,"items":{"$ref":"#/components/schemas/BusinessPartnerId"}}}}},"components/schemas/ToggleUpdateMonitoringRequestEnable":{"id":"components/schemas/ToggleUpdateMonitoringRequestEnable","kind":"json-schema","title":"ToggleUpdateMonitoringRequestEnable","data":{"type":"boolean","description":"Parameter to describe if the Business Partners should be activated for update monitoring (true) or deactivated (false) for non-commercial reference data sources.","example":"true"}},"components/schemas/DataMonitor":{"id":"components/schemas/DataMonitor","kind":"json-schema","title":"DataMonitor","data":{"type":"object","description":"A monitoring service that can be activated for a Data Storage/Data Mirror.","properties":{"id":{"$ref":"#/components/schemas/DataMonitorId"},"type":{"$ref":"#/components/schemas/DataMonitorType"},"dataSources":{"type":"array","description":"List of Data Sources.","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSource"}},"enabled":{"$ref":"#/components/schemas/DataMonitorToggle"},"disabledAt":{"$ref":"#/components/schemas/DataMonitorDisabledAt"},"configuration":{"$ref":"#/components/schemas/DataMonitorConfiguration"},"executions":{"type":"array","description":"Available executions of data monitor.","items":{"$ref":"#/components/schemas/DataMonitorExecution"}},"validitySpan":{"$ref":"#/components/schemas/DataMonitorValiditySpan"},"scopes":{"type":"array","description":"Scope of data monitor.","items":{"$ref":"#/components/schemas/DataMonitorScope"}},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"modifiedBy":{"$ref":"#/components/schemas/ModifiedBy"},"featuresOn":{"type":"array","description":"Features to be activated for Data Monitor.","items":{"$ref":"#/components/schemas/DataMonitorFeature"}}}}},"components/schemas/DataMonitorCreate":{"id":"components/schemas/DataMonitorCreate","kind":"json-schema","title":"DataMonitorCreate","data":{"type":"object","description":"Create a new Data Monitor.","required":["type","dataSources","executions"],"properties":{"type":{"$ref":"#/components/schemas/DataMonitorTypeParam"},"dataSources":{"type":"array","description":"List of Data Sources.","minItems":1,"maxItems":7,"items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceParam"}},"enabled":{"$ref":"#/components/schemas/DataMonitorToggle"},"configuration":{"$ref":"#/components/schemas/DataMonitorConfigurationParam"},"executions":{"type":"array","description":"Available executions of data monitor.","minItems":1,"items":{"$ref":"#/components/schemas/DataMonitorExecutionParam"}},"validitySpan":{"$ref":"#/components/schemas/DataMonitorValiditySpanParam"},"scopes":{"type":"array","description":"Scope to be enabled for monitor.","items":{"$ref":"#/components/schemas/DataMonitorScope"}}}}},"components/schemas/DataMonitorTypeParam":{"id":"components/schemas/DataMonitorTypeParam","kind":"json-schema","title":"DataMonitorTypeParam","data":{"type":"object","description":"Type of the Data Monitor.","required":["technicalKey"],"properties":{"technicalKey":{"$ref":"#/components/schemas/DataMonitorTypeTechnicalKeyEnum"}}}},"components/schemas/DataMonitorUpdate":{"id":"components/schemas/DataMonitorUpdate","kind":"json-schema","title":"DataMonitorUpdate","data":{"type":"object","description":"Data Monitor definition that is to be updated.\n\nNote: updating Data Monitor will overwrite all its available properties.\n","required":["dataSources","executions"],"properties":{"dataSources":{"type":"array","description":"List of Data Sources.","minItems":1,"maxItems":7,"items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceParam"}},"enabled":{"$ref":"#/components/schemas/DataMonitorToggle"},"configuration":{"$ref":"#/components/schemas/DataMonitorConfigurationParam"},"executions":{"type":"array","description":"Available executions of data monitor.","minItems":1,"items":{"$ref":"#/components/schemas/DataMonitorExecutionParam"}},"validitySpan":{"$ref":"#/components/schemas/DataMonitorValiditySpanParam"},"scopes":{"type":"array","description":"Scope to be enabled for monitor.","items":{"$ref":"#/components/schemas/DataMonitorScope"}},"featuresOn":{"type":"array","description":"Features to be activated for Data Monitor.","items":{"$ref":"#/components/schemas/DataMonitorUpdateFeatureParam"}}}}},"components/schemas/DataMonitorsPage":{"id":"components/schemas/DataMonitorsPage","kind":"json-schema","title":"DataMonitorsPage","data":{"type":"object","description":"Page with listed Data Monitors.","properties":{"values":{"type":"array","description":"List of Data Monitors.","items":{"$ref":"#/components/schemas/DataMonitorSearchResult"}},"limit":{"$ref":"#/components/schemas/Limit"},"startAfter":{"$ref":"#/components/schemas/StartAfter"},"nextStartAfter":{"$ref":"#/components/schemas/NextStartAfter"},"total":{"$ref":"#/components/schemas/PageTotal"}}}},"components/schemas/DataMonitorSearchResult":{"id":"components/schemas/DataMonitorSearchResult","kind":"json-schema","title":"DataMonitorSearchResult","data":{"type":"object","description":"Data Monitor search result.","properties":{"id":{"$ref":"#/components/schemas/DataMonitorId"},"type":{"$ref":"#/components/schemas/DataMonitorType"},"dataSources":{"type":"array","description":"List of Data Sources.","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSource"}},"enabled":{"$ref":"#/components/schemas/DataMonitorToggle"},"disabledAt":{"$ref":"#/components/schemas/DataMonitorDisabledAt"},"configuration":{"$ref":"#/components/schemas/DataMonitorConfiguration"},"executions":{"type":"array","description":"Available executions of data monitor.","items":{"$ref":"#/components/schemas/DataMonitorExecution"}},"validitySpan":{"$ref":"#/components/schemas/DataMonitorValiditySpan"},"scopes":{"type":"array","description":"Scope of data monitor.","items":{"$ref":"#/components/schemas/DataMonitorScope"}},"createdAt":{"$ref":"#/components/schemas/CreatedAt"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"modifiedAt":{"$ref":"#/components/schemas/ModifiedAt"},"modifiedBy":{"$ref":"#/components/schemas/ModifiedBy"},"featuresOn":{"type":"array","description":"Features to be activated for Data Monitor.","items":{"$ref":"#/components/schemas/DataMonitorFeature"}},"storageId":{"$ref":"#/components/schemas/BusinessPartnerStorageId"}}}},"components/schemas/DataMonitorDisabledAt":{"id":"components/schemas/DataMonitorDisabledAt","kind":"json-schema","title":"DataMonitorDisabledAt","data":{"type":"string","description":"Date in ISO-8601 format when data monitor was disabled.","example":"2026-10-21T13:37:18Z"}},"components/schemas/BusinessPartnerStorageDataSource":{"id":"components/schemas/BusinessPartnerStorageDataSource","kind":"json-schema","title":"BusinessPartnerStorageDataSource","data":{"type":"object","description":"A sub-container of Data Storage/Data Mirror. Few data sources can have different data, mappings, and data monitors within the same data mirror.","properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"name":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceName"}}}},"components/schemas/BusinessPartnerStorageDataSourceParam":{"id":"components/schemas/BusinessPartnerStorageDataSourceParam","kind":"json-schema","title":"BusinessPartnerStorageDataSourceParam","data":{"type":"object","description":"A sub-container of Data Storage/Data Mirror. Few data sources can have different data, mappings, and data monitors within the same data mirror.","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}}}},"components/schemas/DataMonitorType":{"id":"components/schemas/DataMonitorType","kind":"json-schema","title":"DataMonitorType","data":{"type":"object","description":"Type of the Data Monitor.","properties":{"name":{"$ref":"#/components/schemas/DataMonitorTypeName"},"technicalKey":{"$ref":"#/components/schemas/DataMonitorTypeTechnicalKey"}}}},"components/schemas/DataMonitorTypeTechnicalKeyEnum":{"id":"components/schemas/DataMonitorTypeTechnicalKeyEnum","kind":"json-schema","title":"DataMonitorTypeTechnicalKeyEnum","data":{"type":"string","description":"Technical key of a data monitor.","example":"AUGMENTATION","enum":["AUGMENTATION","DATA_QUALITY_PROFILING","SCREENING","DUPLICATE","QUALIFICATION"],"x-enumDescriptions":{"AUGMENTATION":"Augmentation monitor returning Augmented Business Partner as a result of the curation process and raw updates from Reference Data Sources.","DATA_QUALITY_PROFILING":"Data validation monitor based on the customer-provided configuration, providing a list of data defects for monitored business partners.","SCREENING":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor for sanction & watchlist screening processes."},"children":[]}]}]}],"DUPLICATE":"Monitoring detecting duplicates in customer data sources.","QUALIFICATION":"Monitor for Tax Guard qualification processes."}}},"components/schemas/DataMonitorConfigurationParam":{"id":"components/schemas/DataMonitorConfigurationParam","kind":"json-schema","title":"DataMonitorConfigurationParam","data":{"type":"object","description":"Configuration which is used during processing Business Partners.","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/ConfigurationId"}}}},"components/schemas/DataMonitorConfiguration":{"id":"components/schemas/DataMonitorConfiguration","kind":"json-schema","title":"DataMonitorConfiguration","data":{"type":"object","description":"Configuration which is used during processing Business Partners.","properties":{"id":{"$ref":"#/components/schemas/ConfigurationId"}}}},"components/schemas/DnbStorageTechnicalKeyParam":{"id":"components/schemas/DnbStorageTechnicalKeyParam","kind":"json-schema","title":"DnbStorageTechnicalKeyParam","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 that describes what kind if D&B storage it is."},"children":[]}]}]}],"example":"DNB_MASTER_DATA_BASIC","enum":["DNB","DNB_MASTER_DATA_BASIC","DNB_MASTER_DATA_MGMT","DNB_MASTER_DATA_LNKG","DNB_MASTER_DATA_EXTENDED","DNB_LINKAGE_LNKELI"],"x-enumDescriptions":{"DNB":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Storage for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Profile, Linkage, and Executives"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (CMPELK)"},"children":[]}]}]}],"DNB_MASTER_DATA_BASIC":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Storage for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master Data Basic"},"children":[]}]}]}]}],"DNB_MASTER_DATA_MGMT":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Storage for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master Data Mgmt"},"children":[]}]}]}]}],"DNB_MASTER_DATA_LNKG":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Storage for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master Data Lnkg"},"children":[]}]}]}]}],"DNB_MASTER_DATA_EXTENDED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Storage for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master Data Extended"},"children":[]}]}]}]}],"DNB_LINKAGE_LNKELI":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Storage for D&B data product "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extended Linkage Insight"},"children":[]}]}]}]}]}}},"components/schemas/DnbStorageTechnicalKey":{"id":"components/schemas/DnbStorageTechnicalKey","kind":"json-schema","title":"DnbStorageTechnicalKey","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 that describes what kind if D&B storage it is."},"children":[]}]}]}],"example":"DNB_MASTER_DATA_BASIC"}},"components/schemas/ReadSubscriptionsFeatureParam":{"id":"components/schemas/ReadSubscriptionsFeatureParam","kind":"json-schema","title":"ReadSubscriptionsFeatureParam","data":{"type":"string","description":"Feature to be used when reading subscriptions.","example":"TOTAL_UNIQUE_CDQ_IDS","enum":["TOTAL_UNIQUE_CDQ_IDS"],"x-enumDescriptions":{"TOTAL_UNIQUE_CDQ_IDS":"Total number of subscriptions unique by cdqId."}}},"components/schemas/ReferenceDataStorageCreateFeature":{"id":"components/schemas/ReferenceDataStorageCreateFeature","kind":"json-schema","title":"ReferenceDataStorageCreateFeature","data":{"type":"string","description":"Feature for reference data storage creation.","example":"LAB_UPDATED_BUSINESS_PARTNER"}},"components/schemas/UpdateMonitoringReferenceDataSourcesReadFeatureParam":{"id":"components/schemas/UpdateMonitoringReferenceDataSourcesReadFeatureParam","kind":"json-schema","title":"UpdateMonitoringReferenceDataSourcesReadFeatureParam","data":{"type":"string","description":"The feature to be used for the read request.","example":"FETCH_ACTIVATION_STATUS","enum":["FETCH_ACTIVATION_STATUS"],"x-enumDescriptions":{"FETCH_ACTIVATION_STATUS":"Returns information which data source is inactive for the organization."}}},"components/schemas/BusinessPartnerEventStoreRollRequest":{"id":"components/schemas/BusinessPartnerEventStoreRollRequest","kind":"json-schema","title":"BusinessPartnerEventStoreRollRequest","data":{"type":"object","description":"Request to roll the event store for a Business Partner Storage.","properties":{"featuresOn":{"type":"array","description":"Features to be activated when rolling the event store.","items":{"$ref":"#/components/schemas/BusinessPartnerEventStoreRollFeatureParam"}}}}},"components/schemas/BusinessPartnerEventStoreRollFeatureParam":{"id":"components/schemas/BusinessPartnerEventStoreRollFeatureParam","kind":"json-schema","title":"BusinessPartnerEventStoreRollFeatureParam","data":{"type":"string","description":"Event store roll feature.","example":"FORCE_DNB_ROLL","enum":["FORCE_DNB_ROLL"],"x-enumDescriptions":{"FORCE_DNB_ROLL":"Forces roll of DNB storage."}}},"components/schemas/BusinessPartnerEventStoreRollResult":{"id":"components/schemas/BusinessPartnerEventStoreRollResult","kind":"json-schema","title":"BusinessPartnerEventStoreRollResult","data":{"type":"object","description":"Result of rolling event store for Business Partner Storage.","properties":{"status":{"$ref":"#/components/schemas/Status"},"newEventStoreId":{"$ref":"#/components/schemas/EventStoreId"},"previousEventStoreId":{"$ref":"#/components/schemas/PreviousEventStoreId"}}}},"components/schemas/DataMonitorCreateFeatureParam":{"id":"components/schemas/DataMonitorCreateFeatureParam","kind":"json-schema","title":"DataMonitorCreateFeatureParam","data":{"type":"string","description":"Features modifying way of creating Data Monitor.","example":"LAB_USE_CLIENT_ID","enum":["LAB_USE_CLIENT_ID"]}},"components/schemas/StorageDataMonitorsReadFeatureParam":{"id":"components/schemas/StorageDataMonitorsReadFeatureParam","kind":"json-schema","title":"StorageDataMonitorsReadFeatureParam","data":{"type":"string","description":"Features modifying way of reading Data Monitors.","example":"NUMBER_OF_TOTAL","enum":["NUMBER_OF_TOTAL"],"x-enumDescriptions":{"NUMBER_OF_TOTAL":"Returns the total number of data monitors."}}},"components/schemas/DataMonitorsReadFeatureParam":{"id":"components/schemas/DataMonitorsReadFeatureParam","kind":"json-schema","title":"DataMonitorsReadFeatureParam","data":{"type":"string","description":"Features modifying way of reading Data Monitors.","example":"NUMBER_OF_TOTAL","enum":["NUMBER_OF_TOTAL"],"x-enumDescriptions":{"NUMBER_OF_TOTAL":"Returns the total number of data monitors."}}},"components/schemas/DataMonitorValiditySpanParam":{"id":"components/schemas/DataMonitorValiditySpanParam","kind":"json-schema","title":"DataMonitorValiditySpanParam","data":{"type":"object","description":"Period after which Business Partner is evaluated again.\n","properties":{"technicalKey":{"$ref":"#/components/schemas/DataMonitorValiditySpanTechnicalKeyParam"}}}},"components/schemas/DataMonitorValiditySpan":{"id":"components/schemas/DataMonitorValiditySpan","kind":"json-schema","title":"DataMonitorValiditySpan","data":{"type":"object","description":"Period after which Business Partner is evaluated again.\n","properties":{"technicalKey":{"$ref":"#/components/schemas/DataMonitorValiditySpanTechnicalKey"}}}},"components/schemas/DataMonitorValiditySpanTechnicalKeyParam":{"id":"components/schemas/DataMonitorValiditySpanTechnicalKeyParam","kind":"json-schema","title":"DataMonitorValiditySpanTechnicalKeyParam","data":{"type":"string","description":"Validity span period.","example":"YEAR","enum":["HALF_YEAR","QUARTER","YEAR"],"x-enumDescriptions":{"HALF_YEAR":"6 months validity span","QUARTER":"3 months validity span","YEAR":"Year validity span"}}},"components/schemas/DataMonitorValiditySpanTechnicalKey":{"id":"components/schemas/DataMonitorValiditySpanTechnicalKey","kind":"json-schema","title":"DataMonitorValiditySpanTechnicalKey","data":{"type":"string","description":"Validity span period.","example":"YEAR","x-enumDescriptions":{"HALF_YEAR":"6 months validity span","QUARTER":"3 months validity span","YEAR":"Year validity span"}}},"components/schemas/DataMonitorPopulationJob":{"id":"components/schemas/DataMonitorPopulationJob","kind":"json-schema","title":"DataMonitorPopulationJob","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last job that was scheduled during:"},"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":"data monitor creation,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit of configurationId in data monitor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in order to populate data monitor."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/JobId"}}}},"components/schemas/DataMonitorFeature":{"id":"components/schemas/DataMonitorFeature","kind":"json-schema","title":"DataMonitorFeature","data":{"type":"string","description":"Feature of a Data Monitor.","example":"BUILD_REPORT"}},"components/schemas/DataMonitorFeatureParam":{"id":"components/schemas/DataMonitorFeatureParam","kind":"json-schema","title":"DataMonitorFeatureParam","data":{"type":"string","description":"Feature of a Data Monitor.","example":"BUILD_REPORT","enum":["BUILD_REPORT"],"x-enumDescriptions":{"BUILD_REPORT":"Builds report for data monitor when it has JOB execution type. No longer operational."}}},"components/schemas/DataMonitorUpdateFeatureParam":{"id":"components/schemas/DataMonitorUpdateFeatureParam","kind":"json-schema","title":"DataMonitorUpdateFeatureParam","data":{"type":"string","description":"Feature of a Data Monitor.","example":"REEVALUATION_ON_CHANGES","enum":["BUILD_REPORT","REEVALUATION_ON_CHANGES"],"x-enumDescriptions":{"REEVALUATION_ON_CHANGES":"Re-evaluates business partners based on changes in the configuration. This feature is not persisted."}}},"components/schemas/DataMonitorRefreshes":{"id":"components/schemas/DataMonitorRefreshes","kind":"json-schema","title":"DataMonitorRefreshes","data":{"type":"object","description":"List of data monitor refreshes.","properties":{"dataMonitors":{"type":"array","description":"List of Data Monitors.","maxItems":1,"items":{"$ref":"#/components/schemas/DataMonitorRefresh"}}}}},"components/schemas/DataMonitorRefresh":{"id":"components/schemas/DataMonitorRefresh","kind":"json-schema","title":"DataMonitorRefresh","data":{"type":"object","description":"Data Monitor refresh.","properties":{"id":{"$ref":"#/components/schemas/DataMonitorId"}}}},"components/schemas/DataMonitorRefreshResults":{"id":"components/schemas/DataMonitorRefreshResults","kind":"json-schema","title":"DataMonitorRefreshResults","data":{"type":"object","description":"Result of Data Monitor refresh.","properties":{"dataMonitors":{"type":"array","description":"List of Data Monitors.","items":{"$ref":"#/components/schemas/DataMonitorRefreshResult"}}}}},"components/schemas/DataMonitorRefreshResult":{"id":"components/schemas/DataMonitorRefreshResult","kind":"json-schema","title":"DataMonitorRefreshResult","data":{"type":"object","description":"Result of Data Monitor reevaluation.","properties":{"dataMonitor":{"$ref":"#/components/schemas/DataMonitorRefresh"},"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 - the data monitor reevaluation has been started"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND - the data monitor is not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APPLICATION_IN_PROGRESS - the data monitor reevaluation is not started because of currently running reevaluation"},"children":[]}]}]}]}],"example":"APPLICATION_IN_PROGRESS"}}}},"components/schemas/DataMonitorWithPopulationJob":{"id":"components/schemas/DataMonitorWithPopulationJob","kind":"json-schema","title":"DataMonitorWithPopulationJob","data":{"type":"object","description":"Data monitor with population job.","properties":{"id":{"$ref":"#/components/schemas/DataMonitorId"},"populationJob":{"$ref":"#/components/schemas/DataMonitorPopulationJob"}}}},"components/schemas/DataMonitorProgressResult":{"id":"components/schemas/DataMonitorProgressResult","kind":"json-schema","title":"DataMonitorProgressResult","data":{"type":"object","description":"Data Monitor Progress for different processing statuses.","properties":{"status":{"$ref":"#/components/schemas/Status"},"total":{"description":"Total number of considered Business Partners.","$ref":"#/components/schemas/DataMonitorProgressTotal"},"scope":{"$ref":"#/components/schemas/DataMonitorScope"},"processingStatuses":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStatusProgress"}}}}},"components/schemas/ProcessingStatusProgress":{"id":"components/schemas/ProcessingStatusProgress","kind":"json-schema","title":"ProcessingStatusProgress","data":{"type":"object","description":"Progress of specific processing status.","properties":{"processingStatus":{"$ref":"#/components/schemas/ProcessingStatusTechnicalKey"},"progress":{"$ref":"#/components/schemas/DataMonitorProcessingStatusProgress"}}}},"components/schemas/DataMonitorProcessingStatusProgress":{"id":"components/schemas/DataMonitorProcessingStatusProgress","kind":"json-schema","title":"DataMonitorProcessingStatusProgress","data":{"type":"object","description":"Progress of specific status.","properties":{"total":{"$ref":"#/components/schemas/DataMonitorProgressTotal"},"percentage":{"$ref":"#/components/schemas/DataMonitorProgressPercentage"}}}},"components/schemas/DataMonitorProgressTotal":{"id":"components/schemas/DataMonitorProgressTotal","kind":"json-schema","title":"DataMonitorProgressTotal","data":{"type":"integer","format":"int64","description":"Total number of Business Partners per processing status.","example":"1001"}},"components/schemas/DataMonitorProgressPercentage":{"id":"components/schemas/DataMonitorProgressPercentage","kind":"json-schema","title":"DataMonitorProgressPercentage","data":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage (%) of number of Business Partners per processing status to all Business Partners in Data Monitor."},"children":[]}]}]}],"example":"85"}},"components/schemas/DataMonitorExecutionParam":{"id":"components/schemas/DataMonitorExecutionParam","kind":"json-schema","title":"DataMonitorExecutionParam","data":{"type":"object","description":"Execution of Data Monitor. Frequency required and only allowed in JOB execution type.","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/DataMonitorExecutionTypeParam"},"frequency":{"$ref":"#/components/schemas/DataMonitorFrequencyEnum"}}}},"components/schemas/DataMonitorExecutionTypeParam":{"id":"components/schemas/DataMonitorExecutionTypeParam","kind":"json-schema","title":"DataMonitorExecutionTypeParam","data":{"type":"object","description":"Type of the Data Monitor Execution.","required":["technicalKey"],"properties":{"technicalKey":{"$ref":"#/components/schemas/DataMonitorExecutionTypeTechnicalKeyEnum"}}}},"components/schemas/DataMonitorScope":{"id":"components/schemas/DataMonitorScope","kind":"json-schema","title":"DataMonitorScope","data":{"type":"object","description":"Identifies scope for Data Monitor.","properties":{"technicalKey":{"$ref":"#/components/schemas/DataMonitorScopeTechnicalKey"}}}},"components/schemas/DataMonitorScopeTechnicalKey":{"id":"components/schemas/DataMonitorScopeTechnicalKey","kind":"json-schema","title":"DataMonitorScopeTechnicalKey","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Monitor scope of selected products."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Augmentation Data Monitor may be one of:"},"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":"AUGMENTED_BUSINESS_PARTNERS - enables Business Partner Augmentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RAW_UPDATES - enables Raw Updates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OVERLAP - enables Overlap"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, when empty in Augmentation Data Monitor, below are enabled:"},"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":"AUGMENTED_BUSINESS_PARTNERS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RAW_UPDATES"},"children":[]}]}]}]}],"example":"RAW_UPDATES"}},"components/schemas/DataMonitorProgressFeatureParam":{"id":"components/schemas/DataMonitorProgressFeatureParam","kind":"json-schema","title":"DataMonitorProgressFeatureParam","data":{"type":"string","description":"Features for Data Monitor Progress.","example":"CACHE","enum":["CACHE"]}},"components/schemas/DataMonitorExecution":{"id":"components/schemas/DataMonitorExecution","kind":"json-schema","title":"DataMonitorExecution","data":{"type":"object","description":"Specifies how data monitors will be executed.","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/DataMonitorExecutionType"},"frequency":{"$ref":"#/components/schemas/DataMonitorFrequency"}}}},"components/schemas/DataMonitorClientId":{"id":"components/schemas/DataMonitorClientId","kind":"json-schema","title":"DataMonitorClientId","data":{"type":"string","description":"Client ID of the data monitor.","example":"12345678-1234-5678-1234-567812345678"}},"components/schemas/DataMonitorExecutionType":{"id":"components/schemas/DataMonitorExecutionType","kind":"json-schema","title":"DataMonitorExecutionType","data":{"type":"object","description":"Type of the Data Monitor Execution.","required":["technicalKey"],"properties":{"technicalKey":{"$ref":"#/components/schemas/DataMonitorExecutionTypeTechnicalKey"}}}},"components/schemas/UpdateMonitorReferenceDataSourcesResult":{"id":"components/schemas/UpdateMonitorReferenceDataSourcesResult","kind":"json-schema","title":"UpdateMonitorReferenceDataSourcesResult","data":{"type":"object","description":"Update Monitor Reference Data Sources Result.","properties":{"referenceDataSources":{"type":"array","description":"List of Reference Data Sources.","items":{"$ref":"#/components/schemas/ReferenceDataSource"}}}}},"components/schemas/ReferenceDataSource":{"id":"components/schemas/ReferenceDataSource","kind":"json-schema","title":"ReferenceDataSource","data":{"type":"object","description":"Reference Data Source.","properties":{"aleiPrefix":{"type":"string","description":"The monitored Reference Data Source.","example":"VIES"},"technicalKey":{"type":"string","description":"Technical key of the Reference Data Source.","example":"VIES"},"activationStatus":{"type":"string","description":"Indicates whether the data source is active or inactive for the organization.","example":"ACTIVE"}}}},"components/schemas/BusinessPartnerStorageFeatureUpdateParam":{"id":"components/schemas/BusinessPartnerStorageFeatureUpdateParam","kind":"json-schema","title":"BusinessPartnerStorageFeatureUpdateParam","data":{"type":"string","description":"Available features of a storage.","example":"UPDATED_BUSINESS_PARTNER_ONLY","enum":["LAB_UPDATED_BUSINESS_PARTNER","TAGS_MANAGED_BY_UPSERT","UPDATED_BUSINESS_PARTNER_ONLY","SYSTEM","MONITOR"],"x-enumDescruptions":{"LAB_UPDATED_BUSINESS_PARTNER":"V4 and V5 updates working together.","TAGS_MANAGED_BY_UPSERT":"Tags are accepted from upsert, not via dedicated endpoints. Allowed only when storage does not have HOMELAND activated.","UPDATED_BUSINESS_PARTNER_ONLY":"V5 updates, V4 disabled.","SYSTEM":"Storage, that is indexing data to reference data index. Typically, reference data source.","MONITOR":"Storage containing data, that can be monitored. Typically, reference data source."}}},"components/schemas/BusinessPartnerStorageMetadataPatchField":{"id":"components/schemas/BusinessPartnerStorageMetadataPatchField","kind":"json-schema","title":"BusinessPartnerStorageMetadataPatchField","data":{"type":"string","description":"Field to be unset during storage metadata patch.","example":"decisionLogId"}},"components/schemas/BusinessPartnerStorageFeatureOffUpdateParam":{"id":"components/schemas/BusinessPartnerStorageFeatureOffUpdateParam","kind":"json-schema","title":"BusinessPartnerStorageFeatureOffUpdateParam","data":{"type":"string","description":"Available features of a storage, that can be deactivated.","example":"TAGS_MANAGED_BY_UPSERT","enum":["TAGS_MANAGED_BY_UPSERT","UPDATED_BUSINESS_PARTNER_ONLY","LAB_UPDATED_BUSINESS_PARTNER"],"x-enumDescruptions":{"TAGS_MANAGED_BY_UPSERT":"Tags are accepted from upsert, not via dedicated endpoints. Allowed only when storage does not have HOMELAND activated.","UPDATED_BUSINESS_PARTNER_ONLY":"V5 updates, V4 disabled.","LAB_UPDATED_BUSINESS_PARTNER":"V4 and V5 updates working together."}}},"components/schemas/PreviousEventStoreId":{"id":"components/schemas/PreviousEventStoreId","kind":"json-schema","title":"PreviousEventStoreId","data":{"type":"string","description":"Internal ID of the event store that preceded the current one. It was created while event store roll.","example":"72d6900fce6b326123f5d9d91049e3e6"}},"components/schemas/DecisionLogId":{"id":"components/schemas/DecisionLogId","kind":"json-schema","title":"DecisionLogId","data":{"type":"string","description":"ID of related decision log.","example":"72d6900fc3wb326088f5d9d91044e3e6"}},"components/schemas/BusinessPartnerExternalIdParam":{"id":"components/schemas/BusinessPartnerExternalIdParam","kind":"json-schema","title":"BusinessPartnerExternalIdParam","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Arbitrary identifier type to mark customer IDs that are \"external\"\\ \\ from CDQ's perspective. This is the identifier a customer provides to identify\\ \\ its records."},"children":[]}]}]}],"example":"The ID managed in the customer's SAP systems.","minLength":1}},"components/schemas/FetchBusinessPartnerStatus":{"id":"components/schemas/FetchBusinessPartnerStatus","kind":"json-schema","title":"FetchBusinessPartnerStatus","data":{"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":" - Business Partner 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":" - Business Partner with that externalId+dataSource does not exist in storage."},"children":[]}]}]}]}],"example":"NOT_FOUND"}},"components/schemas/FetchBusinessPartnerMessage":{"id":"components/schemas/FetchBusinessPartnerMessage","kind":"json-schema","title":"FetchBusinessPartnerMessage","data":{"type":"string","description":"Detailed information about the status.","example":"Business Partner has been fetched successfully."}},"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/SharingStatusDescription":{"id":"components/schemas/SharingStatusDescription","kind":"json-schema","title":"SharingStatusDescription","data":{"type":"string","description":"A description of the sharing status. This is a human-readable description of the sharing status.","example":"UNDER_CONSIDERATION: The business partner will be considered for the sharing process."}},"components/schemas/IdentityLink":{"id":"components/schemas/IdentityLink","kind":"json-schema","title":"IdentityLink","data":{"type":"object","description":"Information about which BP in the sharing POOL was linked.","properties":{"linkId":{"type":"string","description":"Unique identifier for the link between the business partner and the sharing pool.","example":"6465f2492bdcd350159a79d6"},"cdqId":{"type":"string","description":"Unique identifier for the Business Partner.","example":"VIES:PL8660001429"},"addressId":{"type":"string","description":"Unique identifier for the address which was used for the linkage in the POOL.","example":"0"},"externalAddressId":{"type":"string","description":"Unique identifier from an external source for the address which was used for the linkage in the POOL.","example":"123456789"},"status":{"$ref":"#/components/schemas/IdentityLinkStatus"}}}},"components/schemas/IdentityLinkStatus":{"id":"components/schemas/IdentityLinkStatus","kind":"json-schema","title":"IdentityLinkStatus","data":{"type":"object","description":"Status of the identity link.","properties":{"details":{"type":"array","items":{"$ref":"#/components/schemas/IdentityLinkStatusDetail"}}}}},"components/schemas/IdentityLinkStatusDetail":{"id":"components/schemas/IdentityLinkStatusDetail","kind":"json-schema","title":"IdentityLinkStatusDetail","data":{"type":"object","description":"Detail of the identity link status.","properties":{"technicalKey":{"$ref":"#/components/schemas/IdentityLinkStatusDetailTechnicalKey"}}}},"components/schemas/IdentityLinkStatusDetailTechnicalKey":{"id":"components/schemas/IdentityLinkStatusDetailTechnicalKey","kind":"json-schema","title":"IdentityLinkStatusDetailTechnicalKey","data":{"type":"string","description":"Technical key of the identity link status detail.","example":"BUSINESS_PARTNER_TYPE_MISMATCH"}},"components/schemas/IdentityLinkStatusDetailMessage":{"id":"components/schemas/IdentityLinkStatusDetailMessage","kind":"json-schema","title":"IdentityLinkStatusDetailMessage","data":{"type":"string","description":"Message of the identity link status detail.","example":"Business partner types do not match."}},"components/schemas/Provenance":{"id":"components/schemas/Provenance","kind":"json-schema","title":"Provenance","data":{"type":"object","description":"The source of the change/update. Could be the reference data source as VIES or Organization.","properties":{"name":{"$ref":"#/components/schemas/ProvenanceName"},"technicalKey":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"}}}},"components/schemas/BusinessPartnersTransformationRequest":{"id":"components/schemas/BusinessPartnersTransformationRequest","kind":"json-schema","title":"BusinessPartnersTransformationRequest","data":{"type":"object","description":"Request to transform raw data to CDQ data model.","properties":{"businessPartners":{"type":"array","description":"List of Business Partners.","items":{"$ref":"#/components/schemas/BusinessPartnerId"}}}}},"components/schemas/FieldBusinessPartner":{"id":"components/schemas/FieldBusinessPartner","kind":"json-schema","title":"FieldBusinessPartner","data":{"type":"object","description":"A list of transformed Business Partners with their properties.","properties":{"fields":{"type":"array","description":"List of fields.","items":{"$ref":"#/components/schemas/Field"}}}}},"components/schemas/Field":{"id":"components/schemas/Field","kind":"json-schema","title":"Field","data":{"type":"object","description":"Key-value pair of a single Business Partner's property.","properties":{"key":{"type":"string","description":"The key represents the property name.","example":"ADDRESS"},"value":{"type":"string","description":"The value of the key.","example":"Lukasstrasse 4, 9008 St. Gallen, Switzerland"}}}},"components/schemas/UpdateDisclosureRequest":{"id":"components/schemas/UpdateDisclosureRequest","kind":"json-schema","title":"UpdateDisclosureRequest","data":{"type":"object","description":"Parameters for Update Disclosure job.","required":["disclosed"],"properties":{"disclosed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter to describe if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BusinessPartners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be disclosed ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or undisclosed ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MARKED_FOR_DELETION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Business Partner profile tag overrides disclosure. Business Partners with this tag are not shared, regardless of the disclosed value."},"children":[]}]}]}]}],"example":"true"},"dataSourceId":{"deprecated":true,"type":"string","description":"A DataSource ID for which all related BusinessPartners should be un-/disclose.","example":"648824a691d8d2503d65103e"},"countryCode":{"deprecated":true,"type":"string","description":"A country code (ISO 3166-2), to be used in combination with a DataSource ID to un-/disclose all matching BusinessPartners.","example":"DE"},"businessPartnerIds":{"type":"array","description":"List of BusinessPartner IDs to identify all those BusinessPartners that should be un-/disclose.","minLength":1,"items":{"$ref":"#/components/schemas/BusinessPartnerId"}}}}},"components/schemas/BusinessPartnerStorageFeatureParam":{"id":"components/schemas/BusinessPartnerStorageFeatureParam","kind":"json-schema","title":"BusinessPartnerStorageFeatureParam","data":{"type":"string","description":"Available features of a storage.","example":"LOOKUP","enum":["LOOKUP","UPDATES","LAB_USE_INDEX_API","SHARING","DATA_MIRROR","HOMELAND","NEVER_EXPIRE","RELATIONS","TAGS_MANAGED_BY_UPSERT"],"x-enumDescriptions":{"LOOKUP":"Enables search capabilities for the given storage.","UPDATES":"Enables storing and querying of updates for the given storage.","SHARING":"Enables storage to participate in the CDQ sharing process.","DATA_MIRROR":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines storage as a Data Mirror. Turns on - NEVER_EXPIRE, LOOKUP, UPDATES, SHARING features. SHARING is not applied when records are not disclosed."},"children":[]}]}]}],"HOMELAND":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines storage as a Homeland Data Mirror. Turns on - DATA_MIRROR feature including its features."},"children":[]}]}]}],"NEVER_EXPIRE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether a storage should never expire. Always turned on for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATA_MIRROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Caution - don't use too often due to quota limits."},"children":[]}]}]}],"RELATIONS":"Enables storage to contain relations.","TAGS_MANAGED_BY_UPSERT":"Tags are accepted from upsert, not via dedicated endpoints. Allowed only when storage does not have HOMELAND activated."}}},"components/schemas/BusinessPartnerStorageDataSourceCreate":{"id":"components/schemas/BusinessPartnerStorageDataSourceCreate","kind":"json-schema","title":"BusinessPartnerStorageDataSourceCreate","data":{"type":"object","description":"Create a new Data Source for a Storage.","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceName"},"dataMapperDefinitionId":{"$ref":"#/components/schemas/DataMapperDefinitionId"},"dataTransformationDefinitionId":{"$ref":"#/components/schemas/DataTransformationDefinitionId"}}}},"components/schemas/BusinessPartnerStorageMetadataOrganization":{"id":"components/schemas/BusinessPartnerStorageMetadataOrganization","kind":"json-schema","title":"BusinessPartnerStorageMetadataOrganization","data":{"type":"object","description":"Your organization to which Business Partner storage is assigned.","properties":{"id":{"$ref":"#/components/schemas/OrganizationId"}}}},"components/schemas/StorageTag":{"id":"components/schemas/StorageTag","kind":"json-schema","title":"StorageTag","data":{"type":"string","description":"Tag to categorize the storage.","example":"Custom Tag","minLength":1,"maxLength":20}},"components/schemas/FeatureStatuses":{"id":"components/schemas/FeatureStatuses","kind":"json-schema","title":"FeatureStatuses","data":{"type":"object","description":"List of the feature statuses.","properties":{"lookup":{"$ref":"#/components/schemas/FeatureStatus"},"updates":{"$ref":"#/components/schemas/FeatureStatus"},"sharing":{"$ref":"#/components/schemas/FeatureStatus"},"neverExpire":{"$ref":"#/components/schemas/FeatureStatus"},"tagsManagedByUpsert":{"$ref":"#/components/schemas/FeatureStatus"},"dataMirror":{"$ref":"#/components/schemas/FeatureStatus"}}}},"components/schemas/FeatureStatusStatus":{"id":"components/schemas/FeatureStatusStatus","kind":"json-schema","title":"FeatureStatusStatus","data":{"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 a feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Feature is activated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DISABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Feature is deactivated."},"children":[]}]}]}],"example":"ENABLED"}},"components/schemas/BusinessPartnerMetadataReadFeatureParam":{"id":"components/schemas/BusinessPartnerMetadataReadFeatureParam","kind":"json-schema","title":"BusinessPartnerMetadataReadFeatureParam","data":{"type":"string","description":"Available features of a storage.","example":"RELOAD_EXPIRES_AT","enum":["RELOAD_EXPIRES_AT"],"x-enumDescriptions":{"RELOAD_EXPIRES_AT":"Reloads expiresAt date of a storage."}}},"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/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/CreatedAt":{"id":"components/schemas/CreatedAt","kind":"json-schema","title":"CreatedAt","data":{"type":"string","description":"Date of creation (ISO 8601-compliant).","example":"2026-10-21T13:37:18Z"}},"components/schemas/ModifiedAt":{"id":"components/schemas/ModifiedAt","kind":"json-schema","title":"ModifiedAt","data":{"type":"string","description":"Date of modification (ISO 8601-compliant).","example":"2026-10-21T13:37:18Z"}},"components/schemas/BusinessPartnerExternalId":{"id":"components/schemas/BusinessPartnerExternalId","kind":"json-schema","title":"BusinessPartnerExternalId","data":{"type":"string","description":"Arbitrary identifier type to mark customer IDs that are \"external\" from CDQ's perspective. This is the identifier a customer provides to identify its records.","example":"The ID managed in the customer's SAP systems."}},"components/schemas/ProcessingLogId":{"id":"components/schemas/ProcessingLogId","kind":"json-schema","title":"ProcessingLogId","data":{"type":"string","description":"Unique identifier of a processing log.","example":"CURATION_LOG"}},"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/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/ProcessingStatusTechnicalKey":{"id":"components/schemas/ProcessingStatusTechnicalKey","kind":"json-schema","title":"ProcessingStatusTechnicalKey","data":{"type":"string","description":"Possible technical states of processing.","example":"IN_PROGRESS"}},"components/schemas/AdditionalInformationKey":{"id":"components/schemas/AdditionalInformationKey","kind":"json-schema","title":"AdditionalInformationKey","data":{"type":"string","description":"Key of the generic key/value map.","example":"KEY"}},"components/schemas/AdditionalInformationValue":{"id":"components/schemas/AdditionalInformationValue","kind":"json-schema","title":"AdditionalInformationValue","data":{"type":"string","description":"Value of the generic key/value map.","example":"1"}},"components/schemas/AdditionalInformation":{"id":"components/schemas/AdditionalInformation","kind":"json-schema","title":"AdditionalInformation","data":{"type":"object","description":"Object provide additional information from the request to the external service like headers, requester id etc.","properties":{"key":{"$ref":"#/components/schemas/AdditionalInformationKey"},"value":{"$ref":"#/components/schemas/AdditionalInformationValue"}}}},"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/NameValue":{"id":"components/schemas/NameValue","kind":"json-schema","title":"NameValue","data":{"type":"string","description":"The actual name.","example":"Corporate Data Quality AG"}},"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/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/NameDetailValue":{"id":"components/schemas/NameDetailValue","kind":"json-schema","title":"NameDetailValue","data":{"type":"string","description":"Value of additional information to a business partner name.","example":"Corporate Data Quality AG - Marketing Department"}},"components/schemas/NameDetailTypeName":{"id":"components/schemas/NameDetailTypeName","kind":"json-schema","title":"NameDetailTypeName","data":{"type":"string","description":"Name detail type name of additional information to a business partner name.","example":"Legal Entity"}},"components/schemas/NameDetailTypeUrl":{"id":"components/schemas/NameDetailTypeUrl","kind":"json-schema","title":"NameDetailTypeUrl","data":{"type":"string","description":"Name detail type url of additional information to a business partner name.","example":"https://meta.cdq.com/Public:CDQ_data_model"}},"components/schemas/NameDetailTypeTechnicalKey":{"id":"components/schemas/NameDetailTypeTechnicalKey","kind":"json-schema","title":"NameDetailTypeTechnicalKey","data":{"type":"string","description":"Name detail type technical key of additional information to a business partner name.","example":"LEGAL_ENTITY"}},"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/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/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/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/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/schemas-IdentifierTypeTechnicalKey":{"id":"components/schemas/schemas-IdentifierTypeTechnicalKey","kind":"json-schema","title":"schemas-IdentifierTypeTechnicalKey","data":{"type":"string","description":"Technical key of the type of the Identifier.","example":"CH_VAT_ID"}},"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/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/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/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/IdentifierStatusTechnicalKey":{"id":"components/schemas/IdentifierStatusTechnicalKey","kind":"json-schema","title":"IdentifierStatusTechnicalKey","data":{"type":"string","description":"Technical key of the Identifier Status.","example":"ACTIVE"}},"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/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/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-10-21T13:37:18Z"}},"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-10-21T13:37:18Z"}},"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/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/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/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/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/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/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/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/VatPayerStatusPublicationDate":{"id":"components/schemas/VatPayerStatusPublicationDate","kind":"json-schema","title":"VatPayerStatusPublicationDate","data":{"type":"string","description":"Date of publication","example":"2026-10-21T13:37:18Z"}},"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/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/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/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/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/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/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/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/BusinessPartnerRelationStartedAt":{"id":"components/schemas/BusinessPartnerRelationStartedAt","kind":"json-schema","title":"BusinessPartnerRelationStartedAt","data":{"type":"string","description":"Describe when this relationship was first established.","example":"2026-10-21T13:37:18Z"}},"components/schemas/BusinessPartnerRelationEndedAt":{"id":"components/schemas/BusinessPartnerRelationEndedAt","kind":"json-schema","title":"BusinessPartnerRelationEndedAt","data":{"type":"string","description":"Describe when this relationship ended.","example":"2026-10-21T13:37:18Z"}},"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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/BankAccountCountryCode":{"id":"components/schemas/BankAccountCountryCode","kind":"json-schema","title":"BankAccountCountryCode","data":{"type":"string","description":"ISO code to identify the country a bank account is registered in.","example":"DE"}},"components/schemas/FirstPaymentDate":{"id":"components/schemas/FirstPaymentDate","kind":"json-schema","title":"FirstPaymentDate","data":{"type":"string","description":"The date of the first payment to the bank account (ISO 8601-compliant).","example":"2026-10-21T13:37:18Z"}},"components/schemas/LastPaymentDate":{"id":"components/schemas/LastPaymentDate","kind":"json-schema","title":"LastPaymentDate","data":{"type":"string","description":"The date of the last payment to the bank account (ISO 8601-compliant).","example":"2026-10-21T13:37:18Z"}},"components/schemas/NumberOfPayments":{"id":"components/schemas/NumberOfPayments","kind":"json-schema","title":"NumberOfPayments","data":{"type":"integer","description":"The number of payments to the bank account.","example":"1"}},"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/ExternalIdValue":{"id":"components/schemas/ExternalIdValue","kind":"json-schema","title":"ExternalIdValue","data":{"type":"string","description":"Value of the ExternalId of the business partner.","example":"123"}},"components/schemas/ConceptName":{"id":"components/schemas/ConceptName","kind":"json-schema","title":"ConceptName","data":{"type":"string","description":"Display name of the Concept.","example":"Address"}},"components/schemas/ConceptTechnicalKey":{"id":"components/schemas/ConceptTechnicalKey","kind":"json-schema","title":"ConceptTechnicalKey","data":{"type":"string","description":"Technical key of the Concept.","example":"ADDRESS"}},"components/schemas/PropertyName":{"id":"components/schemas/PropertyName","kind":"json-schema","title":"PropertyName","data":{"type":"string","description":"Name of the property.","example":"Minority Indicator Value"}},"components/schemas/PropertyTechnicalKey":{"id":"components/schemas/PropertyTechnicalKey","kind":"json-schema","title":"PropertyTechnicalKey","data":{"type":"string","description":"Technical key of the property.","example":"MINORITY_INDICATOR_VALUE"}},"components/schemas/PropertyContentSelector":{"id":"components/schemas/PropertyContentSelector","kind":"json-schema","title":"PropertyContentSelector","data":{"type":"string","description":"JSON path to the property in the provided JSON object.","example":"$.partnerProfile.minorityIndicator.value"}},"components/schemas/PropertyContentInstanceSelectorKey":{"id":"components/schemas/PropertyContentInstanceSelectorKey","kind":"json-schema","title":"PropertyContentInstanceSelectorKey","data":{"type":"string","description":"JSON subpath to the property allowing to select concrete instance of a property in the provided JSON object.","example":"type.technicalKey"}},"components/schemas/PropertyContentInstanceSelectorValue":{"id":"components/schemas/PropertyContentInstanceSelectorValue","kind":"json-schema","title":"PropertyContentInstanceSelectorValue","data":{"type":"string","description":"Value of a JSON subpath to the property allowing to select concrete instance of a property in the provided JSON object.","example":"CH_UID"}},"components/schemas/PropertyChangeTypeTechnicalKey":{"id":"components/schemas/PropertyChangeTypeTechnicalKey","kind":"json-schema","title":"PropertyChangeTypeTechnicalKey","data":{"type":"string","description":"Technical Key of the Property Change Type.","example":"MODIFIED"}},"components/schemas/schemas-PropertyChangeClassification":{"id":"components/schemas/schemas-PropertyChangeClassification","kind":"json-schema","title":"schemas-PropertyChangeClassification","data":{"type":"string","example":"MAJOR","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gives a user an indicator how \"much\" the attribute was changed OR how important the change was. Allowed 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":"TRIVIAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Trivial change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MINOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Minor change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MAJOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Major change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRITICAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Critical change"},"children":[]}]}]}]}]}},"components/schemas/ProcessingStatusTechnicalKeyEnum":{"id":"components/schemas/ProcessingStatusTechnicalKeyEnum","kind":"json-schema","title":"ProcessingStatusTechnicalKeyEnum","data":{"type":"string","description":"Possible technical states of processing.","enum":["READY","RETRY","BLOCKED","IN_PROGRESS"],"x-enumDescriptions":{"READY":"Processing Log Data processing has finished and result ready to consume.","RETRY":"Processing Log Data processing has failed and needs to be retried.","BLOCKED":"Processing Log Data processing is blocked and needs to be resolved.","IN_PROGRESS":"Processing Log Data is being processed."},"example":"IN_PROGRESS"}},"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/PropertyChangeConfidenceScore":{"id":"components/schemas/PropertyChangeConfidenceScore","kind":"json-schema","title":"PropertyChangeConfidenceScore","data":{"type":"number","description":"Confidence score which shows how confident CDQ is about enrichment of that property. Calculation dependes on property type, see here for a complete description.","example":"0.0","minimum":0}},"components/schemas/PropertyChangeMaxConfidenceScore":{"id":"components/schemas/PropertyChangeMaxConfidenceScore","kind":"json-schema","title":"PropertyChangeMaxConfidenceScore","data":{"type":"number","description":"Maximum confidence score which is achievable for this property type. Note that the max value will change over time depending on the udnerlying algorithm which will be continously improved.","example":"1.0"}},"components/schemas/DataMatchingThreshold":{"id":"components/schemas/DataMatchingThreshold","kind":"json-schema","title":"DataMatchingThreshold","data":{"type":"number","description":"The threshold for the data matching.","example":"0.5","format":"double","default":0,"minimum":0,"maximum":1}},"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/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/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/StatusTimestamp":{"id":"components/schemas/StatusTimestamp","kind":"json-schema","title":"StatusTimestamp","data":{"type":"string","description":"ISO 8601 representation of the timestamp.","example":"2026-10-21T13:37:18Z"}},"components/schemas/CmpelkV2Organization":{"id":"components/schemas/CmpelkV2Organization","kind":"json-schema","title":"CmpelkV2Organization","data":{"type":"object","description":"The details of the entity's organization.","properties":{"duns":{"type":"string","example":804735132,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The D-U-N-S Number, assigned by Dun & Bradstreet, is an identification number that uniquely identifies the entity in accordance with the Data Universal Numbering System (D-U-N-S)."},"children":[]}]}]}]},"dunsControlStatus":{"type":"object","description":"The details of the entity established to provide products and/or services in the marketplace or to the community.","properties":{"operatingStatus":{"type":"object","description":"The details of the entity's functional state or trading status.","properties":{"description":{"type":"string","example":"Active","description":"The entity's functional state or trading status (e.g., active, out of business)."},"dnbCode":{"type":"integer","example":9074,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the entity's functional state or trading status."},"children":[]}]}]}]}}},"isMarketable":{"type":"boolean","example":"true","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the data on the entity satisfies Dun & Bradstreet's marketability rules for Sales & Marketing Solutions products. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity data satisfies the marketability rules."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity data does not satisfy the marketability rules."},"children":[]}]}]}]},"isMailUndeliverable":{"type":"boolean","example":"false","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether it is possible to deliver mail to the address of this entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, it is not possible to deliver mail to the address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, it is possible to deliver mail to the address."},"children":[]}]}]}]},"isTelephoneDisconnected":{"type":"boolean","example":"false","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the telephone number can be connected to successfully."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, connection to the  telephone number is unsuccessful."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, connection to the  telephone number is successful."},"children":[]}]}]}]},"isDelisted":{"type":"boolean","example":"false","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the entity has requested that they not be included in any Direct marketing lists (e.g., mailing, telephone)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity has objected to and MUST NOT receive direct marketing material."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity has not objected to receiving direct marketing material."},"children":[]}]}]}]},"subjectHandlingDetails":{"type":"array","items":{"description":"The details of the manner in which the entity is to receive special care being contacted. In many cases, this was specifically requested by the entity.","properties":{"description":{"type":"string","example":"Do not call","description":"The manner in which the entity is to receive special care when being contacted (e.g., do not call or do not send information requests). In many cases, this was specifically requested by the entity."},"dnbCode":{"type":"integer","example":7974,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the manner in which the entity is to receive special care from Dun & Bradstreet when it is being contacted."},"children":[]}]}]}]}},"type":"object"}},"fullReportDate":{"type":"string","example":"2026-10-21T13:37:18Z","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The most recent date when a complete review of all business information data was completed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: YYYY-MM-DD or YYYY-MM"},"children":[]}]}]}]}}},"primaryName":{"type":"string","example":"GORMAN MANUFACTURING COMPANY, INC.","description":"The single name by which the entity is primarily known or identified."},"tradeStyleNames":{"type":"array","items":{"description":"The details of the names that the entity trades under for commercial purposes although its registered legal name used for contracts and other formal situations may be another name.","properties":{"name":{"type":"string","example":"Alternate Company Name","description":"The name that the entity trades under for commercial purposes  although its registered legal name used for contracts and other formal situations may be another name."},"priority":{"type":"integer","example":1,"description":"The sequence in which the entity mostly uses this tradestyle name."}},"type":"object"}},"websiteAddress":{"type":"array","items":{"description":"The details of the internet URLs used for online information and communication with the entity.","properties":{"url":{"type":"string","example":"http://www.gorman.com","description":"The Internet URL (Uniform Resource Locator) that uniquely identifies the proprietary website of the entity or the website preferred by the entity that gives more information on the entity."},"domainName":{"type":"string","example":"gorman.com","description":"A unique name used to identify the website of the entity that serves as an address to access that website."}},"type":"object"}},"telephone":{"type":"array","items":{"description":"The details of the telephone information used for voice communication with the entity.","properties":{"telephoneNumber":{"type":"string","example":6505550000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sequence of digits used for voice communication with the entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This sequence of digits includes the area code or city code and domestic dialing code."},"children":[]}]}]}]},"isdCode":{"type":"string","example":1,"description":"The country calling code assigned by the International Telecommunication Union (ITU) required to connect to this telephone number when dialing from outside the entity's country (e.g., '1' for the US, '44' for the UK, '91' for India)."},"isUnreachable":{"type":"boolean","example":"false","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the telephone number can be connected to successfully."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, connection to the  telephone number is unsuccessful."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, connection to the  telephone number is successful."},"children":[]}]}]}]}},"type":"object"}},"fax":{"type":"array","items":{"description":"The details of the facsimile information used for data communication with the entity.","properties":{"faxNumber":{"type":"string","example":6505550001,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sequence of digits used for facsimile communication with the entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This sequence of digits includes the area code or city code and domestic dialing code."},"children":[]}]}]}]},"isdCode":{"type":"string","example":1,"description":"The country calling code assigned by the International Telecommunication Union (ITU) required to connect to this facsimile number when dialing from outside the entity's country (e.g., '1' for the US, '44' for the UK, '91' for India)."}},"type":"object"}},"primaryAddress":{"type":"object","description":"The details of the single primary or physical address at which the entity is located.","properties":{"language":{"type":"object","description":"The details of the language in which this address was recorded.","properties":{"description":{"type":"string","example":"English","description":"The name of the language in which this address was recorded."},"dnbCode":{"type":"integer","example":39,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this address was recorded."},"children":[]}]}]}]}}},"addressCountry":{"type":"object","description":"The details of the country in which this address is located.","properties":{"name":{"type":"string","example":"United States","description":"The name of the country in which this address is located."},"isoAlpha2Code":{"type":"string","example":"US","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country in which this address is located."},"fipsCode":{"type":"string","example":"US","description":"The Federal Information Processing Standards (FIPS) code value that identifies the country in which this address is located."}}},"continentalRegion":{"type":"object","description":"The details of the continental region in which this address is located.","properties":{"name":{"type":"string","example":"North America","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continental region for this address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Latin America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- North America"},"children":[]}]}]}]}}},"addressLocality":{"type":"object","description":"The details of the city, town, township, village, borough, etc. in which this address is located.","properties":{"name":{"type":"string","example":"SAN FRANCISCO","description":"The name of the city, town, township, village, borough, etc. in which this address is located."}}},"minorTownName":{"type":"string","example":"Booker","description":"The name of the village, town or suburb when it is not a Primary Town or City (e.g., the Booker in Booker, High Wycombe)."},"addressRegion":{"type":"object","description":"The details of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","properties":{"name":{"type":"string","example":"California","description":"The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located."},"abbreviatedName":{"type":"string","example":"CA","description":"The shortened name of the locally governed area that forms part of a centrally governed nation. For example 'NJ' for the US State New Jersey within Country United States."},"isoSubDivisionName":{"type":"string","description":"The official name of a principal subdivision (e.g province or state) of countries coded in ISO 3166-1.","example":"Yamanashi"},"isoSubDivisionCode":{"type":"string","description":"The code assigned by ISO that represents the name of a principal subdivision (e.g province or state) of countries coded in ISO 3166-1.  This code is based on the two-letter code element from ISO 3166-1 followed by a separator and up to three alphanumeric characters.","example":"JP-19"},"fipsCode":{"type":"string","example":"06","description":"The Federal Information Processing Standards (FIPS) code value that identifies the region in which this address is located."}}},"addressCounty":{"type":"object","description":"The details of the county in which this address is located.","properties":{"name":{"type":"string","example":"SAN MATEO","description":"The name of the county in which this address is located."},"fipsCode":{"type":"string","example":81,"description":"The Federal Information Processing Standards (FIPS) code value that identifies the county in which this address is located."}}},"postalCode":{"type":"string","example":941109999,"description":"An identifier used by the local country's postal authority to identify where this address is located."},"postalCodePosition":{"type":"object","description":"The details of the position of the Postal Code when presenting the address.","properties":{"description":{"type":"string","example":"Post code presented before Town/City name","description":"The position of the Postal Code when presenting the address (e.g., before the Primary Town/City)."},"dnbCode":{"type":"integer","example":1009,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the position of the Postal Code when presenting the address."},"children":[]}]}]}]}}},"streetNumber":{"type":"string","example":492,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number part of the street address where the entity is located. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may be a single number, a number with an appendix, or a range of street numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the \"51 - 59C\" in the address 51 - 59C Wall Street."},"children":[]}]}]}]},"streetName":{"type":"string","example":"KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the street where the entity is located. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Wall Street\" in the address 51 - 59C Wall Street."},"children":[]}]}]}]},"streetAddress":{"type":"object","description":"The details of the street address where the entity is located.","properties":{"line1":{"type":"string","example":"492 KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"41 Central Chambers\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]},"line2":{"type":"string","example":"Suite 100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Dame Court\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]}}},"postOfficeBox":{"type":"object","description":"The details of the identifier issued to the entity by a private or public Postal Office for the purposes of collecting mail for the entity for subsequent collection or delivery.","properties":{"postOfficeBoxNumber":{"type":"string","example":5309,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An identifier issued to the entity by a private or public postal office for the purposes of collecting mail for the entity for subsequent collection or delivery."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes only the identifying number (or text) and not the textual description of the PO Box type. For example the contents would be just the number 12 from \"PO Box 12\", or just the number 57 from \"PMB 57\"."},"children":[]}]}]}]},"typeDescription":{"type":"string","example":"Supplied by public Post Office authority","description":"The type of the PO Box (e.g., Post Office Box, PMB)."},"typeDnBCode":{"type":"integer","example":120,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of PO Box."},"children":[]}]}]}]}}},"latitude":{"type":"number","example":37.777709,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latitude component of the entity's location defined as the angular distance of the primary physical address north or south from the Earth's equator expressed in decimal numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positive numbers indicate degrees north. Negative numbers indicate degrees south."},"children":[]}]}]}]},"longitude":{"type":"number","example":-122.404624,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The longitude component of the entity's location defined as the angular distance of the primary physical address east or west from an imaginary line (called the prime meridian) that goes from the North Pole to the South Pole expressed in decimal numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positive numbers indicate degrees east. Negative numbers indicate degrees west."},"children":[]}]}]}]},"geographicalPrecision":{"type":"object","description":"The details on how close the latitude and longitude coordinates for a location are to rooftop level.","properties":{"description":{"type":"string","example":"Street Segment Centroid","description":"The description of how close the latitude and longitude coordinates for a location are to rooftop level."},"dnbCode":{"type":"integer","example":30256,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify how close the latitude and longitude coordinates for a location are to \"rooftop\" level."},"children":[]}]}]}]}}},"isRegisteredAddress":{"type":"boolean","example":"true","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the primary address is the same as the address of the entity as registered with a legal entity.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the primary address is the same as the address of the entity as registered with a legal entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the primary address is the not same as the address of the entity as registered with a legal entity."},"children":[]}]}]}]},"isResidentialAddress":{"type":"boolean","example":"false","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether or not the Primary Address is classified as residential by the governing postal authority"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the primary address is classified as residential."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the primary address is not classified as residential."},"children":[]}]}]}]},"statisticalArea":{"type":"object","description":"The details of the various statistical facts associated with this address.","properties":{"cbsaName":{"type":"string","example":"San Francisco-Oakland-Hayward CA","description":"The name assigned to the 5-digit CBSA (Core Based Statistical Area) assigned by US Census board to denote a geographical region with a relatively high population density at its core and close economic ties throughout the area."},"cbsaCode":{"type":"string","example":41860,"description":"The 5-digit CBSA (Core Based Statistical Area) code assigned by US Census board to denote a geographical region with a relatively high population density at its core and close economic ties throughout the area."},"economicAreaOfInfluenceCode":{"type":"string","example":146,"description":"A code assigned by the U.S Bureau of Economic Analysis to identify the entity's regional market that surrounds a metropolitan or micropolitan statistical area serving as a regional center of economic activity."},"populationRank":{"type":"object","description":"The details of the statistical facts about population based on region's rank.","properties":{"rankNumber":{"type":"string","example":9,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number classifying the geographic area in which the entity is located based on the resident population."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: 0 to 9"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 denotes the lowest population range; 9 denotes the highest."},"children":[]}]}]}]},"rankDnBCode":{"type":"integer","example":10961,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the population for the geographical area in which this address is located."},"children":[]}]}]}]},"rankDescription":{"type":"string","example":"500,000 +","description":"A range of the population for the geographical area where the entity is located."}}}}},"locationOwnership":{"type":"object","description":"The details of the terms under which the entity occupies the premises.","properties":{"description":{"type":"string","example":"Rents","description":"Description of the terms under which the entity occupies the premises (e.g., owned, rented, leased)."},"dnbCode":{"type":"integer","example":1129,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the terms under which the entity occupies the premises."},"children":[]}]}]}]}}},"premisesArea":{"type":"object","description":"The details of space the entity utilizes at this address.","properties":{"measurement":{"type":"number","example":10034,"description":"A number portion of the amount to of space the entity occupies at this address (e.g., the 2000 in 2000 square meters)."},"unitDescription":{"type":"string","example":"square foot","description":"The measurement unit used to express the premises area measurement (e.g., acre, square meters, square feet)."},"unitDnBCode":{"type":"integer","example":3848,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the measurement unit used to express the premises area measurement."},"children":[]}]}]}]},"reliabilityDescription":{"type":"string","example":"Actual","description":"The accuracy of the measurement (e.g., actual, estimated, modeled)."},"reliabilityDnBCode":{"type":"integer","example":9092,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the accuracy of the measurement."},"children":[]}]}]}]}}},"isManufacturingLocation":{"type":"boolean","example":"true","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if manufacturing activity is performed at this facility by the entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity performs manufacturing activity at this facility."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity does not performs manufacturing activity at this facility."},"children":[]}]}]}]}}},"registeredAddress":{"type":"object","description":"The details of the official address of the entity as registered with a local or national registry to which all official correspondence must be sent.","properties":{"language":{"type":"object","description":"The details of the language in which this address was recorded.","properties":{"description":{"type":"string","example":"English","description":"The name of the language in which this address was recorded."},"dnbCode":{"type":"integer","example":39,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this address was recorded."},"children":[]}]}]}]}}},"addressCountry":{"type":"object","description":"The details of the country in which this address is located.","properties":{"name":{"type":"string","example":"United States","description":"The name of the country in which this address is located."},"isoAlpha2Code":{"type":"string","example":"US","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country in which this address is located."}}},"addressLocality":{"type":"object","description":"The details of the city, town, township, village, borough, etc. in which this address is located.","properties":{"name":{"type":"string","example":"SAN FRANCISCO","description":"The name of the city, town, township, village, borough, etc. in which this address is located."}}},"minorTownName":{"type":"string","example":"Booker","description":"The name of the village, town or suburb when it is not a Primary Town or City (e.g., the Booker in Booker, High Wycombe)."},"addressRegion":{"type":"object","description":"The details of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","properties":{"name":{"type":"string","example":"California","description":"The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located."},"abbreviatedName":{"type":"string","example":"CA","description":"The shortened name of the locally governed area that forms part of a centrally governed nation. For example 'NJ' for the US State New Jersey within Country United States."}}},"addressCounty":{"type":"object","description":"The details of the county in which this address is located.","properties":{"name":{"type":"string","example":"SAN MATEO","description":"The name of the county in which this address is located."}}},"postalCode":{"type":"string","example":941109999,"description":"An identifier used by the local country's postal authority to identify where this address is located."},"postalCodePosition":{"type":"object","description":"The details of the position of the Postal Code when presenting the address.","properties":{"description":{"type":"string","example":"Post code presented before Town/City name","description":"The position of the Postal Code when presenting the address (e.g., before the Primary Town/City)."},"dnbCode":{"type":"integer","example":1009,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the position of the Postal Code when presenting the address."},"children":[]}]}]}]}}},"streetNumber":{"type":"string","example":492,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number part of the street address where the entity is located. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may be a single number, a number with an appendix, or a range of street numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the \"51 - 59C\" in the address 51 - 59C Wall Street."},"children":[]}]}]}]},"streetName":{"type":"string","example":"KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the street where the entity is located. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Wall Street\" in the address 51 - 59C Wall Street."},"children":[]}]}]}]},"streetAddress":{"type":"object","description":"The details of the street address where the entity is located.","properties":{"line1":{"type":"string","example":"492 KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"41 Central Chambers\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]},"line2":{"type":"string","example":"Suite 100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Dame Court\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]},"line3":{"type":"string","example":"Address line 3","description":"The third line of the address where the entity is located."},"line4":{"type":"string","example":"Address line 4","description":"The forth line of the address where the entity is located."}}},"postOfficeBox":{"type":"object","description":"The details of the identifier issued to the entity by a private or public Postal Office for the purposes of collecting mail for the entity for subsequent collection or delivery.","properties":{"postOfficeBoxNumber":{"type":"string","example":5309,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An identifier issued to the entity by a private or public postal office for the purposes of collecting mail for the entity for subsequent collection or delivery."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes only the identifying number (or text) and not the textual description of the PO Box type. For example the contents would be just the number 12 from \"PO Box 12\", or just the number 57 from \"PMB 57\"."},"children":[]}]}]}]},"typeDescription":{"type":"string","example":"Supplied by public Post Office authority","description":"The type of the PO Box (e.g., Post Office Box, PMB)."},"typeDnBCode":{"type":"integer","example":120,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of PO Box."},"children":[]}]}]}]}}}}},"mailingAddress":{"type":"object","description":"The details of the address used by the entity for mailing purposes.","properties":{"language":{"type":"object","description":"The details of the language in which this address was recorded.","properties":{"description":{"type":"string","example":"English","description":"The name of the language in which this address was recorded."},"dnbCode":{"type":"integer","example":39,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this address was recorded."},"children":[]}]}]}]}}},"addressCountry":{"type":"object","description":"The details of the country in which this address is located.","properties":{"name":{"type":"string","example":"United States","description":"The name of the country in which this address is located."},"isoAlpha2Code":{"type":"string","example":"US","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country in which this address is located."}}},"continentalRegion":{"type":"object","description":"The details of the continental region in which this address is located.","properties":{"name":{"type":"string","example":"North America","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continental region for this address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Latin America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- North America"},"children":[]}]}]}]}}},"addressLocality":{"type":"object","description":"The details of the city, town, township, village, borough, etc. in which this address is located.","properties":{"name":{"type":"string","example":"SAN FRANCISCO","description":"The name of the city, town, township, village, borough, etc. in which this address is located."}}},"minorTownName":{"type":"string","example":"Booker","description":"The name of the village, town or suburb when it is not a Primary Town or City (e.g., the Booker in Booker, High Wycombe)."},"addressRegion":{"type":"object","description":"The details of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","properties":{"name":{"type":"string","example":"California","description":"The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located."},"abbreviatedName":{"type":"string","example":"CA","description":"The shortened name of the locally governed area that forms part of a centrally governed nation. For example 'NJ' for the US State New Jersey within Country United States."}}},"addressCounty":{"type":"object","description":"The details of the county in which this address is located.","properties":{"name":{"type":"string","example":"SAN MATEO","description":"The name of the county in which this address is located."}}},"postalCode":{"type":"string","example":941109999,"description":"An identifier used by the local country's postal authority to identify where this address is located."},"postalCodePosition":{"type":"object","description":"The details of the position of the Postal Code when presenting the address.","properties":{"description":{"type":"string","example":"Post code presented before Town/City name","description":"The position of the Postal Code when presenting the address (e.g., before the Primary Town/City)."},"dnbCode":{"type":"integer","example":1009,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the position of the Postal Code when presenting the address."},"children":[]}]}]}]}}},"postalRoute":{"type":"string","example":"route 3B","description":"A code assigned by the local postal authority that sorts mail pieces to the individual carrier routes within a postal code."},"streetNumber":{"type":"string","example":492,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number part of the street address where the entity is located. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may be a single number, a number with an appendix, or a range of street numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the \"51 - 59C\" in the address 51 - 59C Wall Street."},"children":[]}]}]}]},"streetName":{"type":"string","example":"KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the street where the entity is located. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Wall Street\" in the address 51 - 59C Wall Street."},"children":[]}]}]}]},"streetAddress":{"type":"object","description":"The details of the street address where the entity is located.","properties":{"line1":{"type":"string","example":"492 KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"41 Central Chambers\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]},"line2":{"type":"string","example":"Suite 100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Dame Court\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]}}},"postOfficeBox":{"type":"object","description":"The details of the identifier issued to the entity by a private or public Postal Office for the purposes of collecting mail for the entity for subsequent collection or delivery.","properties":{"postOfficeBoxNumber":{"type":"string","example":5309,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An identifier issued to the entity by a private or public postal office for the purposes of collecting mail for the entity for subsequent collection or delivery."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes only the identifying number (or text) and not the textual description of the PO Box type. For example the contents would be just the number 12 from \"PO Box 12\", or just the number 57 from \"PMB 57\"."},"children":[]}]}]}]},"typeDescription":{"type":"string","example":"Supplied by public Post Office authority","description":"The type of the PO Box (e.g., Post Office Box, PMB)."},"typeDnBCode":{"type":"integer","example":120,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of PO Box."},"children":[]}]}]}]}}}}},"stockExchanges":{"type":"array","items":{"description":"The details of the Stock Exchanges on which the entity's shares are traded.","properties":{"tickerName":{"type":"string","example":"NYSE:DNB","description":"Text by which the entity is identified on this Stock Exchange for share trading purposes."},"exchangeName":{"type":"object","description":"The details of the name of the Stock Exchange on which the entity's shares are traded.","properties":{"description":{"type":"string","example":"NYSE","description":"The name the Stock Exchange."}}},"exchangeCountry":{"type":"object","description":"The details of the country of the Stock Exchange.","properties":{"isoAlpha2Code":{"type":"string","example":"US","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country of the Stock Exchange."}}},"isPrimary":{"type":"boolean","example":"true","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if this is the most important stock exchange among all the stock exchange where the entity's shares are traded. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, indicates that this is the most important Stock Exchange."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, indicates that this is not the most important Stock Exchange."},"children":[]}]}]}]}},"type":"object"}},"thirdPartyAssessment":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the appraisal or opinion assigned to the entity by an organization other than the Dun & Bradstreet Worldwide Network (WWN)."},"children":[]}]}]}],"properties":{"description":{"type":"string","example":"Fortune 500 Revenue Rank","description":"The kind of appraisal, opinion, or rank that was assigned to the entity by the third party (e.g., Moody's Long Term Obligation Rating, FICO score, Vantage Score)."},"dnbCode":{"type":"integer","example":23290,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of assessment."},"children":[]}]}]}]},"assessmentDate":{"type":"string","example":2017,"description":"The date on which the assessment value was assigned by the third party."},"value":{"type":"string","example":31,"description":"The value for the appraisal, opinion, or rank that was assigned by the third party."}},"type":"object"}},"registrationNumbers":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the numbers assigned by an external body or by Dun & Bradstreet that either uniquely identifies or helps to identify the entity."},"children":[]}]}]}],"properties":{"registrationNumber":{"type":"string","example":"12-3456789","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number assigned by an external body or by Dun & Bradstreet that either uniquely identifies or helps to identify the entity."},"children":[]}]}]}]},"typeDescription":{"type":"string","example":"Federal Taxpayer Identification Number (US)","description":"The type of registration (e.g., Chamber of Commerce Number, Value Added Tax Number, Federal Taxpayer Identification Number, Companies Registry Office Number)."},"typeDnBCode":{"type":"integer","example":6863,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of registration number."},"children":[]}]}]}]}},"type":"object"}},"industryCodes":{"type":"array","items":{"description":"The details of the business activities in which the entity is actively engaged using standardized coding schemes such as European NACE and U.S. Standard Industry Classifications (SIC).","properties":{"code":{"type":"string","example":323111,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code that identifies the business activity in which the entity is engaged.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, 1611 represents the highway and street construction industry in the U.S. SIC (Standard Industrial Classification) system."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: These are generally external codes created by an external authoritative body, like the U.S. Office of Management and Budget (OMB); however, Dun & Bradstreet may have created extensions to more precisely define an activity, as in the case of the SIC 2+2 (the last 4 digits of an 8-digit SIC)."},"children":[]}]}]}]},"description":{"type":"string","example":"Commercial Printing ","description":"The business activity description as assigned by the coding scheme used."},"typeDescription":{"type":"string","example":"North American Industry Classification System 2012","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The industry coding scheme used for this Industry Code (e.g., U.S. Standard Industrial Classification (SIC) 1987, Standard Industry Code - 8 digit, North American Industry Classification System (NAICS), Nomenclature Generale des Activites Economiques dans L`Union Europeenne (NACE))."},"children":[]}]}]}]},"typeDnBCode":{"type":"integer","example":24664,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the industry coding scheme."},"children":[]}]}]}]},"priority":{"type":"integer","example":1,"description":"A number identifying the order in which this industry code should be presented relative to other industry codes of the same type where the lower the number the earlier the data is presented."}},"type":"object"}},"businessEntityType":{"type":"object","description":"The details of the legal form or structure of the entity as registered with government authorities.","properties":{"description":{"type":"string","example":"Corporation","description":"The name of the legal form or structure of the entity as registered with government authorities (e.g., partnership, corporation, private limited company, government department, proprietorship)."},"dnbCode":{"type":"integer","example":451,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the legal form or structure of the entity as registered with government authorities."},"children":[]}]}]}]}}},"controlOwnershipDate":{"type":"string","example":1985,"description":"The date when the current owners took over the entity."},"startDate":{"type":"string","example":1985,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date the entity chooses to claim as its established date. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This date may be different from the Operations Start Date."},"children":[]}]}]}]},"controlOwnershipType":{"type":"object","description":"The details of the type of controlling ownership.","properties":{"description":{"type":"string","example":"Privately owned","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name for the type of controlling ownership (e.g., publicly owned, privately owned, state owned).   "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:  For some countries, controlling ownership can be derived from the legal form."},"children":[]}]}]}]},"dnbCode":{"type":"integer","example":9058,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of controlling ownership."},"children":[]}]}]}]}}},"isAgent":{"type":"boolean","example":"false","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the entity acts as an agent promoting the goods or services of another entity (e.g., Sales Agent, Purchasing Agent). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity acts as an agent."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity does not act as an agent."},"children":[]}]}]}]},"isImporter":{"type":"boolean","example":"false","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the entity is an importer."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity imports a quantity of goods from other countries."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity does not import a quantity of goods from other countries."},"children":[]}]}]}]},"isExporter":{"type":"boolean","example":"false","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the entity is an exporter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity exports a quantity of goods to other countries."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity does not export a quantity of goods to other countries."},"children":[]}]}]}]},"numberOfEmployees":{"type":"array","items":{"description":"The details of the people engaged by the entity to perform its operations.","properties":{"value":{"type":"integer","example":1234,"description":"The total number of people engaged by the entity to perform its operations.  The scope of this employee figure is identified in informationScopeDescription."},"informationScopeDescription":{"type":"string","example":"Consolidated","description":"The scope of Number of Employees value (e.g., Consolidated, Individual, HQ only)."},"informationScopeDnBCode":{"type":"integer","example":9067,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the scope of Number of Employees."},"children":[]}]}]}]},"reliabilityDescription":{"type":"string","example":"Actual","description":"The integrity of the employee figures (e.g., audited, actual, estimated, or modeled)."},"reliabilityDnBCode":{"type":"integer","example":9092,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the integrity of the employee figures."},"children":[]}]}]}]},"employeeCategories":{"type":"array","items":{"description":"The details of the employee figures for the different function levels of the entity.","properties":{"employmentBasisDescription":{"type":"string","example":"Principals","description":"The type of employees that have been included in the calculation of the number of employees on the basis of their employment contract (e.g., Principals, Part Time Workers)."},"employmentBasisDnBCode":{"type":"integer","example":9064,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the employment basis description."},"children":[]}]}]}]}},"type":"object"}},"trend":{"type":"array","items":{"description":"The details of the employee growth  history.","properties":{"timePeriod":{"type":"object","description":"The details of timeframe for which this data is recorded.","properties":{"description":{"type":"string","example":"1 - 5 years","description":"The timeframe for which this data is recorded."},"dnbCode":{"type":"integer","example":13721,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the timeframe for which this data is recorded."},"children":[]}]}]}]}}},"growthRate":{"type":"number","example":-7,"description":"The percentage of change in number of employees from base year compared to the trend year."}},"type":"object"}}},"type":"object"}},"financials":{"type":"array","items":{"description":"The details of the standardized view of the financial results of the entity; this is usually extracted from a set of accounts.","properties":{"financialStatementToDate":{"type":"string","example":"2026-10-21T13:37:18Z","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the accounting period ended.  If the Reliability Code denotes the figures are projected (future), then this is the date when the accounting period will end."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: YYYY-MM-DD or YYYY-MM"},"children":[]}]}]}]},"financialStatementDuration":{"type":"string","example":"Annual","description":"The period of the financial statement expressed as a time interval."},"informationScopeDescription":{"type":"string","example":"Actual","description":"The organizational scope of the financial summary (e.g., Individual (Organization including any branches), Consolidated (Organization including any branches and subsidiaries))."},"informationScopeDnBCode":{"type":"integer","example":9092,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the organizational scope of the financial summary."},"children":[]}]}]}]},"reliabilityDescription":{"type":"string","example":"Actual","description":"The integrity of the financial figures (e.g., audited, actual, estimated, or modeled)."},"reliabilityDnBCode":{"type":"integer","example":9092,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the integrity of the financial figures."},"children":[]}]}]}]},"unitCode":{"type":"string","example":"Single Units","description":"The unit of size in which the financial summary figures are provided (e.g., in 1,000s; in 1,000,000s)"},"accountantName":{"type":"string","example":"Johnson, Jordan & Jones CPAs","description":"The name of either an individual or an accounting firm."},"yearlyRevenue":{"type":"array","items":{"description":"The details of the income received from customers from the sale of the entity''s goods and/or services. This is the gross sales minus any returns, rebates/discounts, allowances for damages or shortages, shipping expenses passed on to the customer, and amounts due where there is not a reasonable expectation of collection.","properties":{"value":{"type":"number","example":19945238,"description":"The monetary value of income received from customers from the sale of the entity's goods and/or services.  This is the gross sales minus any returns, rebates/discounts, allowances for damages or shortages, shipping expenses passed on to the customer."},"currency":{"type":"string","example":"USD","description":"The three-letter currency code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO) identifying the type of money in which this amount is expressed (e.g. USD, CAD, GBP, EUR)."},"minimumValue":{"type":"number","example":22500,"description":"The minimum annual sales figures, when annual sales are expressed as a range."},"maximumValue":{"type":"number","example":250000,"description":"The maximum annual sales figures, when annual sales are expressed as a range."},"trend":{"type":"array","items":{"description":"The details of the percentage of change of this item as of base year compared to the trend year.","properties":{"timePeriod":{"type":"object","description":"The details of the timeframe for which this data is recorded.","properties":{"description":{"type":"string","example":"1-5 years","description":"The timeframe for which this data is recorded."},"dnbCode":{"type":"integer","example":13721,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the timeframe in which this data is recorded."},"children":[]}]}]}]}}},"growthRate":{"type":"number","example":2,"description":"The percentage of change of this item as of base year compared to the trend year."}},"type":"object"}}},"type":"object"}}},"type":"object"}},"mostSeniorPrincipals":{"type":"array","items":{"description":"The  details of the most important principals.","properties":{"givenName":{"type":"string","example":"Leslie","description":"The given name of the principal."},"familyName":{"type":"string","example":"Smith","description":"The family name of the principal."},"fullName":{"type":"string","example":"Leslie Ann Smith","description":"The complete name of the principal."},"namePrefix":{"type":"string","example":"Dr.","description":"The correct form of address for the principal (e.g., Dr., Professor, Lord)."},"nameSuffix":{"type":"string","example":"PhD","description":"The familial or professional suffix to the principal's name."},"gender":{"type":"string","example":"Female","description":"The gender of this individual."},"jobTitles":{"type":"array","items":{"description":"The details of the positions held by this individual.","properties":{"title":{"type":"string","example":"President","description":"The position held by this individual."}},"type":"object"}},"managementResponsibilities":{"type":"array","items":{"description":"The details of the current business functions of the entity represented as a standard Management Responsibility Code (MRC).","properties":{"description":{"type":"string","example":"President","description":"Name of the business function of the entity derived from a standard Management Responsibility Code (MRC)."},"mrcCode":{"type":"string","example":"A1A6","description":"A unique code identifying the business function of the entity derived from a standard Management Responsibility Code (MRC)."}},"type":"object"}}},"type":"object"}},"currentPrincipals":{"type":"array","items":{"description":"The details of the principals that are actively associated with the entity.","properties":{"givenName":{"type":"string","example":"Leslie","description":"The given name of the principal."},"familyName":{"type":"string","example":"Smith","description":"The family name of the principal."},"fullName":{"type":"string","example":"Leslie Ann Smith","description":"The complete name of the principal."},"namePrefix":{"type":"string","example":"Dr.","description":"The correct form of address for the principal (e.g., Dr., Professor, Lord)."},"nameSuffix":{"type":"string","example":"PhD","description":"The familial or professional suffix to the principal's name."},"gender":{"type":"string","example":"Female","description":"The gender of this individual."},"jobTitles":{"type":"array","items":{"description":"The details of the positions held by this individual.","properties":{"title":{"type":"string","example":"President","description":"The position held by this individual."}},"type":"object"}},"managementResponsibilities":{"type":"array","items":{"description":"The details of the current business functions of the entity represented as a standard Management Responsibility Code (MRC).","properties":{"description":{"type":"string","example":"President","description":"Name of the business function of the entity derived from a standard Management Responsibility Code (MRC)."},"mrcCode":{"type":"string","example":"A1A6","description":"A unique code identifying the business function of the entity derived from a standard Management Responsibility Code (MRC)."}},"type":"object"}}},"type":"object"}},"socioEconomicInformation":{"type":"object","description":"The details of the categorization of the entity in Socio Economic or Statistical groups.","properties":{"isMinorityOwned":{"type":"boolean","example":"false","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the entity is minority owned.  Minority owned means it is certified as an entity that is greater than 50% owned by and whose management and daily operations are controlled by one or more minority group members"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, indicates that this is a minority-owned entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, indicates that this is not a minority-owned entity."},"children":[]}]}]}]},"isSmallBusiness":{"type":"boolean","example":"false","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the business qualifies as small business, eligible for assistance from SBA, with a place of business located in the United States. It must operate primarily within the United States or make a significant contribution to the U.S. economy through payment of taxes or use of American products, materials or labor. Together with its affiliates, it must meet the numerical size standards as defined in the Small Business Size Regulations 13 CFR 121."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, indicates that this is a small business."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, indicates that this is not a small business."},"children":[]}]}]}]}}},"isStandalone":{"type":"boolean","example":"false","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the entity is a member of a legal family tree. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, indicates that the entity is not a member of a legal family tree.  This means it cannot play any family tree role and corporateLinkage will not be present."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, indicates that the entity is a member of a legal family tree.  The roles it plays is indicated by Family Tree Member Roles played."},"children":[]}]}]}]},"corporateLinkage":{"type":"object","description":"The details of the relationship between the entity and other entities in the legal family tree.","properties":{"familytreeRolesPlayed":{"type":"array","items":{"description":"The details of the roles the entity plays as a member of an ownership structured family tree.","properties":{"description":{"type":"string","example":"Parent/Headquarters","description":"The role the entity plays as a member of an ownership structured family tree (e.g., a branch, division, a parent, headquarters, subsidiary, global ultimate, domestic ultimate)."},"dnbCode":{"type":"integer","example":9141,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify describing family tree role."},"children":[]}]}]}]}},"type":"object"}},"hierarchyLevel":{"type":"integer","example":1,"description":"The number of family-tree levels below the global ultimate the entity is in its corporate hierarchy. The hierarchy level value of the global ultimate will always be 1. Each subsidiary level below the global ultimate is incremented by 1. Branch locations in a family tree will have the same hierarchy code as its associated headquarter."},"globalUltimateFamilyTreeMembersCount":{"type":"integer","description":"The total number of entities in the entity's Family tree starting from Global Ultimate.","example":"4"},"globalUltimate":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the top most entity in the family tree, tracing each parent up to its own parent.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, Company-A is based in the US and has Company-B as its parent also in the US. In turn Company-B is owned by Company-C, also in the US, which is owned by Company-D which is in the UK. Thus, the Global Ultimate of this family tree (and therefore of each member of the family tree) is Company-D."},"children":[]}]}]}],"properties":{"duns":{"type":"string","example":804735132,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The D-U-N-S Number, assigned by Dun & Bradstreet, is an identification number that uniquely identifies the entity in accordance with the Data Universal Numbering System (D-U-N-S)."},"children":[]}]}]}]},"primaryName":{"type":"string","example":"GORMAN MANUFACTURING COMPANY, INC.","description":"The single name by which the entity is primarily known or identified."},"primaryAddress":{"type":"object","description":"The details of the single primary or physical address at which the entity is located.","properties":{"addressCountry":{"type":"object","description":"The details of the country in which this address is located.","properties":{"name":{"type":"string","example":"United States","description":"The name of the country in which this address is located."},"isoAlpha2Code":{"type":"string","example":"US","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country in which this address is located."},"fipsCode":{"type":"string","example":"US","description":"The Federal Information Processing Standards (FIPS) code value that identifies the country in which this address is located."}}},"continentalRegion":{"type":"object","description":"The details of the continental region in which this address is located.","properties":{"name":{"type":"string","example":"North America","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continental region for this address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Latin America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- North America"},"children":[]}]}]}]}}},"addressLocality":{"type":"object","description":"The details of the city, town, township, village, borough, etc. in which this address is located.","properties":{"name":{"type":"string","example":"SAN FRANCISCO","description":"The name of the city, town, township, village, borough, etc. in which this address is located."}}},"addressRegion":{"type":"object","description":"The details of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","properties":{"name":{"type":"string","example":"California","description":"The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located."},"abbreviatedName":{"type":"string","example":"CA","description":"The shortened name of the locally governed area that forms part of a centrally governed nation. For example 'NJ' for the US State New Jersey within Country United States."}}},"addressCounty":{"type":"object","description":"The details of the county in which this address is located.","properties":{"name":{"type":"string","example":"SAN MATEO","description":"The name of the county in which this address is located."}}},"postalCode":{"type":"string","example":941109999,"description":"An identifier used by the local country's postal authority to identify where this address is located."},"streetAddress":{"type":"object","description":"The details of the street address where the entity is located.","properties":{"line1":{"type":"string","example":"492 KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"41 Central Chambers\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]},"line2":{"type":"string","example":"Suite 100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Dame Court\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]}}}}}}},"domesticUltimate":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the Domestic Ultimate which is the last entity in the tree, when reviewing upwards, that is in the same country as the entity. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, Company-A is based in the US and has Company-B as its parent also in the US. In turn Company-B is owned by Company-C, also in the US, which is owned by Company-D which is in the UK. Thus, the Domestic Ultimate of Company-A is actually Company-C as this is the last entity in the parent chain that is in the US."},"children":[]}]}]}],"properties":{"duns":{"type":"string","example":804735132,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The D-U-N-S Number, assigned by Dun & Bradstreet, is an identification number that uniquely identifies the entity in accordance with the Data Universal Numbering System (D-U-N-S)."},"children":[]}]}]}]},"primaryName":{"type":"string","example":"GORMAN MANUFACTURING COMPANY, INC.","description":"The single name by which the entity is primarily known or identified."},"primaryAddress":{"type":"object","description":"The details of the single primary or physical address at which the entity is located.","properties":{"addressCountry":{"type":"object","description":"The details of the country in which this address is located.","properties":{"name":{"type":"string","example":"United States","description":"The name of the country in which this address is located."},"isoAlpha2Code":{"type":"string","example":"US","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country in which this address is located."},"fipsCode":{"type":"string","example":"US","description":"The Federal Information Processing Standards (FIPS) code value that identifies the country in which this address is located."}}},"continentalRegion":{"type":"object","description":"The details of the continental region in which this address is located.","properties":{"name":{"type":"string","example":"North America","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continental region for this address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Latin America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- North America"},"children":[]}]}]}]}}},"addressLocality":{"type":"object","description":"The details of the city, town, township, village, borough, etc. in which this address is located.","properties":{"name":{"type":"string","example":"SAN FRANCISCO","description":"The name of the city, town, township, village, borough, etc. in which this address is located."}}},"addressRegion":{"type":"object","description":"The details of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","properties":{"name":{"type":"string","example":"California","description":"The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located."},"abbreviatedName":{"type":"string","example":"CA","description":"The shortened name of the locally governed area that forms part of a centrally governed nation. For example 'NJ' for the US State New Jersey within Country United States."}}},"addressCounty":{"type":"object","description":"The details of the county in which this address is located.","properties":{"name":{"type":"string","example":"SAN MATEO","description":"The name of the county in which this address is located."}}},"postalCode":{"type":"string","example":941109999,"description":"An identifier used by the local country's postal authority to identify where this address is located."},"streetAddress":{"type":"object","example":"","description":"The details of the street address where the entity is located.","properties":{"line1":{"type":"string","example":"492 KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"41 Central Chambers\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]},"line2":{"type":"string","example":"Suite 100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Dame Court\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]}}}}}}},"parent":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the entity that owns more than 50% of the subject entity."},"children":[]}]}]}],"properties":{"duns":{"type":"string","example":804735132,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The D-U-N-S Number, assigned by Dun & Bradstreet, is an identification number that uniquely identifies the entity in accordance with the Data Universal Numbering System (D-U-N-S)."},"children":[]}]}]}]},"primaryName":{"type":"string","example":"GORMAN MANUFACTURING COMPANY, INC.","description":"The single name by which the entity is primarily known or identified."},"primaryAddress":{"type":"object","description":"The details of the single primary or physical address at which the entity is located.","properties":{"addressCountry":{"type":"object","description":"The details of the country in which this address is located.","properties":{"name":{"type":"string","example":"United States","description":"The name of the country in which this address is located."},"isoAlpha2Code":{"type":"string","example":"US","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country in which this address is located."},"fipsCode":{"type":"string","example":"US","description":"The Federal Information Processing Standards (FIPS) code value that identifies the country in which this address is located."}}},"continentalRegion":{"type":"object","description":"The details of the continental region in which this address is located.","properties":{"name":{"type":"string","example":"North America","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continental region for this address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Latin America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- North America"},"children":[]}]}]}]}}},"addressLocality":{"type":"object","description":"The details of the city, town, township, village, borough, etc. in which this address is located.","properties":{"name":{"type":"string","example":"SAN FRANCISCO","description":"The name of the city, town, township, village, borough, etc. in which this address is located."}}},"addressRegion":{"type":"object","description":"The details of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","properties":{"name":{"type":"string","example":"California","description":"The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located."},"abbreviatedName":{"type":"string","example":"CA","description":"The shortened name of the locally governed area that forms part of a centrally governed nation. For example 'NJ' for the US State New Jersey within Country United States."}}},"addressCounty":{"type":"object","description":"The details of the county in which this address is located.","properties":{"name":{"type":"string","example":"SAN MATEO","description":"The name of the county in which this address is located."}}},"postalCode":{"type":"string","example":941109999,"description":"An identifier used by the local country's postal authority to identify where this address is located."},"streetAddress":{"type":"object","description":"The details of the street address where the entity is located.","properties":{"line1":{"type":"string","example":"492 KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"41 Central Chambers\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]},"line2":{"type":"string","example":"Suite 100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Dame Court\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]}}}}}}},"headQuarter":{"type":"object","description":"The details of the office that serves as the administrative center for the entity.","properties":{"duns":{"type":"string","example":804735132,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The D-U-N-S Number, assigned by Dun & Bradstreet, is an identification number that uniquely identifies the entity in accordance with the Data Universal Numbering System (D-U-N-S)."},"children":[]}]}]}]},"primaryName":{"type":"string","example":"GORMAN MANUFACTURING COMPANY, INC.","description":"The single name by which the entity is primarily known or identified."},"primaryAddress":{"type":"object","description":"The details of the single primary or physical address at which the entity is located.","properties":{"addressCountry":{"type":"object","description":"The details of the country in which this address is located.","properties":{"name":{"type":"string","example":"United States","description":"The name of the country in which this address is located."},"isoAlpha2Code":{"type":"string","example":"US","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country in which this address is located."},"fipsCode":{"type":"string","example":"US","description":"The Federal Information Processing Standards (FIPS) code value that identifies the country in which this address is located."}}},"continentalRegion":{"type":"object","description":"The details of the continental region in which this address is located.","properties":{"name":{"type":"string","example":"North America","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continental region for this address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Latin America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- North America"},"children":[]}]}]}]}}},"addressLocality":{"type":"object","description":"The details of the city, town, township, village, borough, etc. in which this address is located.","properties":{"name":{"type":"string","example":"SAN FRANCISCO","description":"The name of the city, town, township, village, borough, etc. in which this address is located."}}},"addressRegion":{"type":"object","description":"The details of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","properties":{"name":{"type":"string","example":"California","description":"The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located."},"abbreviatedName":{"type":"string","example":"CA","description":"The shortened name of the locally governed area that forms part of a centrally governed nation. For example 'NJ' for the US State New Jersey within Country United States."}}},"addressCounty":{"type":"object","description":"The details of the county in which this address is located.","properties":{"name":{"type":"string","example":"SAN MATEO","description":"The name of the county in which this address is located."}}},"postalCode":{"type":"string","example":941109999,"description":"An identifier used by the local country's postal authority to identify where this address is located."},"streetAddress":{"type":"object","description":"The details of the street address where the entity is located.","properties":{"line1":{"type":"string","example":"492 KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"41 Central Chambers\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]},"line2":{"type":"string","example":"Suite 100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"Dame Court\" in the address "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41 Central Chambers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dame Court"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dublin 2"},"children":[]}]}]}]}}}}}}}}},"shareOwnership":{"type":"array","items":{"description":"The details of the recording of the individual, organization or entity that owns stock or common stock of the subject organization.","properties":{"duns":{"type":"string","example":"804735132","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a shareholder is a business, Dun & Bradstreet may assign a D-U-N-S Number to the company that owns stock or common stock of the subject entity.  The D-U-N-S Number is an identification number that uniquely identifies the organization in accordance with the Data Universe Numbering System (D-U-N-S).  Presence of a D-U-N-S Number is not a requirement to be a shareholder."},"children":[]}]}]}]},"primaryName":{"type":"string","example":"GORMAN MANUFACTURING COMPANY, INC.","description":"Single name by which the organization is primarily known or identified."},"primaryAddress":{"type":"object","description":"The details of the Primary Address at which the organization is located or conducts operations.","properties":{"addressCountry":{"type":"object","description":"The details of the country or region where the address of the organization is located or conducts operations.","properties":{"name":{"type":"string","example":"United States","description":"The Country or Region where the organization's Primary Address is located or conducts operations ."},"isoAlpha2Code":{"type":"string","example":"US","description":"The 2 letter alpha country code assigned by the International Organization for Standardization (ISO) identifying the Country/Region where the organization's Primary address is located or conducts operations ."}}},"continentalRegion":{"type":"object","description":"The details of the Continent in which the Primary Address of the organisation is located or conducts operations.","properties":{"name":{"type":"string","example":"North America","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continent where the Primary Address of the organization is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"South America"},"children":[]}]}]}]}}},"addressLocality":{"type":"object","description":"The details of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc.","properties":{"name":{"type":"string","example":"SAN FRANCISCO","description":"The name of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc."}}},"addressRegion":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the type of geographical area where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different markets have their own way of subdividing the country into smaller parts. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Departments (France)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"States (USA)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces (Netherlands)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counties (UK)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundeslander (Germany)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces and Territories (Canada)"},"children":[]}]}]}],"properties":{"name":{"type":"string","example":"California","description":"The name of the geographical area where the organization's Primary Address is located or conducts operations. For Example New Jersey."},"abbreviatedName":{"type":"string","example":"CA","description":"The shortened name of the geographical area where the organization's Primary Address is located or conducts operations For example NJ for the US State New Jersey within Country United States."}}},"postalCode":{"type":"string","example":"941109999","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postal code of the organization's Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known locally in various English-speaking countries throughout the world as a postcode, post code, Eircode, PIN or ZIP Code) is a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail. The code is used by the country's postal authority to identify the address where the organization is located or conducts operations ."},"children":[]}]}]}]},"streetAddress":{"type":"object","description":"The details of the street address where the organization's Primary Address is located.","properties":{"line1":{"type":"string","example":"492 KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the Primary Address where the organization is located or conducts operations. For example The Point in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}]},"line2":{"type":"string","example":"Suite 100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the Primary Address where the organization is located or conducts operations"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}]}}}}},"ownershipPercentage":{"type":"number","example":8.56,"description":"The total percent of the subject organization's stock or common stock owned by either an individual, organization with DUNS or direct entity shareholder."}},"type":"object"}},"affiliates":{"type":"array","items":{"description":"The details of other entities relationships to the subject entity typically identified when the affiliated entity has no legal obligation for the debts of the subject entity (e.g., Franchises, agents, dealers, associations, healthcare networks).","properties":{"duns":{"type":"string","example":"804735132","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The D-U-N-S Number, a proprietary organizational identifier owned and managed by Dun & Bradstreet Inc, provides unique identification of a subject organization, in accordance with the Data Universal Numbering System (D-U-N-S)."},"children":[]}]}]}]},"primaryName":{"type":"string","example":"GORMAN MANUFACTURING COMPANY, INC.","description":"Single name by which the organization is primarily known or identified."},"primaryAddress":{"type":"object","description":"The details of the Primary Address at which the organization is located or conducts operations.","properties":{"addressCountry":{"type":"object","description":"The details of the country or region where the address of the organization is located or conducts operations.","properties":{"name":{"type":"string","example":"United States","description":"The Country or Region where the organization's Primary Address is located or conducts operations ."},"isoAlpha2Code":{"type":"string","example":"US","description":"The 2 letter alpha country code assigned by the International Organization for Standardization (ISO) identifying the Country/Region where the organization's Primary address is located or conducts operations ."}}},"continentalRegion":{"type":"object","description":"The details of the Continent in which the Primary Address of the organisation is located or conducts operations.","properties":{"name":{"type":"string","example":"North America","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continent where the Primary Address of the organization is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"South America"},"children":[]}]}]}]}}},"addressLocality":{"type":"object","description":"The details of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc.","properties":{"name":{"type":"string","example":"SAN FRANCISCO","description":"The name of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc."}}},"addressRegion":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the type of geographical area where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different markets have their own way of subdividing the country into smaller parts. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Departments (France)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"States (USA)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces (Netherlands)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counties (UK)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundeslander (Germany)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces and Territories (Canada)"},"children":[]}]}]}],"properties":{"name":{"type":"string","example":"California","description":"The name of the geographical area where the organization's Primary Address is located or conducts operations. For Example New Jersey."},"abbreviatedName":{"type":"string","example":"CA","description":"The shortened name of the geographical area where the organization's Primary Address is located or conducts operations For example NJ for the US State New Jersey within Country United States."}}},"postalCode":{"type":"string","example":"941109999","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postal code of the organization's Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known locally in various English-speaking countries throughout the world as a postcode, post code, Eircode, PIN or ZIP Code) is a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail. The code is used by the country's postal authority to identify the address where the organization is located or conducts operations ."},"children":[]}]}]}]},"streetAddress":{"type":"object","description":"The details of the street address where the organization's Primary Address is located.","properties":{"line1":{"type":"string","example":"492 KOLLER ST","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the Primary Address where the organization is located or conducts operations. For example The Point in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}]},"line2":{"type":"string","example":"Suite 100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the Primary Address where the organization is located or conducts operations"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}]}}}}},"associationType":{"type":"object","description":"The details of the nature of association of this entity with subject entity.","properties":{"dnbCode":{"type":"integer","example":30488,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the nature of association of this entity with subject entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"511 [Affiliation Type]\" for all possible values."},"children":[]}]}]}]},"description":{"type":"string","example":"Dealer Alternate Linkage","description":"The nature of association of this entity with subject entity (e.g., Franchise, Agent)."}}},"franchiseName":{"type":"string","example":"Franchise","description":"The franchising branch."},"franchiseID":{"type":"string","example":"1058890509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify a franchising brand."},"children":[]}]}]}]}},"type":"object"}},"extendedLinkageInsight":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records data collected from a Dun & Bradstreet Artificial Intelligence-driven hierarchy solution that utilizes Machine Learning to link businesses as a linkage expert would and capture a wide spectrum of potential relationship including majority ownership, minority ownership, franchise, dealership and much more."},"children":[]}]}]}],"properties":{"brandName":{"type":"string","example":"DUN&BRADSTREET","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The brand name of DUNS extracted by Extended Linkage algorithm. For example, if the Business Name is \"The Dun & Bradstreet Corporation\", then Brand Name will be \"DUN&BRADSTREET\"."},"children":[]}]}]}]},"familyTreeCount":{"type":"integer","example":145,"description":"The total number of Extended Linkage Family members (i.e. The number of records in whole database with the same Extended Linkage Global Ultimate DUNS Number as the current records.)"},"globalUltimate":{"type":"object","description":"Records details of the Global Ultimate that is within the Extended Linkage Family.","properties":{"duns":{"type":"string","example":"005438890","description":"The Duns number of the Global Ultimate that is within the Extended Linkage Family."},"name":{"type":"string","example":"Lawson Products, Inc.","description":"The business name of the Global Ultimate that is within the Extended Linkage Family."},"primaryAddress":{"type":"object","description":"The details of the single primary or physical address of the global ultimate within this Extended family tree.","properties":{"addressCountry":{"type":"object","description":"The details of the country/market in which this address is located.","properties":{"name":{"type":"string","example":"United States","description":"The name of the country/market in which this address is located."}}}}}}},"domesticUltimate":{"type":"object","description":"Records details of the Domestic Ultimate that is within the Extended Linkage Family.","properties":{"duns":{"type":"string","example":"005438890","description":"The Duns number of the Domestic Ultimate that is within the Extended Linkage Family."},"name":{"type":"string","example":"Lawson Products, Inc.","description":"The business name of the Domestic Ultimate that is within the Extended Linkage Family."},"primaryAddress":{"type":"object","description":"The details of the single primary or physical address of the domestic ultimate within this Extended family tree.","properties":{"addressCountry":{"type":"object","description":"The details of the country/market in which this address is located.","properties":{"name":{"type":"string","example":"United States","description":"The name of the country/market in which this address is located."}}}}}}},"parent":{"type":"object","description":"Records details of the Parent that is within the Extended Linkage Family","properties":{"duns":{"type":"string","example":"005438890","description":"The DUNS number of the Parent that is within the Extended Linkage Family"},"name":{"type":"string","example":"Lawson Products, Inc.","description":"The business name of the Parent that is within the Extended Linkage Family"},"primaryAddress":{"type":"object","description":"The details of the single primary or physical address of the parent company within this Extended family tree.","properties":{"addressCountry":{"type":"object","description":"The details of the country/market in which this address is located.","properties":{"name":{"type":"string","example":"United States","description":"The name of the country/market in which this address is located."}}}}}}},"linkageSourceCategory":{"type":"integer","example":6,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This code indicates the source of linkage:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code \"9\" is assigned when majority ownership linkage is present."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code \"8\" is assigned when a local market linkage is present."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code \"7\" is assigned when an alternative linkage is present."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Codes \"3\" to \"6\" are assigned whenever a modeled relationship is present.            Note: The source codes of 3 - 6 are correlated with ELI Name Evidence, SIC Evidence, Brand Evidence, Phone Evidence, CEO Evidence and etc. The more evidences we've seen in those scores, the higher the source code will be."},"children":[]}]}]}]},"associationType":{"type":"object","description":"Records the type of association and that is intended to provide insights into the nature of the relationship between the entities. it is sourced from alternative linkage when alternative linkage is present. When alternative linkage is not present, type is inferred by the model based on the brand name extracted and the childs line of business.","properties":{"description":{"type":"string","example":"Agent Alternate Linkage","description":"Text that indicates the type of association and that is intended to provide insights into the nature of the relationship between the entities. it is sourced from alternative linkage when alternative linkage is present."},"dnbCode":{"type":"integer","example":30487,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet that indicates the type of association and that is intended to provide insights into the nature of the relationship between the entities. it is sourced from alternative linkage when alternative linkage is present."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"511 [Affiliation Type]\" for all possible values."},"children":[]}]}]}]}}},"nameEvidenceStrength":{"type":"object","description":"Records the level of the model outcome that supports the family tree information derived using name.","properties":{"description":{"type":"string","example":"Moderate","description":"Text denoting the level of the model outcome that supports the family tree information derived using name."},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using name."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}},"brandEvidenceStrength":{"type":"object","description":"Records the level of the model outcome that supports the family tree information derived using brand name.","properties":{"description":{"type":"string","example":"Moderate","description":"Text denoting the level of the model outcome that supports the family tree information derived using brand name."},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using brand name."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}},"industryEvidenceStrength":{"type":"object","description":"Records the level of the model outcome that supports the family tree information derived using industry code.","properties":{"description":{"type":"string","example":"Moderate","description":"Text denoting the level of the model outcome that supports the family tree information derived using industry code."},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using industry code."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}},"locationEvidenceStrength":{"type":"object","description":"Records the level of the model outcome that supports the family tree information derived using address.","properties":{"description":{"type":"string","example":"Moderate","description":"Text denoting the level of the model outcome that supports the family tree information derived using address."},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}},"ceoEvidenceStrength":{"type":"object","description":"Records the level of the model outcome that supports the family tree information derived using most senior principal data.","properties":{"description":{"type":"string","example":"Moderate","description":"Text denoting the level of the model outcome that supports the family tree information derived using most senior principal data."},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using most senior principal data."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}},"principalNameEvidenceStrength":{"type":"object","description":"Records the level of the model outcome that supports the family tree information derived using current principal data.","properties":{"description":{"type":"string","example":"Moderate","description":"Text denoting the level of the model outcome that supports the family tree information derived using current principal data."},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using current principal data."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}},"telephoneEvidenceStrength":{"type":"object","description":"Records the level of the model outcome that supports the family tree information derived using telephone information.","properties":{"description":{"type":"string","example":"Moderate","description":"Text denoting the level of the model outcome that supports the family tree information derived using telephone information."},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using telephone information."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}},"webDomainEvidenceStrength":{"type":"object","description":"Records the level of the model outcome that supports the family tree information derived using website domain information.","properties":{"description":{"type":"string","example":"Moderate","description":"Text denoting the level of the model outcome that supports the family tree information derived using website domain information."},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using website domain information."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}},"webPageEvidenceStrength":{"type":"object","description":"Records the level of the model outcome that supports the family tree information derived using website home page information.","properties":{"description":{"type":"string","example":"Moderate","description":"Text denoting the level of the model outcome that supports the family tree information derived using website home page information."},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using website home page information.."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}},"financialReportEvidenceStrength":{"type":"object","description":"Records the level of the model outcome that supports the family tree information derived using financial statements.","properties":{"description":{"type":"string","example":"Moderate","description":"Text denoting the level of the model outcome that supports the family tree information derived using financial statements."},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using financial statements.."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}},"wikipediaEvidenceStrength":{"type":"object","description":"Records the level of the model outcome that supports the family tree information derived using company's Wikipedia web page.","properties":{"description":{"type":"string","example":"Moderate","description":"Text denoting the level of the model outcome that supports the family tree information derived using company's Wikipedia web page."},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using company's Wikipedia web page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}},"feedbackEvidenceStrength":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records the level of the model outcome that supports the family tree information derived using D&B internal expert or customer feedback."},"children":[]}]}]}],"properties":{"description":{"type":"string","example":"Moderate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text denoting the level of the model outcome that supports the family tree information derived using D&B internal expert or customer feedback."},"children":[]}]}]}]},"dnbCode":{"type":"integer","example":13695,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet indicating the level of the model outcome that supports the family tree information derived using D&B internal expert or customer feedback."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}]}}}}}}}},"components/schemas/CmpelkV2":{"id":"components/schemas/CmpelkV2","kind":"json-schema","title":"CmpelkV2","data":{"type":"object","description":"The details of the entity.","properties":{"transactionDetail":{"type":"object","description":"The information used to process this request.","properties":{"transactionID":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value assigned by the Dun & Bradstreet application to uniquely identify this request."},"children":[]}]}]}],"type":"string","example":"rlh-hi9puyoijk-jop8u-kd-d-1"},"transactionTimestamp":{"description":"The date and time, in ISO 8601 UTC Z standard, when this response was created.","type":"string","example":"2026-10-21T13:37:18Z"},"inLanguage":{"description":"An IETF BCP 47 code value that defines the language in which this product was rendered.","type":"string","example":"en-US"},"productID":{"description":"The ID of the product used to create the response.","type":"string","example":"PRODID"},"productVersion":{"description":"The version of the product used to create the response.","type":"string","example":1}}},"inquiryDetail":{"type":"object","description":"The criteria used to process this request.","properties":{"duns":{"type":"string","example":804735132,"description":"The D-U-N-S number provided in the request."},"productID":{"type":"string","example":"PRODID","description":"The ID of the product used to produce the response."},"productVersion":{"type":"string","example":"v1","description":"The product version number provided in the request."},"tradeUp":{"type":"string","example":"hq","description":"The value of the tradeUp parameter provided in the request."},"customerReference":{"type":"string","example":"Some text to describe the request.","description":"A reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation."}}},"organization":{"$ref":"#/components/schemas/CmpelkV2Organization"}}}},"components/schemas/DataBlockOrganization":{"id":"components/schemas/DataBlockOrganization","kind":"json-schema","title":"DataBlockOrganization","data":{"type":"object","properties":{"duns":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The D-U-N-S Number, a proprietary organizational identifier owned and managed by Dun & Bradstreet Inc, provides unique identification of a subject organization, in accordance with the Data Universal Numbering System (D-U-N-S)."},"children":[]}]}]}],"example":"804735132"},"countryISOAlpha2Code":{"type":"string","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme, identifying the country in which the entity is located.","example":"US"},"primaryName":{"type":"string","description":"Single name by which the organization is primarily known or identified.","example":"GORMAN MANUFACTURING COMPANY, INC."},"dunsControlStatus":{"type":"object","properties":{"operatingStatus":{"type":"object","description":"The high level categorization of the entity's functional state or trading status.","properties":{"description":{"type":"string","description":"The entity's functional state or trading status summarized into either active or out of business.","example":"Active"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to identify the entity''s functional state or trading"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<br/>Possible values: <br/>9074 [Active]<br/>403 [Out of Business]<br/>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Refer to Reference code table"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"166 [Operating Status]\" for all possible values."},"children":[]}]}]}],"example":"9074"},"startDate":{"type":"string","description":"A date identifying the beginning of the time period in which this Operating Status is or was applicable.","example":"2026-10-21T13:37:18Z"}}},"operatingSubStatus":{"type":"object","description":"Records the specific status of the subject company.","properties":{"description":{"type":"string","description":"Textual description of the specific status of the company.","example":"Out of business - Favourable"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet denoting the specific status of the company."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"166 [Operating Status]\" for all possible values."},"children":[]}]}]}],"example":"9077"},"startDate":{"type":"string","description":"The date when this specific status of the company was recorded.","example":"2026-10-21T13:37:18Z"}}},"detailedOperatingStatus":{"type":"object","description":"Records the further low level status of the subject company, in terms of its operations.","properties":{"description":{"type":"string","description":"Textual description of the detailed operating status of the company.","example":"Operationally Active"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet denoting the detailed operating status of the company."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"732 [Detailed Operating Status]\" for all possible values."},"children":[]}]}]}],"example":"29929"}}},"isMarketable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the data on the entity satisfies Dun & Bradstreet's marketability rules for Sales & Marketing Solutions products. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity data satisfies the marketability rules."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity data does not satisfy the marketability rules."},"children":[]}]}]}],"example":"true"},"isMailUndeliverable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether it is possible to deliver mail to the address of this entity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, it is not possible to deliver mail to at least one of the addresses listed for this DUNS (Primary, Mailing or Registered)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, it is possible to deliver mail to the address."},"children":[]}]}]}],"example":"false"},"isTelephoneDisconnected":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the telephone number can be connected to successfully."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, connection to the telephone number is unsuccessful."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, connection to the telephone number is successful."},"children":[]}]}]}],"example":"false"},"isDelisted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the entity has requested that they not be included in any Direct marketing lists (e.g., mailing, telephone)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity has objected to and MUST NOT receive direct marketing material."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity has not objected to receiving direct marketing material."},"children":[]}]}]}],"example":"false"},"subjectHandlingDetails":{"type":"array","items":{"type":"object","description":"The details of the manner in which the entity is to receive special care being contacted. In many cases, this was specifically requested by the entity.","properties":{"description":{"type":"string","description":"The manner in which the entity is to receive special care when being contacted (e.g., do not call or do not send information requests). In many cases, this was specifically requested by the entity.","example":"Do not call."},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the manner in which the entity is to receive special care from Dun & Bradstreet when it is being contacted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"199 [Subject Handling]\" for all possible values."},"children":[]}]}]}],"example":"7974"}}}},"firstReportDate":{"type":"string","description":"The date when the first complete review of all Business Information Report data was updated about the business.","example":"2026-10-21T13:37:18Z"},"recordClass":{"type":"object","properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text denoting the classification of the company data maintained in the D&B database."},"children":[]}]}]}],"example":"Full DMI record"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier assigned by D&B to denote the classification of the company data maintained in the D&B database."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"240 [Record Class]\" for all possible values."},"children":[]}]}]}],"example":10928}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records the classification of the company data maintained in the D&B database."},"children":[]}]}]}]},"isSelfRequestedDUNS":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When turned ON (Set to TRUE), it indicates that the D-U-N-S Number for this subject was created at the request of the subject."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When turned OFF (Set to FALSE), it indicates that the D-U-N-S Number for this subject was not created at the request of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subject.; however as this is the assumed condition there is no requirement to create this tag to represent this fact."},"children":[]}]}]}],"example":true},"selfRequestDate":{"type":"string","description":"The date when the subject requested a D-U-N-S number for itself.","example":"2026-10-21T13:37:18Z"}},"description":"The details of the organization's functional state and controls that impact its suitability for various usage purposes."},"registeredName":{"type":"string","description":"The legally recognized name by which the organizationis registered with a local or national Registry.","example":"GORMAN MANUFACTURING COMPANY, INC."},"summary":{"type":"array","description":"The details of the editorial comments for the entity.","items":{"type":"object","description":"Editorial comments about the entity.","properties":{"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Editorial summary of the entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note. This text might have HTML Tags to help UI based applications."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note. Max length upto 100,000"},"children":[]}]}]}],"example":"<p>The popularity of the widget fueled AB Corp's strong revenue and earnings growth in the past decade. The company's revenue and profit hit all-time highs in 2017, coming in at $234 million and $53 million, respectively. Revenue and earnings fell back in 2018 with weaker widget sales.</p>"},"textType":{"type":"object","description":"The details of the context of the comment in the summary text.","properties":{"description":{"type":"string","description":"The context of the comment given in the summary text section.","example":"Legal Event"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the context of the comment in the summary text."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"27 [Information Description]\" for all possible values."},"children":[]}]}]}],"example":1170}}}}}},"multilingualPrimaryName":{"type":"array","items":{"type":"object","description":"The details of the name by which the entity is primarily known or identified presented in multiple languages.","properties":{"language":{"type":"object","properties":{"description":{"type":"string","description":"The language in which this name was recorded.","example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this address was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":39}},"description":"The details of the language in which this name was recorded."},"name":{"type":"string","description":"The name by which the entity is primarily known or identified.","example":"GORMAN"},"writingScript":{"type":"object","properties":{"description":{"type":"string","description":"Text denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji.","example":"Kana"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"466 [Writing Script]\" for all possible values."},"children":[]}]}]}],"example":19347}},"description":"Records the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."}}}},"multilingualRegisteredNames":{"type":"array","items":{"type":"object","description":"Records the name of the company as recorded in the official registry, if available in multiple languages.","properties":{"language":{"type":"object","properties":{"description":{"type":"string","description":"The language in which this name was recorded.","example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this address was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":39}},"description":"The details of the language in which this name was recorded."},"name":{"type":"string","description":"Single name by which the organization is primarily known or identified.","example":"GORMAN MANUFACTURING COMPANY, INC."},"writingScript":{"type":"object","properties":{"description":{"type":"string","description":"Text denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji.","example":"Kana"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"466 [Writing Script]\" for all possible values."},"children":[]}]}]}],"example":19347}},"description":"Records the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."}}}},"tradeStyleNames":{"type":"array","items":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the names the organization trades under for commercial purposes"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A 'trading style' or 'trading as name' is a name a business chooses to use which is different from their registered company name. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example D&B is a trading style of Dun & Bradstreet Ltd. It is what the business chooses to call itself for marketing purposes."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The names the organization trades under for commercial purposes"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A 'trading style' or 'trading as name' is a name a business chooses to use which is different from their registered company name."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example D&B is a trading style of Dun & Bradstreet Ltd. It is what the business chooses to call itself for marketing purposes."},"children":[]}]}]}],"example":"Alternate Company Name"},"priority":{"type":"integer","description":"A numeric value used to identify the relative importance of a Trade Style Name compared to other Trade Style Names.  The lower the numeric value the earlier the data is displayed (i.e. 1 indicates the most important name, 2 the second most important etc...)","example":1}}}},"multilingualTradestyleNames":{"type":"array","items":{"type":"object","description":"The details of the names, in multiple languages, that the entity trades under for commercial purposes although its registered legal name used for contracts and other formal situations may be another name.","properties":{"language":{"type":"object","properties":{"description":{"type":"string","description":"The name of the language in which this name was recorded.","example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet to denote the language in which this name was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":3807}},"description":"The details of the language in which this name was recorded."},"name":{"type":"string","description":"The name that the entity trades under for commercial purposes although its registered legal name used for contracts and other formal situations may be another name.","example":"GORMAN"},"priority":{"type":"integer","description":"The sequence in which the entity mostly uses this trade style name.","example":1}}}},"defaultCurrency":{"type":"string","description":"The three-letter currency code, defined in the ISO 4217 scheme published by International Organization for Standardization (ISO) identifying the type of money that this entity uses by default.","example":"USD"},"websiteAddress":{"type":"array","items":{"type":"object","description":"The details of the internet URLs used for online information and communication with the Organization.","properties":{"url":{"type":"string","description":"The Internet URL (Uniform Resource Locator) that uniquely identifies the proprietary website of the Organization or the website preferred by the Organization that gives more information on the entity.","example":"http://www.gorman.com"},"domainName":{"type":"string","description":"A unique name used to identify the website of the Organization that serves as an address to access that website.","example":"gorman.com"}}}},"email":{"type":"array","items":{"type":"object","description":"The details of the email address used to contact the entity.","properties":{"address":{"type":"string","description":"The email address for the entity.","example":"someone@company.com"}}}},"certifiedEmail":{"type":"string","description":"A certified E-Mail is an email that guarantees legal certainty of the sender's identity, of the date and time of sending and receiving the email, and of its content.","example":"admin@xyz.com"},"telephone":{"type":"array","items":{"type":"object","description":"The details of the Telephone contact information used for voice communication with the organization.","properties":{"telephoneNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The primary voice telephone number for the business, when dialing domestically. The National Telephone Number is created by combining the Domestic Area Code and the Local Number."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Domestic Area Code is a series of numbers that must be prefixed before dialing a telephone number in another local area. National telecommunication authorities use various formats and dialing rules for area codes. Also known as City Code."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Local Number is a series of numbers that represents a specific telephone line."},"children":[]}]}]}],"example":"6505550000"},"isdCode":{"type":"string","description":"A series of numbers that must be prefixed before dialing a telephone number in another Country, it is comprised of an International Dialing Prefix followed by the Country Code. These are also referred to as Country Calling Code or Country Dial-In Code.","example":"1"}}}},"primaryAddress":{"type":"object","properties":{"language":{"type":"object","properties":{"description":{"type":"string","description":"The name of the language in which this address was recorded.","example":"English"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this address was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":39}},"description":"The details of the language in which this address was recorded."},"addressCountry":{"type":"object","properties":{"name":{"type":"string","description":"The Country or Region where the organization's Primary Address is located or conducts operations .","example":"United States"},"isoAlpha2Code":{"type":"string","description":"The 2 letter alpha country code assigned by the International Organization for Standardization (ISO) identifying the Country/Region where the organization's Primary address is located or conducts operations .","example":"US"}},"description":"The details of the country or region where the address of the organization is located or conducts operations."},"continentalRegion":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continent where the Primary Address of the organization is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"South America"},"children":[]}]}]}],"example":"North America"}},"description":"The details of the Continent in which the Primary Address of the organisation is located or conducts operations."},"addressLocality":{"type":"object","properties":{"name":{"type":"string","description":"The name of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc.","example":"SAN FRANCISCO"}},"description":"The details of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc."},"minorTownName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the  village, town or suburb where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example Booker in  Booker, High Wycombe."},"children":[]}]}]}],"example":"Booker"},"addressRegion":{"type":"object","properties":{"name":{"type":"string","description":"The name of the geographical area where the organization's Primary Address is located or conducts operations. For Example New Jersey.","example":"California"},"abbreviatedName":{"type":"string","description":"The shortened name of the geographical area where the organization's Primary Address is located or conducts operations For example NJ for the US State New Jersey within Country United States.","example":"CA"},"isoSubDivisionName":{"type":"string","description":"The official name of a principal subdivision (e.g province or state) of countries coded in ISO 3166-1.","example":"Yamanashi"},"isoSubDivisionCode":{"type":"string","description":"The code assigned by ISO that represents the name of a principal subdivision (e.g province or state) of countries coded in ISO 3166-1.  This code is based on the two-letter code element from ISO 3166-1 followed by a separator and up to three alphanumeric characters.","example":"JP-19"},"administrativeDivisionCode":{"type":"string","example":"GR84","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Dun & Bradstreet proprietary code value representing a statistical group classification of administrative divisions. Which are grouped based on certain criteria such as urban area size, proximity to larger urban areas and commuting patterns."},"children":[]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the type of geographical area where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different markets have their own way of subdividing the country into smaller parts. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Departments (France)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"States (USA)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces (Netherlands)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counties (UK)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundeslander (Germany)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces and Territories (Canada)"},"children":[]}]}]}]},"addressCounty":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the geographical area of a Country or Region where the organization's address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Countries subdivide their geography into smaller sub divisions. County is an example of a commonly used subdivision, oftenfound in the UK."},"children":[]}]}]}],"example":"SAN MATEO"},"administrativeDivisionCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Dun & Bradstreet proprietary code value representing a statistical group classification of administrative divisions. Which are grouped based on certain criteria such as urban area size, proximity to larger urban areas and commuting patterns."},"children":[]}]}]}],"example":"GR84"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the geographical area of a Country or Region where the organization's Primary Address is located or conducts operations. Countries divide their geography into smaller sub divisions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"County is an example of a commonly used subdivision. Often found in UK."},"children":[]}]}]}]},"streetAddress":{"type":"object","properties":{"line1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the Primary Address where the organization is located or conducts operations. For example The Point in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"492 KOLLER ST"},"line2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the Primary Address where the organization is located or conducts operations"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"Suite 100"}},"description":"The details of the street address where the organization's Primary Address is located."},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postal code of the organization's Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known locally in various English-speaking countries throughout the world as a postcode, post code, Eircode, PIN or ZIP Code) is a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail. The code is used by the country's postal authority to identify the address where the organization is located or conducts operations ."},"children":[]}]}]}],"example":"941109999"},"postalRoute":{"type":"string","example":"route 3B","description":"A code assigned by the local postal authority that sorts mail pieces to the individual carrier routes within a postal code."},"postalCodePosition":{"type":"object","properties":{"description":{"type":"string","description":"The position of the Postal Code when presenting the Primary Address where the organization is located or conducts operations (e.g. before or after the address Town/City).","example":"Post code presented before Town/City name"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun and Bradstreet to identify the position of the postal code when presenting the Primary Address where the organization is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"210 [Postal Code Position]\" for all possible values."},"children":[]}]}]}],"example":1009}},"description":"The details of the position of the Postal Code when presenting the Primary Address where the organization is located or conducts operations."},"streetNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The numerical part of the street address where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may be a single number, a number with an appendix, or a range of street numbers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"492"},"streetName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the street where the organization's Primary address is located or conducts operations. For example North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"KOLLER ST"},"postOfficeBox":{"type":"object","properties":{"postOfficeBoxNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique dentifier issued to the organizationby a private or public postal office where the organizationrequests to have mail delivered for its Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes only the identifying number (or text) and not the textual description of the PO Box type. For example the contents would be just the number 12 from PO Box 12 not PO Box or just the number 57 from PMB 57 not PMB"},"children":[]}]}]}],"example":"5309"},"typeDescription":{"type":"string","description":"The type of the PO Box (e.g., Post Office Box, PMB).","example":"Supplied by public Post Office authority"},"typeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of PO Box where the organisation requests to have mail delivered for its Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"208 [Postal Box Type]\" for all possible values."},"children":[]}]}]}],"example":120}},"description":"The details of the location  issued by a private or public Postal Office where the organization requests to have mail delivered for its Primary Address."},"standardAddressCodes":{"type":"array","items":{"type":"object","description":"Records identifiers that uniquely identifies an entire address as opposed to an individual component of an address (such as a street). For example, a NIKE Address Identifier, a Japan Postal Barcode.","properties":{"addressCode":{"type":"string","description":"An identifier that uniquely identifies an entire address as opposed to an individual component of an address (such as a street). For example, a NIKE Address Identifier, a Japan Postal Barcode.","example":"ZV12467A"},"codeType":{"type":"object","properties":{"description":{"type":"string","description":"Text that denotes the type of the standard address code.","example":"DK standard address code"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet to identify the type of the standard address code."},"children":[]}]}]}],"example":487}},"description":"Records the type of the standard address code."}}}},"isRegisteredAddress":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the address is the same as the organization's Registered Address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if TRUE the primary/main address is the same as the organization's RegisteredAddress."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if FALSE The address is not the same as the organization's Registered Address."},"children":[]}]}]}],"example":true},"latitude":{"type":"number","description":"The geographic coordinate that specifies the north-south position of the Primary  Address where the organisation is located or conducts operations .","example":37.777709},"longitude":{"type":"number","description":"The geographic coordinate that specifies the  east-west position of the Primary Address where the organisation is located or conducts operations .","example":-122.404624},"geographicalPrecision":{"type":"object","properties":{"description":{"type":"string","description":"A description of  how close the latitude and longitude coordinates are to the geographical position of the address where the organization  is located or conducts operations.","example":"Street Segment Centroid"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun and Bradstreet to identify how close the latitude and longitude coordinates are for the address where the organization is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"231 [Geographical Precision]\" for all possible values."},"children":[]}]}]}],"example":30256}},"description":"The details on how close the latitude and longitude coordinates are to the geographical position of the address where the organization  is located or conducts operations ."},"statisticalArea":{"type":"object","properties":{"economicAreaOfInfluenceCode":{"type":"string","description":"A code assigned by the U.S Bureau of Economic Analysis to identify the entity's regional market that surrounds a metropolitan or micropolitan statistical area serving as a regional center of economic activity.","example":"146"}},"description":"The details of the various statistical facts associated with this address."},"isManufacturingLocation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if manufacturing activity is performed at this facility by the entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity performs manufacturing activity at this facility."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity does not performs manufacturing activity at this facility."},"children":[]}]}]}],"example":true}},"description":"The details of the Primary Address at which the organization is located or conducts operations."},"iso20022StructuredPrimaryAddress":{"type":"object","description":"A structured address lends itself to the delivery of data in compliance with international and regional standards such as ISO-20022 and SEPA 2.0. A structured view of address data represents a standardized format for efficient use and access by software applications. It is granular in its level of detail and clearly defines data attributes, enabling effective processing and automation. As opposed to free-form text lines, a Structured Address will drive down misinterpretation of address information by downstream consumers.","properties":{"addressCountry":{"type":"object","description":"The country or region for this address of the organization.","properties":{"isoAlpha2Code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 2 letter alpha country or region code assigned by the International Organization for Standardization (ISO) identifying the country or region for this address of the organization."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note. Please refer to Country Code Substitutions Table for the country or region code substitutions."},"children":[]}]}]}],"example":"US"}}},"addressRegion":{"type":"object","description":"The name of the geographical area for this address of the organization. For Example New Jersey.","properties":{"name":{"type":"string","description":"The name of the geographical area for this address of the organization. For Example New Jersey.","example":"California"},"isoSubDivisionName":{"type":"string","description":"The official name of a principal subdivision (e.g province or state) of countries coded in ISO 3166-1.","example":"Yamanashi"},"isoSubDivisionCode":{"type":"string","description":"The code assigned by ISO that represents the name of a principal subdivision (e.g province or state) of countries coded in ISO 3166-1. This code is based on the two-letter code element from ISO 3166-1 followed by a separator and up to three alphanumeric characters.","example":"JP-19"}}},"addressCounty":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the geographical area of a Country or Region for this address of the organization. Countries divide their geography into smaller sub divisions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"County is an example of a commonly used subdivision. Often found in UK."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the geographical area of a Country or Region for this address of the organization."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Countries subdivide their geography into smaller sub divisions. County is an example of a commonly used subdivision, often found in the UK."},"children":[]}]}]}],"example":"SAN MATEO"}}},"addressLocality":{"type":"object","description":"The name of the locality for this address of the organization. Locality defined as a district population cluster. City, town, township, village, borough etc.","properties":{"name":{"type":"string","description":"The name of the locality for this address of the organization. Locality defined as a district population cluster. City, town, township, village, borough etc.","example":"SAN FRANCISCO"}}},"minorTownName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the village, town or suburb for this address of the organization."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example Booker in Booker, High Wycombe."},"children":[]}]}]}],"example":"Booker"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postal code for this address of the organization."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known locally in various English-speaking countries throughout the world as a postcode, post code, Eircode, PIN or ZIP Code) is a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail. The code is used by the country's postal authority to identify the address where the organization is located or conducts operations."},"children":[]}]}]}],"example":"941109999"},"streetNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The numerical part of the street address for this address of the organization."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may be a single number, a number with an appendix, or a range of street numbers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"492"},"streetName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the street for this address of the organization. For example North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"KOLLER ST"},"streetAddress":{"type":"object","description":"Records the details such as address number, or post office box number and street name where the business is located.","properties":{"line1":{"type":"string","description":"Text recording the address number, or post office box number and street name where the business is located.","example":"1 INFINITE LOOP"},"line2":{"type":"string","description":"Text that records the street address components as it would be presented on an address label. This includes, but is not limited to, details such as street name, street number, building name, estate name.","example":"Ocean drive"}}},"buildingName":{"type":"string","description":"The name of the building in which the business is located.","example":"The Tower"},"buildingInternalUnit":{"type":"string","description":"Describes a subdivision, such as the actual floor, or floors, within a building which are occupied by the business. E.g. 3rd Floor, 9th - 15th Floors.","example":"3rd Floor"},"buildingInternalUnitType":{"type":"object","description":"Describes the type of internal unit, e.g., Floor.","properties":{"description":{"type":"string","description":"Text which describes the type of internal unit, e.g., Floor.","example":"Floor"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet, which describes the type of internal unit, e.g., Floor."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"64 [Address Usage Component]\" for all possible values."},"children":[]}]}]}],"example":3285}}},"buildingInternalReference":{"type":"string","description":"The smallest detail of an address within a building such as a suite, unit or room. E.g. Room 100 in an address like Room 100, 3rd Floor, World Trade Centre or Rooms 19 to 27, etc.","example":"Room 23"},"buildingInternalReferenceType":{"type":"object","description":"Describes the type of internal building reference E.g. Room.","properties":{"description":{"type":"string","description":"Text which describes the type of internal building reference E.g. Room.","example":"Room"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet, which describes the type of internal building reference E.g. Room."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"64 [Address Usage Component]\" for all possible values."},"children":[]}]}]}],"example":3306}}}}},"multilingualPrimaryAddress":{"type":"array","items":{"type":"object","description":"The details of the primary or physical address at which the entity is located presented in multiple languages.","properties":{"language":{"type":"object","properties":{"description":{"type":"string","description":"The name of the language in which this address was recorded.","example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this address was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":3807}},"description":"The details of the language in which this address was recorded."},"addressCountry":{"type":"object","properties":{"name":{"type":"string","description":"The name of the country/market in which this address is located.","example":"Japan"},"isoAlpha2Code":{"type":"string","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country/market in which this address is located","example":"JP"}},"description":"The details of the country/market in which this address is located."},"continentalRegion":{"type":"object","properties":{"name":{"type":"string","description":"The name of the continental region for this address. Possible values: - Africa - Asia Pacific - Europe - Latin America - Middle East - North America.","example":"Asia Pacific"}},"description":"The details of the continental region in which this address is located."},"addressLocality":{"type":"object","properties":{"name":{"type":"string","description":"The name of the city, town, township, village, borough, etc. in which this address is located.","example":"SAN FRANCISCO"}},"description":"The details of the city, town, township, village, borough, etc. in which this address is located."},"minorTownName":{"type":"string","description":"The name of the village, town or suburb when it is not a Primary Town or City (e.g., the Booker in Booker, High Wycombe).","example":"Booker"},"addressRegion":{"type":"object","properties":{"name":{"type":"string","description":"The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","example":"California"}},"description":"The details of the locally governed area that forms part of a centrally governed nation to identify where this address is located."},"addressCounty":{"type":"object","properties":{"name":{"type":"string","description":"The name of the county in which this address is located.","example":"SAN MATEO"}},"description":"The details of the county in which this address is located."},"postalCode":{"type":"string","description":"An identifier used by the local country's postal authority to identify where this address is located.","example":"941109999"},"streetNumber":{"type":"string","description":"The number part of the street address where the entity is located. This may be a single number, a number with an appendix, or a range of street numbers. For example, the \"51 - 59C\" in the address 51 - 59C Wall Street.","example":"2"},"streetName":{"type":"string","description":"The name of the street where the entity is located. For example, \"Wall Street\" in the address 51 - 59C Wall Street.","example":"Wall Street"},"streetAddress":{"type":"object","properties":{"line1":{"type":"string","description":"The first line of the address where the entity is located. For example, \"41 Central Chambers\" in the address 41 Central Chambers Dame Court Dublin 2","example":"The Point"},"line2":{"type":"string","description":"The second line of the address where the entity is located. For example, \"Dame Court\" in the address 41 Central Chambers Dame Court Dublin 2","example":"37 North Wharf Road"}},"description":"The details of the street address where the entity is located."},"writingScript":{"type":"object","description":"Records the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji.","properties":{"description":{"type":"string","description":"Text denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji.","example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":3807}}}}}},"registeredAddress":{"type":"object","properties":{"language":{"type":"object","properties":{"description":{"type":"string","description":"A description of the language in which the organization's official address is presented .","example":"English"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this organization's official address  is presented"},"children":[]}]}]}],"example":39}},"description":"The details of the language in which the organization's official address is presented."},"addressCountry":{"type":"object","properties":{"name":{"type":"string","description":"The name of the country/region where the organization's official address is located","example":"United States"},"isoAlpha2Code":{"type":"string","description":"The 2 letter alpha country code assigned by the International Organization for Standardization (ISO) identifying the country/region where the organization's official address is located.","example":"US"}},"description":"The details of the Country or Region where the organization's official address is located."},"addressLocality":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the locality where the organization's official address is located. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locality defined as a district population cluster. City, Town, Township, Village, Borough etc."},"children":[]}]}]}],"example":"SAN FRANCISCO"}},"description":"The details of the locality where the organization's official address is located."},"minorTownName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the village, town or suburb where the organization's official address is located ."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.g. Booker in Booker High Wycombe"},"children":[]}]}]}],"example":"Booker"},"addressRegion":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the geographical area where the organization's official address is located . "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New Jersey"},"children":[]}]}]}],"example":"California"},"abbreviatedName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shortened name of the geographical area where the organization's official address is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example NJ for the US State New Jersey within Country United States."},"children":[]}]}]}],"example":"CA"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the type of geographical area where the organization's official address is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different markets have their own way of subdividing the country into smaller parts. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Departments (France)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"States (USA)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces (Netherlands)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundeslnder (Germany)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces and Territories (Canada)"},"children":[]}]}]}]},"addressCounty":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the geographical area of a country or region where the organization's official address is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Countries subdivide their geography into smaller areas; the UK county is a typical example."},"children":[]}]}]}],"example":"SAN MATEO"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the geographical  area of a country or region where the organization's official address is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Countries subdivide their  geography into smaller areas. County is an example of commonly used area often found in UK"},"children":[]}]}]}]},"postalCode":{"type":"string","description":"The postal code of the organization's Registered Address. Also known locally in various English-speaking countries throughout the world as a postcode, post code, Eircode, PIN or ZIP Code. Itis a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail.","example":"941109999"},"postalCodePosition":{"type":"object","properties":{"description":{"type":"string","description":"The position of the Postal Code when presenting the organization's official address (e.g. before or after the address Town/City)","example":"Post code presented before Town/City name"},"dnbCode":{"type":"integer","description":"A  unique code assigned by Dun and Bradstreet to identify the position of the postal code when presenting the organization's official address.","example":1009}},"description":"The details of the position of the Postal Code when presenting the address where the organization's official correspondence is delivered ."},"streetNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The numerical part of the street address where the organization's official address is located. This may be a single number, a number with an appendix, or a range of street numbers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, 51 - 59C for the address 51 - 59C Wall Street."},"children":[]}]}]}],"example":"51 - 59C"},"streetName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the street where the organization's official address is located. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example; Wall Street for the address 51 - 59C Wall Street."},"children":[]}]}]}],"example":"Wall Street"},"streetAddress":{"type":"object","properties":{"line1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the organization's official address. For example The Point In the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"The Point"},"line2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the organization's official address. For example 37 North Wharf Road In the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]}]}]}],"example":"37 North Wharf Road"},"line3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The third line of the organization's official address. For example  London in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"Address line 3"},"line4":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The  fourth line of the organization's official address. For example W2 1AF in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"Address line 4"}},"description":"The details of the street address where the organization's official address is located."},"postOfficeBox":{"type":"object","properties":{"postOfficeBoxNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier issued to the organisation by a private or public postal office where all official correspondence is delivered."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes only the identifying number (or text) and not the textual description of the PO Box type. For example the contents would be just the number 12 from PO Box 12 not PO Box or just the number 57 from PMB 57 not PMB"},"children":[]}]}]}],"example":"5309"},"typeDescription":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the type of post office box e.g.Post Office Box or Private Mail Box PMB"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A post office box (commonly abbreviated as P.O. box, or also known as a postal box) is a uniquely addressable lockable box located on the premises of a post office station where the organisation requests to have official correspondence delivered. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Private Mail box  (commonly abbreviated as PMB provides a real street address and can accept delivery of packages as well as mail."},"children":[]}]}]}],"example":"Supplied by public Post Office authority"},"typeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of PO Box where the organisation requests to have official correspondence delivered."},"children":[]}]}]}],"example":120}},"description":"A description of the language in which the organization's official address is presented."}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the organization's official address as recorded with an external authority to which all official correspondence must be sent"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Companies House for the UK."},"children":[]}]}]}]},"multilingualRegisteredAddress":{"type":"array","description":"The details of the primary or physical address at which the entity is located presented in multiple languages.","items":{"type":"object","description":"The details of the address in a specific language with associated language and writing script information.","properties":{"language":{"type":"object","description":"The details of the language in which this address was recorded.","properties":{"description":{"type":"string","description":"The name of the language in which this address was recorded.","example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this address was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":3807}}},"writingScript":{"type":"object","description":"Records the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji.","properties":{"description":{"type":"string","description":"Text denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji.","example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":3807}}},"addressCountry":{"type":"object","description":"The country or region in which this address is located.","properties":{"name":{"type":"string","description":"The name of the country or region in which this address is located.","example":"Japan"},"isoAlpha2Code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two-letter country or region code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country or region in which this address is located"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Please refer to  Country Code Substitutions Table for the country or region code substitutions."},"children":[]}]}]}],"example":"JP"}}},"continentalRegion":{"type":"object","description":"The details of the continent for this address of the organization.","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continent for this address of the organization."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Latin America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North America"},"children":[]}]}]}],"example":"North America"}}},"addressLocality":{"type":"object","description":"The details of the city, town, township, village, borough, etc. in which this address is located.","properties":{"name":{"type":"string","description":"The name of the city, town, township, village, borough, etc. in which this address is located.","example":"千代田区"}}},"addressRegion":{"type":"object","description":"The details of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","properties":{"name":{"type":"string","description":"The name of the locally governed area that forms part of a centrally governed nation to identify where this address is located.","example":"東京都"}}},"postalCode":{"type":"string","description":"An identifier used by the local country's postal authority to identify where this address is located.","example":"941109999"},"streetAddress":{"type":"object","description":"The details of the street address where the entity is located.","properties":{"line1":{"type":"string","description":"The first line of the address where the entity is located. For example, \"41 Central Chambers\" in the address 41 Central Chambers Dame Court Dublin 2","example":"丸の内２－３－１"},"line2":{"type":"string","description":"The second line of the address where the entity is located. For example, \"Dame Court\" in the address 41 Central Chambers Dame Court Dublin 2","example":"三菱商事ビルディング"}}}}}},"mailingAddress":{"type":"object","properties":{"language":{"type":"object","properties":{"description":{"type":"string","description":"The name of the language in which this address was recorded.","example":"English"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this address was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":39}},"description":"The details of the language in which this address was recorded."},"addressCountry":{"type":"object","properties":{"name":{"type":"string","description":"The Country or Region where the organization's Primary Address is located or conducts operations .","example":"United States"},"isoAlpha2Code":{"type":"string","description":"The 2 letter alpha country code assigned by the International Organization for Standardization (ISO) identifying the Country/Region where the organization's Primary address is located or conducts operations .","example":"US"}},"description":"The details of the country or region where the address of the organization is located or conducts operations."},"continentalRegion":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continent where the Primary Address of the organization is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"South America"},"children":[]}]}]}],"example":"North America"}},"description":"The details of the Continent in which the Primary Address of the organisation is located or conducts operations."},"addressLocality":{"type":"object","properties":{"name":{"type":"string","description":"The name of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc.","example":"SAN FRANCISCO"}},"description":"The details of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc."},"minorTownName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the  village, town or suburb where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example Booker in  Booker, High Wycombe."},"children":[]}]}]}],"example":"Booker"},"addressRegion":{"type":"object","properties":{"name":{"type":"string","description":"The name of the geographical area where the organization's Primary Address is located or conducts operations. For Example New Jersey.","example":"California"},"abbreviatedName":{"type":"string","description":"The shortened name of the geographical area where the organization's Primary Address is located or conducts operations For example NJ for the US State New Jersey within Country United States.","example":"CA"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the type of geographical area where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different markets have their own way of subdividing the country into smaller parts. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Departments (France)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"States (USA)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces (Netherlands)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counties (UK)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundeslander (Germany)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces and Territories (Canada)"},"children":[]}]}]}]},"addressCounty":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the geographical area of a Country or Region where the organization's address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Countries subdivide their geography into smaller sub divisions. County is an example of a commonly used subdivision, oftenfound in the UK."},"children":[]}]}]}],"example":"SAN MATEO"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the geographical area of a Country or Region where the organization's Primary Address is located or conducts operations. Countries divide their geography into smaller sub divisions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"County is an example of a commonly used subdivision. Often found in UK."},"children":[]}]}]}]},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postal code of the organization's Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known locally in various English-speaking countries throughout the world as a postcode, post code, Eircode, PIN or ZIP Code) is a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail. The code is used by the country's postal authority to identify the address where the organization is located or conducts operations ."},"children":[]}]}]}],"example":"941109999"},"postalCodePosition":{"type":"object","properties":{"description":{"type":"string","description":"The position of the Postal Code when presenting the Primary Address where the organization is located or conducts operations (e.g. before or after the address Town/City).","example":"Post code presented before Town/City name"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun and Bradstreet to identify the position of the postal code when presenting the Primary Address where the organization is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"210 [Postal Code Position]\" for all possible values."},"children":[]}]}]}],"example":1009}},"description":"The details of the position of the Postal Code when presenting the Primary Address where the organization is located or conducts operations."},"postalRoute":{"type":"string","description":"A code assigned by the local postal authority that sorts mail pieces to the individual carrier routes within a postal code.","example":"route 3B"},"streetNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The numerical part of the street address where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may be a single number, a number with an appendix, or a range of street numbers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"492"},"streetName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the street where the organization's Primary address is located or conducts operations. For example North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"KOLLER ST"},"streetAddress":{"type":"object","properties":{"line1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the Primary Address where the organization is located or conducts operations. For example The Point in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"492 KOLLER ST"},"line2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the Primary Address where the organization is located or conducts operations"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"Suite 100"}},"description":"The details of the street address where the organization's Primary Address is located."},"postOfficeBox":{"type":"object","properties":{"postOfficeBoxNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique dentifier issued to the organizationby a private or public postal office where the organizationrequests to have mail delivered for its Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes only the identifying number (or text) and not the textual description of the PO Box type. For example the contents would be just the number 12 from PO Box 12 not PO Box or just the number 57 from PMB 57 not PMB"},"children":[]}]}]}],"example":"5309"},"typeDescription":{"type":"string","description":"The type of the PO Box (e.g., Post Office Box, PMB).","example":"Supplied by public Post Office authority"},"typeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of PO Box where the organisation requests to have mail delivered for its Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"208 [Postal Box Type]\" for all possible values."},"children":[]}]}]}],"example":120}},"description":"The details of the location  issued by a private or public Postal Office where the organization requests to have mail delivered for its Primary Address."}},"description":"The details of the address used by the entity for mailing purposes."},"stockExchanges":{"type":"array","items":{"type":"object","description":"The details of the Stock Exchanges on which the entity's shares are traded.","properties":{"tickerName":{"type":"string","description":"Text by which the entity is identified on this Stock Exchange for share trading purposes.","example":"NYSE:DNB"},"exchangeName":{"type":"object","properties":{"description":{"type":"string","description":"The name the Stock Exchange.","example":"NYSE"}},"description":"The details of the name of the Stock Exchange on which the entity's shares are traded."},"exchangeCountry":{"type":"object","description":"The details of the country of the Stock Exchange.","properties":{"isoAlpha2Code":{"type":"string","description":"The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country of the Stock Exchange.","example":"US"}}},"isPrimary":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if this is the most important stock exchange among all the stock exchange where the entity's shares are traded. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, indicates that this is the most important Stock Exchange."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, indicates that this is not the most important Stock Exchange."},"children":[]}]}]}],"example":true}}}},"standardizedStockExchanges":{"type":"array","items":{"type":"object","description":"Records all the stock exchanges that the subject trades in represented using predefined finite values.","properties":{"tickerName":{"type":"string","description":"Text by which the entity is identified on this Stock Exchange for share trading purposes.","example":"NYSE:DNB"},"listingDate":{"type":"string","description":"The date when this stock was listed first in the stock exchange.","example":"2026-10-21T13:37:18Z"},"exchangeName":{"type":"object","properties":{"description":{"type":"string","description":"Text that denotes the standardized name of the stock exchange.","example":"Shanghai Stock Exchange"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet that denotes the standardized name of the stock exchange."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"178 [Stock Exchange]\" for all possible values."},"children":[]}]}]}],"example":20666}},"description":"Records the standardized name of the stock exchange."},"sectionNames":{"type":"array","items":{"type":"object","description":"Records the different sections within a stock exchange in different languages.","properties":{"name":{"type":"string","description":"Records the name of the section within the stock exchange, e.g., First section of the Tokyo Stock Exchange, Second section of the Tokyo Stock Exchange, JASDAQ, MOTHERS.","example":"JASDAQ"},"language":{"type":"object","properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text that records the language in which this information was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet that records the language in which this information was recorded."},"children":[]}]}]}],"example":3807}},"description":"Records the language in which this information was recorded."}}}}}}},"isForbesLargestPrivateCompaniesListed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the entity has ever been listed as one of the largest private companies in the United States on the annual list compiled and published by Forbes magazine"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity has been listed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity has not been listed."},"children":[]}]}]}],"example":false},"isFortune1000Listed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the entity has ever been listed as one of the 1000 largest American companies, ranked on revenues alone by the American business magazine Fortune."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity has been listed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity has not been listed."},"children":[]}]}]}],"example":false},"registrationNumbers":{"type":"array","items":{"type":"object","description":"The details of the organization's identifiers issued by a recognized external authority to uniquely identify subjects. The issuing authority may be a Registration Authority, Government Department or Commercial Enterprise (e.g., Chamber of Commerce numbers, VAT numbers).","properties":{"registrationNumber":{"type":"string","description":"The number or alphanumeric value assigned by a recognized external authority that either uniquely identifies or helps to identify the organization.","example":"12-3456789"},"typeDescription":{"type":"string","description":"The official name of the organization identifier assigned by a recognized external authority (e.g.. Australian Company Number, Federal Taxpayer Identification Number, Value Added Tax Number).","example":"Federal Taxpayer Identification Number (US)"},"typeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of organization identifier. For example, 2541 stands for company number issued by the UK Companies House."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"7 [Registration Number Type]\" for all possible values."},"children":[]}]}]}],"example":6863},"isPreferredRegistrationNumber":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this is the preferred organization identifier. When turned ON (set to TRUE), this organization identifier is the one Dun & Bradstreet recommends for this organization. When turned OFF (set to FALSE), this is not the preferred organization identifier."},"children":[]}]}]}],"example":true},"registrationLocation":{"type":"string","example":"Vlaams Brabant","description":"The location, such as the name of a court or Chamber of Commerce, where the Organization Registration Number is registered. Specifically required when the Organization Registration Number is not unique within a country and requires this detail for uniqueness."},"registrationNumberClass":{"type":"object","description":"Records the broad class into which the Organization Registration Number is categorized. E.g. Tax Registration Number, Chamber of Commerce Number, National Business Number etc.","properties":{"description":{"type":"string","example":"National Business Registration Number","description":"Text which denotes the broad class into which the Organization Registration Number is categorized. E.g. Tax Registration Number, Chamber of Commerce Number, National Business Number etc."},"dnbCode":{"type":"integer","example":2888,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet to denote the broad class into which the Organization Registration Number is categorized. E.g. Tax Registration Number, Chamber of Commerce Number, National Business Number etc."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"72 [Registration Number Class]\" for all possible values."},"children":[]}]}]}]}}}}}},"primaryIndustryCode":{"type":"object","properties":{"usSicV4":{"type":"string","description":"The 4-digit code in the U.S. SIC (Standard Industrial Classification) 1987 system assigned to an organization categorizing the primary business activities performed at its location. For example, 1611 represents the highway and street construction industry.","example":"5461"},"usSicV4Description":{"type":"string","description":"The description of the business activities represented by the Primary US SIC Code. For example, 'highway and street construction' is the description of industry code 1611.","example":"Credit reporting services"}},"description":"The details of the business activity in which the organisation is primarily engaged using standardised coding schemes such as European NACE and U.S Standard Industry Classification (SIC)."},"industryCodes":{"type":"array","items":{"type":"object","description":"The details of the business activities in which the organization is actively engaged using a standardized coding schemes such as European NACE and U.S. Standard Industry Classification (SIC).","properties":{"code":{"type":"string","description":"An alphanumeric value assigned to an organization categorizing the business activities performed at its location. Business activities are coded using standardized coding schemes. For example, 1611 represents the highway and street construction industry in the U.S. SIC (Standard Industrial Classification) 1987 system.","example":"323111"},"description":{"type":"string","description":"The description of the business activities represented by the Industry Code as defined in the coding scheme identified by the Industry Code Type Description. For example, 'highway and street construction' is the description of industry code 1611 in the U.S. SIC 1987 system.","example":"Commercial Printing "},"typeDescription":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the standardized coding scheme used to classify the business activities of an organization. This can be an externally recognized coding scheme as for instance North American Industry Classification System (NAICS) or a proprietary scheme like D&B SIC-8."},"children":[]}]}]}],"example":"North American Industry Classification System 2012"},"typeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the industry coding scheme."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industry schemes supported currently:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D&B Industry Code (3599)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NAICS Code (30832)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US 1987 SIC Code (399)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NACE Revision 2 (29104)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D&B Hoovers Industry Code (25838)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Major Industry Category (24657)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Local Activity Codes (specific to markets)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"30 [Industry Code Type]\" for all possible values."},"children":[]}]}]}],"example":24664},"priority":{"type":"integer","description":"A number identifying the order in which this industry code should be presented relative to other industry codes of the same type. Priority is based on the importance of the business activity to the organization.","example":1}}}},"unspscCodes":{"type":"array","items":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of several products and services represented in the United Nations Standard Products and Services Code (UNSPSC) scheme; this scheme was jointly developed by the United Nations Development Programme (UNDP) and Dun & Bradstreet Corporation in 1998."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The United Nations Standard Products and Services Code (UNSPSC) provides an open, global multi-sector standard for efficient, accurate classification of products and services. It is a 4-level hierarchy coded as an 8-digit number."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The UNSPSC for a given item is composed of four 2-digit identifiers, which together categorize the item into a five-level hierarchy. The five levels of the classification are Segment, Family, Class, and Commodity. Business Function is optional."},"children":[]}]}]}],"properties":{"code":{"type":"string","description":"The UNSPSC code that identifies a product or service offered by the entity.","example":"31111617"},"description":{"type":"string","description":"The description associated with the UNSPSC code.","example":"Zinc impact extrusions"},"priority":{"type":"integer","description":"Identifies the order in which this UNSPSC code should be presented relative to other UNSPSC codes.","example":1}}}},"isNonClassifiedEstablishment":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to \"true\", it denotes that the Dun & Bradstreet is unable to classify the subject into a specific industry."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to \"false\", it denotes that the Dun & Bradstreet is able to classify the subject into a specific industry."},"children":[]}]}]}],"example":true},"activities":{"type":"array","items":{"type":"object","description":"The details of the descriptions of operations in different languages.","properties":{"description":{"type":"string","description":"Description of operations continued by a business.","example":"Entity operation description"},"language":{"type":"object","properties":{"description":{"type":"string","description":"The name of the language in which this business activity was recorded.","example":"English"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this business activity was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":39}},"description":"The details of the language in which this business activity was recorded."}}}},"startDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date the entity chooses to claim as its established date."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This date may be different from the Operations Start Date and adheres to ISO 8601 standard.The date an organization originally commenced operations. If the business was formed to acquire or continue the operations of a pre-existing business, then the Start Date may reflect that original start date. The Start Date is not necessarily the date that the subject was registered/incorporated. If a company registered on 25th August 1930 continues business activities established on 18th June 1815 then the start date is the 1815 date."},"children":[]}]}]}],"example":"2026-10-21T13:37:18Z"},"incorporatedDate":{"type":"string","description":"The date on which a legal form was first registered with the appropriate Government body for this organization.","example":"1987"},"businessEntityType":{"type":"object","properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The text description of the unique code assigned by Dun & Bradstreet for the Legal Form Class."},"children":[]}]}]}],"example":"Corporation"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by D&B to identify the Legal Form Class. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.g. 451 is the Code for Corporation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"197 [Business Entity Type]\" for all possible values."},"children":[]}]}]}],"example":451}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A broad category of an organization structure into which all Legal Forms are grouped. These categories are created by Dun & Bradstreet for client use based on Legal Form association with one and only one Legal Form Class. Legal Form Class is limited to Corporation, Partnership, Proprietorship, National Government, Local Government, Joint Venture, Non Profit Organization, Co-operative / Mutual Organization and Foreign Company as well as a category for Legal Forms that do not fit into an existing Legal Form Class."},"children":[]}]}]}]},"legalForm":{"type":"object","properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The text description of the unique code assigned by Dun & Bradstreet for the Global Legal Form."},"children":[]}]}]}],"example":"Corporation"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by D&B for the Global Legal Form. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 31145 is the Code for Government Agency"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"750 [Global Legal Form]\" for all possible values."},"children":[]}]}]}],"example":31217},"startDate":{"type":"string","description":"The date on which the legal form was registered with the appropriate Government body or recognised by Dun and Bradstreet.","example":"2026-10-21T13:37:18Z"},"registrationLocation":{"type":"object","properties":{"addressRegion":{"type":"string","description":"The name of the geographical area where the organization's Primary Address is located or conducts operations. For Example New Jersey.","example":"California"}},"description":"The details of the address where the Legal Form is registered."}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the structure of an organization, irrespective of the laws of the country or region in which it was formed. Commonly, this structure will be determined when registered with government authorities, however some entities are not required to register. This structure affects how much is paid in taxes, the ability to raise money, the requirements to register and the liability of proprietors. These structure types are universally standardized by Dun & Bradstreet for client use based on Legal Form association with one and only one Global Legal Form. Examples include Joint Stock Company and Limited Liability Company."},"children":[]}]}]}]},"controlOwnershipDate":{"type":"string","description":"The date when the current owners took over the entity.","example":"1985"},"controlOwnershipType":{"type":"object","properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name for the type of controlling ownership (e.g., publicly owned, privately owned, state owned). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For some countries, controlling ownership can be derived from the legal form."},"children":[]}]}]}],"example":"Privately owned"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the type of controlling ownership."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"175 [Control Type]\" for all possible values."},"children":[]}]}]}],"example":9058}},"description":"The details of the type of controlling ownership."},"charterType":{"type":"object","properties":{"description":{"type":"string","description":"The nature of the document identifying the purpose of this entity and its rules of conduct (e.g., municipality charter, local public school charter, medical partnership charter, mutual surety company charter).","example":"Joint tenancy"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the entity's charter type."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"162 [Charter Type]\" for all possible values."},"children":[]}]}]}],"example":2110}},"description":"The details of the entity's charter type."},"isAgent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the entity acts as an agent promoting the goods or services of another entity (e.g., Sales Agent, Purchasing Agent). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity acts as an agent."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity does not act as an agent."},"children":[]}]}]}],"example":false},"isImporter":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the entity is an importer."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity imports a quantity of goods from other countries."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity does not import a quantity of goods from other countries."},"children":[]}]}]}],"example":false},"isExporter":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the entity is an exporter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, the entity exports a quantity of goods to other countries."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, the entity does not export a quantity of goods to other countries."},"children":[]}]}]}],"example":false},"subjectComments":{"type":"array","description":"Records the different facts describing the current situation of the company.","items":{"type":"object","description":"The details of commentary facts describing the current situation of the company.","properties":{"commentDate":{"type":"string","description":"The date on which the comments about the subject was last changed.","example":"2026-10-21T13:37:18Z"},"commentaries":{"type":"array","description":"Records the different facts describing the current situation of the company; e.g., information about address, ownership, trend of credit limit and trend of failure score.","items":{"type":"object","description":"A fact describing the current situation of the company.","properties":{"description":{"type":"string","description":"Text which explains a fact about the current situation of the company; e.g., More than one address change in the last 12 months, One or more changes in directors in last 12 months.","example":"Annual audit exempted"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet that indicates a fact about the current situation of the company; e.g., More than one address change in the last 12 months, One or more changes in directors in last 12 months."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"685 [Subject Commentary]\" for all possible values."},"children":[]}]}]}],"example":37105},"priority":{"type":"integer","description":"A number which is used to define the order in which the special comment code should be presented relative to any other occurrences of the special comment code where the lower the number the earlier the data is presented.","example":1}}}}}}},"registeredDetails":{"type":"object","properties":{"legalForm":{"type":"object","properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The text description of the unique code assigned by D&B for the Legal Form. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example Public Limited Liability Company ."},"children":[]}]}]}],"example":"Corporation (US)"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The  unique code assigned by D&B for the  Legal Form."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.g. 1868 is the Code for Italian Public Limited Liability Company"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"4 [Legal Form]\" for all possible values."},"children":[]}]}]}],"example":7101},"registrationStatus":{"type":"object","properties":{"description":{"type":"string","description":"Status description of the registration with respect to this legal form.","example":"Pending"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the status of the registration with respect to this legal form."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"396 [Registration Status]\" for all possible values."},"children":[]}]}]}],"example":15626}},"description":"The details of the status of the registration with respect to this legal form."},"localLegalForms":{"type":"array","description":"Records the local market representations of the legal forms of the company.","items":{"type":"object","description":"The details of the local market representations of the legal forms of the company.","properties":{"code":{"type":"string","example":"FR1000","description":"The code used as a local market representations of the legal forms of the company."},"description":{"type":"string","example":"Natural persons","description":"The textual description of the local legal form code."},"scheme":{"type":"string","example":"INSEE 4-digit Legal Form Code","description":"The standard in which this local legal form is presented."},"language":{"type":"object","description":"Records the language in which this information is presented. This would be the requested language when available or defaulted to English when description in requested language is not available.","properties":{"description":{"type":"string","example":"English","description":"Text which denotes the language of this information."},"dnbCode":{"type":"integer","example":39,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet to identify the language of this information."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}]}}},"priority":{"type":"integer","description":"Records the order of significance of this entry related to other items in this context.","example":1}}}}},"description":"The details of the structure of an organization according to the laws of the country or region in which it was formed. Commonly, this structure will be determined when registered with government authorities, however some organisations are not required to register. This structure affects how much is paid in taxes, the ability to raise money, the requirements to register and the liability of proprietors. These structure types are unique by country, as similar legal form types can have different interpretations by country or region. Also known as Legal Structure or Business Structure. Examples include Limited Liability Company (US), Private Unlimited Company Without Share Capital (GB) or Limited Responsibility Cooperative (BO)."}},"description":"The details of the constitutional status of the entity as defined under the laws of a country (e.g., Limited Company, Partnership, co-operative Society) and the Stock Equity or share structure employed by the entity according to the legal form and rules of incorporation. The owners of the stock or shares are the owners of the business."},"fiscalYearEnd":{"type":"string","example":"2026-10-21T13:37:18Z","description":"The accounting period end date for the latest financials filed by the company."},"legalEntityIdentifier":{"type":"string","description":"The Legal Entity Identifier (LEI) assigned to the organization.","example":"529900T8BM49AURSDO55"},"numberOfEmployees":{"type":"array","items":{"type":"object","description":"The details of the number of individuals engaged by a business for various purposes, e.g., to perform its business operations.","properties":{"value":{"type":"integer","description":"The number of individuals engaged by a business to perform its various purposes, e.g., business operations, and can include directors, principals and full or part time employees.","example":1234},"minimumValue":{"type":"integer","description":"The minimum number of people engaged by this entity to perform its business operations. The scope of this employee figure is identified in informationScopeDescription.","example":700},"maximumValue":{"type":"integer","description":"The maximum number of people engaged by this entity to perform its business operations. The scope of this employee figure is identified in informationScopeDescription.","example":1500},"employeeFiguresDate":{"type":"string","description":"The date for which the employee figure was reported by the entity.","example":"2026-10-21T13:37:18Z"},"informationScopeDescription":{"type":"string","description":"The organizational scope of the Employee Quantity Values. Employees here means it represents a single organization inclusive of any branches. Employees Total means it represents an organization inclusive of any branches and any subsidiaries.","example":"Consolidated"},"informationScopeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the organizational scope of the Employee Quantity value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"192 [Information Scope]\" for all possible values."},"children":[]}]}]}],"example":9067},"reliabilityDescription":{"type":"string","description":"The integrity of the Employee Quantity Value (e.g., actual, estimated, or modeled).","example":"Actual"},"reliabilityDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the integrity of the Employee Quantity Values."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"171 [Reliability]\" for all possible values."},"children":[]}]}]}],"example":9092},"employeeCategories":{"type":"array","items":{"type":"object","description":"The details of the type of individuals included in the calculation of the Employee Quantity Value.","properties":{"employmentBasisDescription":{"type":"string","description":"The type of individuals that have been included in the calculation of the Employee Quantity Value on the basis of their employment contract (e.g., Directors, Principals, Part Time Workers).","example":"Principals"},"employmentBasisDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the employment basis description."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"77 [Employment Basis]\" for all possible values."},"children":[]}]}]}],"example":9064}}}},"trend":{"type":"array","items":{"type":"object","description":"The details of the employee growth history.","properties":{"timePeriod":{"type":"object","properties":{"description":{"type":"string","description":"The timeframe for which this data is recorded.","example":"1 - 5 years"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the timeframe for which this data is recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"168 [Time Period]\" for all possible values."},"children":[]}]}]}],"example":13721}},"description":"The details of timeframe for which this data is recorded."},"growthRate":{"type":"number","description":"The percentage of change in number of employees from base year compared to the trend year.","example":-7},"value":{"type":"number","description":"The total number of people engaged by an entity to perform its business operations. Several different Employee Figures for the entity may be recorded (e.g., consolidated, individual entity, headquarters only).","example":23.01},"reliabilityDescription":{"type":"string","description":"The integrity of the financial figures.","example":"Audited"},"reliabilityDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the integrity of the financial figures."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"171 [Reliability]\" for all possible values."},"children":[]}]}]}],"example":9092}}}}}}},"financials":{"type":"array","items":{"type":"object","description":"The details of the standardized summary view of the financial results (actual or estimated) for the organization.","properties":{"financialStatementToDate":{"type":"string","description":"The date associated with the financial results. When the values are from a financial statement, it represents the date the accounting period ended. When it is an estimated or modeled value, it is the date on which the data was submitted.","example":"2026-10-21T13:37:18Z"},"financialStatementDuration":{"type":"string","description":"The period of the financial statement expressed as a time interval.","example":"Annual"},"informationScopeDescription":{"type":"string","description":"The organizational scope of the values within the Summary Financials section. Individual means it represents a single organization inclusive of any branches. Consolidated means it represents an organization inclusive of any branches and any subsidiaries.","example":"Consolidated"},"informationScopeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the organizational scope of the Summary Financials values."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"192 [Information Scope]\" for all possible values."},"children":[]}]}]}],"example":9067},"reliabilityDescription":{"type":"string","description":"The integrity of the financial figures present within the Summary Financials section (e.g., actual, estimated, or modeled).","example":"Actual"},"reliabilityDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the integrity of the financial figures present within the Summary Financials section."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"171 [Reliability]\" for all possible values."},"children":[]}]}]}],"example":9092},"unitCode":{"type":"string","description":"The magnitude in which the Summary Financials figures are provided (e.g., in Single Units, Thousands, Millions).","example":"Single Units"},"yearlyRevenue":{"type":"array","items":{"type":"object","description":"The details of the total income attributable to product and services sold by an organization annually.","properties":{"value":{"type":"number","description":"The total income attributable to product and services sold by an organization annually. It may be derived from sales, gross revenue, commissions, billings or a combination of any of these.","example":19945238},"currency":{"type":"string","description":"The three-letter currency code, defined in the ISO 4217 scheme published by the International Organization for Standardization (ISO) identifying the type of money in which this amount is expressed (e.g., USD, CAD, GBP, EUR).","example":"USD"},"minimumValue":{"type":"number","example":22500,"description":"The minimum annual sales figures, when annual sales are expressed as a range."},"maximumValue":{"type":"number","example":250000,"description":"The maximum annual sales figures, when annual sales are expressed as a range."}}}}}}},"banks":{"type":"array","items":{"type":"object","description":"The details of banks or other financial institutions at which the entity has an account.","properties":{"name":{"type":"string","description":"The name of the bank or a financial institution at which the entity has an account.","example":"Bank of My Country"},"telephone":{"type":"array","items":{"type":"object","description":"The details of the Telephone contact information used for voice communication with the organization.","properties":{"telephoneNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The primary voice telephone number for the business, when dialing domestically. The National Telephone Number is created by combining the Domestic Area Code and the Local Number."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Domestic Area Code is a series of numbers that must be prefixed before dialing a telephone number in another local area. National telecommunication authorities use various formats and dialing rules for area codes. Also known as City Code."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Local Number is a series of numbers that represents a specific telephone line."},"children":[]}]}]}],"example":"6505550000"}}}},"address":{"type":"object","properties":{"addressLocality":{"type":"object","properties":{"name":{"type":"string","description":"The name of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc.","example":"SAN FRANCISCO"}},"description":"The details of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc."},"addressRegion":{"type":"object","properties":{"name":{"type":"string","description":"The name of the geographical area where the organization's Primary Address is located or conducts operations. For Example New Jersey.","example":"California"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the type of geographical area where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different markets have their own way of subdividing the country into smaller parts. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Departments (France)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"States (USA)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces (Netherlands)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counties (UK)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundeslander (Germany)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces and Territories (Canada)"},"children":[]}]}]}]},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postal code of the organization's Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known locally in various English-speaking countries throughout the world as a postcode, post code, Eircode, PIN or ZIP Code) is a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail. The code is used by the country's postal authority to identify the address where the organization is located or conducts operations ."},"children":[]}]}]}],"example":"941109999"},"streetAddress":{"type":"object","properties":{"line1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the Primary Address where the organization is located or conducts operations. For example The Point in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"492 KOLLER ST"},"line2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the Primary Address where the organization is located or conducts operations"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"Suite 100"}},"description":"The details of the street address where the organization's Primary Address is located."}},"description":"The details of the Primary Address at which the organization is located or conducts operations."},"registrationNumbers":{"type":"array","items":{"type":"object","description":"The details of the organization's identifiers issued by a recognized external authority to uniquely identify subjects. The issuing authority may be a Registration Authority, Government Department or Commercial Enterprise (e.g., Chamber of Commerce numbers, VAT numbers).","properties":{"registrationNumber":{"type":"string","description":"The number or alphanumeric value assigned by a recognized external authority that either uniquely identifies or helps to identify the organization.","example":"12-3456789"}}}}}}},"isSmallBusiness":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the business qualifies as small business, eligible for assistance from SBA, with a place of business located in the United States. It must operate primarily within the United States or make a significant contribution to the U.S. economy through payment of taxes or use of American products, materials or labor. Together with its affiliates, it must meet the numerical size standards as defined in the Small Business Size Regulations 13 CFR 121."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, indicates that this is a small business."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, indicates that this is not a small business"},"children":[]}]}]}],"example":true},"isStandalone":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the entity is a member of a legal family tree. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If true, indicates that the entity is not a member of a legal family tree. This means it cannot play any family tree role and corporateLinkage will not be present."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If false, indicates that the entity is a member of a legal family tree. The roles it plays is indicated by Family Tree Member Roles played."},"children":[]}]}]}],"example":false},"globalUltimate":{"type":"object","properties":{"numberOfEmployees":{"type":"array","items":{"type":"object","description":"The details of the number of individuals engaged by a business for various purposes, e.g., to perform its business operations.","properties":{"value":{"type":"integer","description":"The number of individuals engaged by a business to perform its various purposes, e.g., business operations, and can include directors, principals and full or part time employees.","example":1234},"minimumValue":{"type":"integer","description":"The minimum number of people engaged by this entity to perform its business operations. The scope of this employee figure is identified in informationScopeDescription.","example":700},"maximumValue":{"type":"integer","description":"The maximum number of people engaged by this entity to perform its business operations. The scope of this employee figure is identified in informationScopeDescription.","example":1500},"employeeFiguresDate":{"type":"string","description":"The date for which the employee figure was reported by the entity.","example":"2026-10-21T13:37:18Z"},"informationScopeDescription":{"type":"string","description":"The organizational scope of the Employee Quantity Values. Employees here means it represents a single organization inclusive of any branches. Employees Total means it represents an organization inclusive of any branches and any subsidiaries.","example":"Consolidated"},"informationScopeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the organizational scope of the Employee Quantity value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"192 [Information Scope]\" for all possible values."},"children":[]}]}]}],"example":9067},"reliabilityDescription":{"type":"string","description":"The integrity of the Employee Quantity Value (e.g., actual, estimated, or modeled).","example":"Actual"},"reliabilityDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the integrity of the Employee Quantity Values."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"171 [Reliability]\" for all possible values."},"children":[]}]}]}],"example":9092}}}},"financials":{"type":"array","items":{"type":"object","description":"The details of the standardized summary view of the financial results (actual or estimated) for the organization.","properties":{"yearlyRevenue":{"type":"array","items":{"type":"object","description":"The details of the total income attributable to product and services sold by an organization annually.","properties":{"value":{"type":"number","description":"The total income attributable to product and services sold by an organization annually. It may be derived from sales, gross revenue, commissions, billings or a combination of any of these.","example":19945238},"currency":{"type":"string","description":"The three-letter currency code, defined in the ISO 4217 scheme published by the International Organization for Standardization (ISO) identifying the type of money in which this amount is expressed (e.g., USD, CAD, GBP, EUR).","example":"USD"}}}},"informationScopeDescription":{"type":"string","description":"The organizational scope of the values within the Summary Financials section. Individual means it represents a single organization inclusive of any branches. Consolidated means it represents an organization inclusive of any branches and any subsidiaries.","example":"Consolidated"},"informationScopeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the organizational scope of the Summary Financials values."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"192 [Information Scope]\" for all possible values."},"children":[]}]}]}],"example":9067},"reliabilityDescription":{"type":"string","description":"The integrity of the financial figures present within the Summary Financials section (e.g., actual, estimated, or modeled).","example":"Actual"},"reliabilityDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the integrity of the financial figures present within the Summary Financials section."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"171 [Reliability]\" for all possible values."},"children":[]}]}]}],"example":9092}}}}},"description":"Records the firmograhics information of the Global Ultimate company."},"domesticUltimate":{"type":"object","properties":{"numberOfEmployees":{"type":"array","items":{"type":"object","description":"The details of the number of individuals engaged by a business for various purposes, e.g., to perform its business operations.","properties":{"value":{"type":"integer","description":"The number of individuals engaged by a business to perform its various purposes, e.g., business operations, and can include directors, principals and full or part time employees.","example":1234},"minimumValue":{"type":"integer","description":"The minimum number of people engaged by this entity to perform its business operations. The scope of this employee figure is identified in informationScopeDescription.","example":700},"maximumValue":{"type":"integer","description":"The maximum number of people engaged by this entity to perform its business operations. The scope of this employee figure is identified in informationScopeDescription.","example":1500},"employeeFiguresDate":{"type":"string","description":"The date for which the employee figure was reported by the entity.","example":"2026-10-21T13:37:18Z"},"informationScopeDescription":{"type":"string","description":"The organizational scope of the Employee Quantity Values. Employees here means it represents a single organization inclusive of any branches. Employees Total means it represents an organization inclusive of any branches and any subsidiaries.","example":"Consolidated"},"informationScopeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the organizational scope of the Employee Quantity value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"192 [Information Scope]\" for all possible values."},"children":[]}]}]}],"example":9067},"reliabilityDescription":{"type":"string","description":"The integrity of the Employee Quantity Value (e.g., actual, estimated, or modeled).","example":"Actual"},"reliabilityDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the integrity of the Employee Quantity Values."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"171 [Reliability]\" for all possible values."},"children":[]}]}]}],"example":9092}}}},"financials":{"type":"array","items":{"type":"object","description":"The details of the standardized summary view of the financial results (actual or estimated) for the organization.","properties":{"yearlyRevenue":{"type":"array","items":{"type":"object","description":"The details of the total income attributable to product and services sold by an organization annually.","properties":{"value":{"type":"number","description":"The total income attributable to product and services sold by an organization annually. It may be derived from sales, gross revenue, commissions, billings or a combination of any of these.","example":19945238},"currency":{"type":"string","description":"The three-letter currency code, defined in the ISO 4217 scheme published by the International Organization for Standardization (ISO) identifying the type of money in which this amount is expressed (e.g., USD, CAD, GBP, EUR).","example":"USD"}}}},"informationScopeDescription":{"type":"string","description":"The organizational scope of the values within the Summary Financials section. Individual means it represents a single organization inclusive of any branches. Consolidated means it represents an organization inclusive of any branches and any subsidiaries.","example":"Consolidated"},"informationScopeDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the organizational scope of the Summary Financials values."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"192 [Information Scope]\" for all possible values."},"children":[]}]}]}],"example":9067},"reliabilityDescription":{"type":"string","description":"The integrity of the financial figures present within the Summary Financials section (e.g., actual, estimated, or modeled).","example":"Actual"},"reliabilityDnBCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the integrity of the financial figures present within the Summary Financials section."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"171 [Reliability]\" for all possible values."},"children":[]}]}]}],"example":9092}}}}},"description":"Records the firmograhics information of the Domestic Ultimate company."},"organizationSizeCategory":{"type":"object","properties":{"description":{"type":"string","description":"The description of the company size.","example":"Medium"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the company size."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"493 [Organization Size Category]\" for all possible values."},"children":[]}]}]}],"example":20548}},"description":"The details about the entity's size. The size of an entity is determined using factors such as the net worth, total employee quantity, and sales amount."},"employerDesignation":{"type":"object","properties":{"scoreDate":{"type":"string","description":"The date when this score was calculated.","example":"2026-10-21T13:37:18Z"},"indexScore":{"type":"number","description":"Underlying score (0 to 1) that determines Employment Classification for Modeled Classification, where higher scores are assigned as Employers and lower scores assigned as Non-Employers.","example":0.3},"designation":{"type":"object","properties":{"description":{"type":"string","description":"Text that denotes the classification derived based on the data available for this organization.","example":"Employer"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet that denotes the classification derived based on the data available for this organization."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"825 [Employer Designation]\" for all possible values."},"children":[]}]}]}],"example":36133}},"description":"Records the classification derived based on the data available for this organization."},"reliability":{"type":"object","properties":{"description":{"type":"string","description":"Text that records the reliability of employer designation type; e.g., audited, actual, estimated, modeled.","example":"Actual"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet that records the reliability of employer designation type; e.g., audited, actual, estimated, modeled."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"171 [Reliability]\" for all possible values."},"children":[]}]}]}],"example":9092}},"description":"Records the reliability of this figure definition; e.g., audited, actual, estimated, modeled."}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three category classification of a business in relation to its employment status: Non-employers, Employers, and Holding Companies. Non-employers are businesses that have no paid employees, including self-employed individuals operating unincorporated business (sole proprietors). Non-employers constitute most active DUNS in the D&B Data Cloud. Employers are businesses that have paid employees. Some employers have complex corporate ownership structures, where some entities exist for the purpose of controlling companies or holding assets, such as real estate, patents, or stocks. These entities, classified as Holding Companies, have very few or no employees and does not conduct any operations or active tasks. This newly created classification provides D&B customers with improved targeting of businesses relevant to their use case."},"children":[]}]}]}]},"preferredLanguage":{"type":"object","properties":{"description":{"type":"string","description":"Text defining the language in which the organization prefers to do business.","example":"English"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet, defining the language in which the organization prefers to do business."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":39}},"description":"Records the language in which the organization prefers to do business."},"multiLingualSearchNames":{"type":"array","items":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records the names in different languages created by D&B to facilitate name matching."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A name created by D&B to facilitate name matching."},"children":[]}]}]}],"example":"GORMAN"},"language":{"type":"object","properties":{"description":{"type":"string","description":"Text that records the language in which this information was recorded.","example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet that records the language in which this information was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":3807}},"description":"Records the language in which this information was recorded."},"writingScript":{"type":"object","properties":{"description":{"type":"string","description":"Text denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji.","example":"Kana"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"466 [Writing Script]\" for all possible values."},"children":[]}]}]}],"example":19347}},"description":"Records the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."}}}},"imperialCalendarStartYear":{"type":"string","description":"This is the year in which the operations undertaken by the subject were first started, expressed in terms of Japanese Emperial calendar eg.Bunkyu 1st year","example":1861},"investigationDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the data for this company was last investigated by D&B."},"children":[]}]}]}],"example":"2026-10-21T13:37:18Z"},"tsrReportDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latest investigation date of the company information of Tokyo Shoko Research [TSR] Report."},"children":[]}]}]}],"example":"2026-10-21T13:37:18Z"},"businessTrustIndex":{"type":"object","properties":{"scoreDate":{"type":"string","description":"The date when this score was calculated.","example":"2026-10-21T13:37:18Z"},"trustIndex":{"type":"number","description":"Index ranging from 0 to 1 representing the likelihood of a business record being created to enable the company to continue doing business with the government while obfuscating a past violation, debarment, or novation fraud.  1 indicates the highest likelihood  and 0 indicates the lowest","example":0.4},"trustClass":{"type":"object","properties":{"description":{"type":"string","description":"Textual description of the score representing likelihood of a business record being created to enable the company to continue doing business with the government while obfuscating a past violation, debarment, or novation fraud.","example":"Low"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet, representing the likelihood of a business record being created to enable the company to continue doing business with the government while obfuscating a past violation, debarment, or novation fraud."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"354 [Range Position]\" for all possible values."},"children":[]}]}]}],"example":13693}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 5 class score (Lowest Risk to Highest Risk) representing the likelihood of a business record being created to enable the company to continue doing business with the government while obfuscating a past violation, debarment, or novation fraud."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13693 = 1 (Lowest Risk)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13694 = 2 (Low Risk)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13695 = 3 (Moderate Risk)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13700 = 4 (High Risk)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13702 = 5 (Higest Risk)"},"children":[]}]}]}]},"nationalPercentile":{"type":"number","description":"A numerical value between 1 to 100 as a percentile score representing likelihood of a business record being created to enable the company to continue doing business with the government while obfuscating a past violation, debarment, or novation fraud, where 100 indicates highest likelihood and 1 indicates lowest.","example":75},"dataProvider":{"type":"object","properties":{"description":{"type":"string","description":"Details on the data source from which the excluded business was drawn from.","example":"Debarment"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the data source from which the excluded business was drawn from."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"36140 = DEBARMENT "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"35904 = OFCCP "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24144 = ERCR"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"29 [Data Provider]\" for all possible values."},"children":[]}]}]}],"example":36140}},"description":"Data source from which the excluded business was drawn from."},"scoreReasons":{"type":"array","items":{"type":"object","description":"The highest contributing factor to attach the Active DUNS to the Excluded DUNS.","properties":{"description":{"type":"string","description":"Textual description of the highest contributing factor to attach the Active DUNS to the Excluded DUNS.","example":"The subject's URL is found to have a similar match in D&B's repository of high risk businesses."},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet, representing the highest contributing factor to attach the Active DUNS to the Excluded DUNS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11111 = TELEPHONE NUMBER"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"22222 = URL"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"33333 = BUSINESS NAME"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"27677 = HIGH RISK INDIVIDUAL"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"27647 = HIGH_RISK_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"44444 = CEO_NAME"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"55555 = FIRST_EXECUTIVE_NAME"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"66666 = CEO_FE_NAME"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"77777 = BUSINESS_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"88888 = LAST_NAME"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"99999 = LINKAGE"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"173 [Score Commentary]\" for all possible values."},"children":[]}]}]}],"example":11111}}}},"excludedOrganization":{"type":"object","properties":{"duns":{"type":"string","description":"The D-U-N-S Number of the debarred/high risk business with highest value of Business Trust Index with the scored DUNS.","example":"804735132"},"name":{"type":"string","description":"Single name by which debarred/high risk business with highest value of Business Trust Index with the scored DUNS is primarily known or identified.","example":"GORMAN MANUFACTURING COMPANY, INC."},"address":{"type":"object","properties":{"streetAddressLines":{"type":"array","items":{"type":"object","description":"Primary street address details of the debarred/high risk business with highest value of Business Trust Index with the scored DUNS.","properties":{"line1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the Primary Address where the organization is located or conducts operations. For example The Point in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"The Point"}}}}},"description":"Primary address of the debarred/high risk business with highest value of Business Trust Index with the scored DUNS."}},"description":"Business name of the debarred/high risk business with highest value of Business Trust Index with the scored DUNS."}},"description":"Records the likelihood of a business attempting evasion."},"securitiesReportID":{"type":"string","description":"The reference identifier of the document that states the trade name of the company, financial conditions of the corporate group to which the company belongs and other important matters concerning the company's business.","example":"E04991"},"corporateLinkage":{"type":"object","properties":{"familytreeRolesPlayed":{"type":"array","items":{"type":"object","description":"The details of the roles the entity plays as a member of an ownership structured family tree.","properties":{"description":{"type":"string","description":"The role the entity plays as a member of an ownership structured family tree (e.g., a branch, division, a parent, headquarters, subsidiary, global ultimate, domestic ultimate).","example":"Parent/Headquarters"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify describing family tree role."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"202 [Family Tree Role]\" for all possible values."},"children":[]}]}]}],"example":9141}}}},"hierarchyLevel":{"type":"integer","description":"The number of family-tree levels below the global ultimate the entity is in its corporate hierarchy. The hierarchy level value of the global ultimate will always be 1. Each subsidiary level below the global ultimate is incremented by 1. Branch locations in a family tree will have the same hierarchy code as its associated headquarter.","example":1},"globalUltimateFamilyTreeMembersCount":{"type":"integer","description":"The total number of entities in the entity's Family tree starting from Global Ultimate.","example":9000},"branchesCount":{"type":"integer","description":"The total number of branch companies that report to the subject in the family tree.","example":27},"globalUltimate":{"type":"object","properties":{"duns":{"type":"string","description":"The unique identification number assigned by Dun and Bradstreet identifying the top most organisation in the family tree.","example":"804735132"},"primaryName":{"type":"string","description":"Single name by which the organization is primarily known or identified.","example":"GORMAN MANUFACTURING COMPANY, INC."},"primaryAddress":{"type":"object","properties":{"addressCountry":{"type":"object","properties":{"name":{"type":"string","description":"The Country or Region where the organization's Primary Address is located or conducts operations .","example":"United States"},"isoAlpha2Code":{"type":"string","description":"The 2 letter alpha country code assigned by the International Organization for Standardization (ISO) identifying the Country/Region where the organization's Primary address is located or conducts operations .","example":"US"}},"description":"The details of the country or region where the address of the organization is located or conducts operations."},"continentalRegion":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continent where the Primary Address of the organization is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"South America"},"children":[]}]}]}],"example":"North America"}},"description":"The details of the Continent in which the Primary Address of the organisation is located or conducts operations."},"addressLocality":{"type":"object","properties":{"name":{"type":"string","description":"The name of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc.","example":"SAN FRANCISCO"}},"description":"The details of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc."},"addressRegion":{"type":"object","properties":{"name":{"type":"string","description":"The name of the geographical area where the organization's Primary Address is located or conducts operations. For Example New Jersey.","example":"California"},"abbreviatedName":{"type":"string","description":"The shortened name of the geographical area where the organization's Primary Address is located or conducts operations For example NJ for the US State New Jersey within Country United States.","example":"CA"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the type of geographical area where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different markets have their own way of subdividing the country into smaller parts. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Departments (France)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"States (USA)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces (Netherlands)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counties (UK)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundeslander (Germany)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces and Territories (Canada)"},"children":[]}]}]}]},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postal code of the organization's Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known locally in various English-speaking countries throughout the world as a postcode, post code, Eircode, PIN or ZIP Code) is a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail. The code is used by the country's postal authority to identify the address where the organization is located or conducts operations ."},"children":[]}]}]}],"example":"941109999"},"streetAddress":{"type":"object","properties":{"line1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the Primary Address where the organization is located or conducts operations. For example The Point in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"492 KOLLER ST"},"line2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the Primary Address where the organization is located or conducts operations"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"Suite 100"}},"description":"The details of the street address where the organization's Primary Address is located."}},"description":"The details of the Primary Address at which the organization is located or conducts operations."}},"description":"The details of the top most organizationin the family tree, tracing each parent up to its own parent. For example, organizationA is based in the US and has organizationB as its parent also in the US. In turn organizationB is owned by organizationC, also in the US, which is owned by organizationD which is in the UK. Thus, the Global Ultimate of this family tree (and therefore of each member of the family tree) is organization D."},"domesticUltimate":{"type":"object","properties":{"duns":{"type":"string","description":"The D-U-N-S number of the highest ranking member of a family tree within the same country/region within a limb of a family tree.","example":"804735132"},"primaryName":{"type":"string","description":"Single name by which the organization is primarily known or identified.","example":"GORMAN MANUFACTURING COMPANY, INC."},"primaryAddress":{"type":"object","properties":{"addressCountry":{"type":"object","properties":{"name":{"type":"string","description":"The Country or Region where the organization's Primary Address is located or conducts operations .","example":"United States"},"isoAlpha2Code":{"type":"string","description":"The 2 letter alpha country code assigned by the International Organization for Standardization (ISO) identifying the Country/Region where the organization's Primary address is located or conducts operations .","example":"US"}},"description":"The details of the country or region where the address of the organization is located or conducts operations."},"continentalRegion":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continent where the Primary Address of the organization is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"South America"},"children":[]}]}]}],"example":"North America"}},"description":"The details of the Continent in which the Primary Address of the organisation is located or conducts operations."},"addressLocality":{"type":"object","properties":{"name":{"type":"string","description":"The name of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc.","example":"SAN FRANCISCO"}},"description":"The details of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc."},"addressRegion":{"type":"object","properties":{"name":{"type":"string","description":"The name of the geographical area where the organization's Primary Address is located or conducts operations. For Example New Jersey.","example":"California"},"abbreviatedName":{"type":"string","description":"The shortened name of the geographical area where the organization's Primary Address is located or conducts operations For example NJ for the US State New Jersey within Country United States.","example":"CA"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the type of geographical area where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different markets have their own way of subdividing the country into smaller parts. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Departments (France)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"States (USA)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces (Netherlands)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counties (UK)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundeslander (Germany)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces and Territories (Canada)"},"children":[]}]}]}]},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postal code of the organization's Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known locally in various English-speaking countries throughout the world as a postcode, post code, Eircode, PIN or ZIP Code) is a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail. The code is used by the country's postal authority to identify the address where the organization is located or conducts operations ."},"children":[]}]}]}],"example":"941109999"},"streetAddress":{"type":"object","properties":{"line1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the Primary Address where the organization is located or conducts operations. For example The Point in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"492 KOLLER ST"},"line2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the Primary Address where the organization is located or conducts operations"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"Suite 100"}},"description":"The details of the street address where the organization's Primary Address is located."}},"description":"The details of the Primary Address at which the organization is located or conducts operations."}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the highest ranking member of a family tree within the same country/region within a limb of a family."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, Company A is based in the US and has Company B as its parent also in the US. In turn Company B is owned by Company C, also in the US, which is owned by Company D which is in the UK. Thus, the Domestic Ultimate of Company A is actually Company C as this is the last entity in the parent chain that is in the US."},"children":[]}]}]}]},"parent":{"type":"object","properties":{"duns":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The D-U-N-S number of the organization that owns more than 50% of the subject organization."},"children":[]}]}]}],"example":"804735132"},"primaryName":{"type":"string","description":"Single name by which the organization is primarily known or identified.","example":"GORMAN MANUFACTURING COMPANY, INC."},"primaryAddress":{"type":"object","properties":{"addressCountry":{"type":"object","properties":{"name":{"type":"string","description":"The Country or Region where the organization's Primary Address is located or conducts operations .","example":"United States"},"isoAlpha2Code":{"type":"string","description":"The 2 letter alpha country code assigned by the International Organization for Standardization (ISO) identifying the Country/Region where the organization's Primary address is located or conducts operations .","example":"US"}},"description":"The details of the country or region where the address of the organization is located or conducts operations."},"continentalRegion":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continent where the Primary Address of the organization is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"South America"},"children":[]}]}]}],"example":"North America"}},"description":"The details of the Continent in which the Primary Address of the organisation is located or conducts operations."},"addressLocality":{"type":"object","properties":{"name":{"type":"string","description":"The name of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc.","example":"SAN FRANCISCO"}},"description":"The details of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc."},"addressRegion":{"type":"object","properties":{"name":{"type":"string","description":"The name of the geographical area where the organization's Primary Address is located or conducts operations. For Example New Jersey.","example":"California"},"abbreviatedName":{"type":"string","description":"The shortened name of the geographical area where the organization's Primary Address is located or conducts operations For example NJ for the US State New Jersey within Country United States.","example":"CA"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the type of geographical area where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different markets have their own way of subdividing the country into smaller parts. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Departments (France)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"States (USA)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces (Netherlands)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counties (UK)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundeslander (Germany)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces and Territories (Canada)"},"children":[]}]}]}]},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postal code of the organization's Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known locally in various English-speaking countries throughout the world as a postcode, post code, Eircode, PIN or ZIP Code) is a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail. The code is used by the country's postal authority to identify the address where the organization is located or conducts operations ."},"children":[]}]}]}],"example":"941109999"},"streetAddress":{"type":"object","properties":{"line1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the Primary Address where the organization is located or conducts operations. For example The Point in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"492 KOLLER ST"},"line2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the Primary Address where the organization is located or conducts operations"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"Suite 100"}},"description":"The details of the street address where the organization's Primary Address is located."}},"description":"The details of the Primary Address at which the organization is located or conducts operations."}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the organization that owns more than 50% of the subject organization."},"children":[]}]}]}]},"headQuarter":{"type":"object","properties":{"duns":{"type":"string","description":"The D-U-N-S number of the Headquarters organization  that serves as the administrative office for its branches.","example":"804735132"},"primaryName":{"type":"string","description":"Single name by which the organization is primarily known or identified.","example":"GORMAN MANUFACTURING COMPANY, INC."},"primaryAddress":{"type":"object","properties":{"addressCountry":{"type":"object","properties":{"name":{"type":"string","description":"The Country or Region where the organization's Primary Address is located or conducts operations .","example":"United States"},"isoAlpha2Code":{"type":"string","description":"The 2 letter alpha country code assigned by the International Organization for Standardization (ISO) identifying the Country/Region where the organization's Primary address is located or conducts operations .","example":"US"}},"description":"The details of the country or region where the address of the organization is located or conducts operations."},"continentalRegion":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the continent where the Primary Address of the organization is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Africa"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asia Pacific"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Europe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"North America"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle East"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"South America"},"children":[]}]}]}],"example":"North America"}},"description":"The details of the Continent in which the Primary Address of the organisation is located or conducts operations."},"addressLocality":{"type":"object","properties":{"name":{"type":"string","description":"The name of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc.","example":"SAN FRANCISCO"}},"description":"The details of the locality where the organization's Primary Address is located or conducts operations. Locality defined as a district population cluster. City, town, township, village, borough etc."},"addressRegion":{"type":"object","properties":{"name":{"type":"string","description":"The name of the geographical area where the organization's Primary Address is located or conducts operations. For Example New Jersey.","example":"California"},"abbreviatedName":{"type":"string","description":"The shortened name of the geographical area where the organization's Primary Address is located or conducts operations For example NJ for the US State New Jersey within Country United States.","example":"CA"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the type of geographical area where the organization's Primary Address is located or conducts operations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different markets have their own way of subdividing the country into smaller parts. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Departments (France)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"States (USA)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces (Netherlands)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counties (UK)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundeslander (Germany)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provinces and Territories (Canada)"},"children":[]}]}]}]},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postal code of the organization's Primary Address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known locally in various English-speaking countries throughout the world as a postcode, post code, Eircode, PIN or ZIP Code) is a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail. The code is used by the country's postal authority to identify the address where the organization is located or conducts operations ."},"children":[]}]}]}],"example":"941109999"},"streetAddress":{"type":"object","properties":{"line1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address where the entity is located."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the Primary Address where the organization is located or conducts operations. For example The Point in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"492 KOLLER ST"},"line2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the Primary Address where the organization is located or conducts operations"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example 37 North Wharf Road in the address"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Point"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37 North Wharf Road"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W2 1AF"},"children":[]}]}]}],"example":"Suite 100"}},"description":"The details of the street address where the organization's Primary Address is located."}},"description":"The details of the Primary Address at which the organization is located or conducts operations."}},"description":"The details of the organization that serves as the administrative office for its branches."},"branches":{"type":"array","items":{"type":"object","description":"Records the entities with a valid linkage/association to a business record which is its Headquarters.","properties":{"multiLingualNames":{"type":"array","items":{"type":"object","description":"The details of the name by which the entity is primarily known or identified presented in multiple languages.","properties":{"name":{"type":"string","description":"The name by which the entity is primarily known or identified.","example":"GORMAN"},"language":{"type":"object","properties":{"description":{"type":"string","description":"The language in which this name was recorded.","example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this address was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":39}},"description":"The details of the language in which this name was recorded."}}}}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of organization to organization relationships based on majority ownership or control (>50%). There are two types of relationships, branch/division to Headquarter and Subsidiary to Parent."},"children":[]}]}]}]},"industrialPlantsCount":{"type":"integer","description":"The number of facilities necessary for an industrial or manufacturing operation i.e. the equipment, including machinery, tools, instruments, and fixtures and the buildings containing them.","example":23},"principalsSummary":{"type":"object","properties":{"currentPrincipalsCount":{"type":"integer","description":"The number of current principals that are associated with the entity.","example":10},"otherAssociationsCount":{"type":"integer","description":"The number of relationships where the active principals are associated with other companies currently or in the past.","example":4},"inactiveAssociationsCount":{"type":"integer","description":"The number of relationships where the active principals are associated with other companies that are out of business.","example":7},"unfavorableInactiveAssociationsCount":{"type":"integer","description":"The number of relationships where the principals are associated with other companies that was involved in an unfavorable bankruptcy event.","example":5},"favorableInactiveAssociationsCount":{"type":"integer","description":"The number of relationships where the principals are associated with other companies that was involved in a favorable bankruptcy event.","example":2},"detrimentalPrincipalsCount":{"type":"integer","description":"The number of principals that are associated with negative legal events.","example":2},"detrimentalPrincipalsPercentage":{"type":"number","description":"The percentage of total active principals that are associated with negative legal events.","example":20}},"description":"The summary information for the principals associated with the entity."},"currentPrincipals":{"type":"array","items":{"type":"object","description":"The detail of the person identified as a key stakeholder of the business or organization by the local registry or other official sources. The key stakeholder can be a natural person or an organization. Unless clearly defined as \"former\" or \"most senior\"  the definitions below refer to the current key stakeholder.","properties":{"givenName":{"type":"string","description":"The given name of the key stakeholder who is an individual. In western cultures this is usually presented first.","example":"Leslie"},"middleName":{"type":"string","description":"Additional name associated to the key stakeholder to distinguish them from other people with the same given name and surname. In several cultures, the middle name is a portion of a personal name that is written between the key stakeholder's given name and their surname. In some countries such as the US, a single letter can be populated in this field.","example":"Ann"},"familyName":{"type":"string","description":"The family or surname of the key stakeholder who is an individual. In western cultures this is usually presented last.","example":"Smith"},"fullName":{"type":"string","description":"The key stakeholder's given and surname in addition to the middle name and name suffix (when available) listed on one field if the key stakeholder is an individual. This will be submitted in the appropriate format for the local country. If the key stakeholder is an organization, the name of the organization will be populated in the full name field.","example":"Leslie Ann Smith"},"namePrefix":{"type":"string","description":"The correct form of address for the key stakeholder (e.g., Dr., Professor, Lord).","example":"Dr."},"nameSuffix":{"type":"string","description":"Letters listed after the key stakeholder's last name to provide additional details about the person's family generation(e.g., Senior, Junior, III. ) or their professional/qualification (e.g., MD, PhD etc.) Populated when available.","example":"PhD"},"associationStartDate":{"type":"string","description":"The date when this principal first became a principal of the subject. This is not necessarily the date that the principal first took up their current position.","example":"2026-10-21T13:37:18Z"},"otherLanguageNames":{"type":"array","items":{"type":"object","description":"Records the names of the principal in other languages.","properties":{"givenName":{"type":"string","description":"Records the first name of the principal in other languages.","example":"Leslie"},"familyName":{"type":"string","description":"Records the last name of the principal in other languages.","example":"Smith"},"fullName":{"type":"string","description":"The full name of the current principal in language other than English.","example":"许家印"},"language":{"type":"object","description":"The details of the language in which this name was recorded.","properties":{"description":{"type":"string","description":"The name of the language in which this name was recorded.","example":"English"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the language in which this name was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":39}}},"writingScript":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records the type of writing system for the language that was used in recording this name. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]}]}]}],"properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text denoting the type of writing system for the language that was used in recording this name. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]}]}]}],"example":"Kana"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet denoting the type of writing system for the language that was used in recording this name. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"466 [Writing Script]\" for all possible values."},"children":[]}]}]}],"example":19347}}}}}},"gender":{"type":"object","properties":{"description":{"type":"string","description":"Text description of the binary classification or unknown classification based on the key stakeholder's personal identity when key stakeholder is an individual.","example":"Female"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the male/female binary classification or unknown classification when the key stakeholder is an individual."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- 190: Male"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- 191: Female"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- 3581: not specified"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"18 [Gender]\" for all possible values."},"children":[]}]}]}],"example":191}},"description":"The detail of the binary classification or unknown classification based on the key stakeholder's personal identity when key stakeholder is an individual."},"jobTitles":{"type":"array","items":{"type":"object","description":"The detail of the text string that denotes a position held by the key stakeholder in the organization or recording of the title used by the organization to describe this person's job e.g., Leader Global Communication, Manager National Technical Support Center.","properties":{"title":{"type":"string","description":"Text string that denotes a position held by the key stakeholder in the organization or recording of the title used by the organization to describe this person's job e.g., Leader Global Communication, Manager National Technical Support Center.","example":"President"}}}},"managementResponsibilities":{"type":"array","items":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the standardized alphanumeric classification code generated by Dun & Bradstreet used to identify the business function and hierarchical level of the key stakeholder based on their professional job title."},"children":[]}]}]}],"properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text description of the standardized alphanumeric classification code generated by Dun & Bradstreet that identifies the business function and hierarchical level of the key stakeholder based on their professional job title."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example \" Chief Executive Officer\" in"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A1A7 Chief Executive Officer"},"children":[]}]}]}],"example":"President"},"mrcCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A standardized alphanumeric classification code generated by Dun & Bradstreet that identifies the business function of the key stakeholder based on the associated job title data. This information is expressed as a standard Management Responsibility Code (MRC)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example \" A1A7\" in"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A1A7 Chief Executive Officer"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"27751[MRC]\" for all possible values."},"children":[]}]}]}],"example":"A1A6"}}}},"idNumbers":{"type":"array","items":{"type":"object","description":"The details of the identification/registration numbers for the key stakeholder of the business or organization.","properties":{"idNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number assigned by an external body or by Dun & Bradstreet which either uniquely identifies or helps to identify the key stakeholder of the business or organization."},"children":[]}]}]}],"example":"11356097"},"idType":{"type":"object","properties":{"description":{"type":"string","description":"Text that identifies the type of \"Principal Identification Number\", e.g., Social Security Number.","example":"Super Person ID"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet that identifies the type of \"Principal Identification Number\", e.g., Social Security Number."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"7 [Registration Number Type]\" for all possible values."},"children":[]}]}]}],"example":11694}},"description":"The details that identifies the type of key stakeholder Identification Number, e.g., Social Security Number."}}}}}}},"mostSeniorPrincipals":{"type":"array","items":{"type":"object","description":"The person identified as a highest ranking key stakeholder of a business or organization by the local registry or other official sources. A key stakeholder can be a natural person or an organization.","properties":{"givenName":{"type":"string","description":"The given name of the highest ranking key stakeholder who is an individual. In western cultures this is usually presented first.","example":"Leslie"},"middleName":{"type":"string","description":"Additional name associated to the highest ranking key stakeholder to distinguish them from other people with the same given name and surname. In several cultures, the middle name is a portion of a personal name that is written between the highest ranking key stakeholder's given name and their surname. In some countries such as the US, a single letter can be populated in this field.","example":"Ann"},"familyName":{"type":"string","description":"The family or surname of the highest ranking key stakeholder who is an individual. In western cultures this is usually presented last.","example":"Smith"},"fullName":{"type":"string","description":"The highest ranking key stakeholder's given and surname in addition to the middle name and name suffix (when available) listed on one field if the key stakeholder is an individual. This will be submitted in the appropriate format for the local country. If the highest ranking key stakeholder is an organization, the name of the organization will be populated in the full name field.","example":"Leslie Ann Smith"},"namePrefix":{"type":"string","description":"The correct form of address for the highest ranking key stakeholder (e.g., Dr., Professor, Lord).","example":"Dr."},"nameSuffix":{"type":"string","description":"Letters listed after the highest ranking key stakeholder's last name to provide additional details about the person's family generation(e.g., Senior, Junior, III. ) or their professional/qualification (e.g., MD, PhD etc.) Populated when available.","example":"PhD"},"associationStartDate":{"type":"string","description":"The date when this principal first became a principal of the subject. This is not necessarily the date that the principal first took up their current position.","example":"2026-10-21T13:37:18Z"},"otherLanguageNames":{"type":"array","items":{"type":"object","description":"Records the names of the principal in other languages.","properties":{"givenName":{"type":"string","description":"Records the first name of the principal in other languages.","example":"Leslie"},"familyName":{"type":"string","description":"Records the last name of the principal in other languages.","example":"Smith"},"fullName":{"type":"string","description":"The full name of the most senior principal in other local languages.","example":"Leslie Smith"},"language":{"type":"object","properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text that records the language in which this information was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet that records the language in which this information was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":3807}},"description":"Records the language in which this information was recorded."},"writingScript":{"type":"object","properties":{"description":{"type":"string","description":"Text denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji.","example":"Kana"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"466 [Writing Script]\" for all possible values."},"children":[]}]}]}],"example":19347}},"description":"Records the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."}}}},"gender":{"type":"object","properties":{"description":{"type":"string","description":"Text description of the binary classification or unknown classification based on the highest ranking key stakeholder's personal identity when key stakeholder is an individual.","example":"Female"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify to define the male/female binary classification or unknown classification when the highest ranking key stakeholder is an individual."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- 190: Male"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- 191: Female"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- 3581: not specified"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"18 [Gender]\" for all possible values."},"children":[]}]}]}],"example":191}},"description":"The detail of the binary classification or unknown classification based on the highest ranking key stakeholder's personal identity when key stakeholder is an individual."},"jobTitles":{"type":"array","items":{"description":"Text string that denotes a position held by the highest ranking key stakeholder in the organization or recording of the title used by the organization to describe this person's job e.g., Leader Global Communication, Manager National Technical Support Center.","properties":{"title":{"type":"string","example":"President","description":"Text string that denotes a position held by the key stakeholder in the organization or recording of the title used by the organization to describe this person's job e.g., Leader Global Communication, Manager National Technical Support Center."}},"type":"object"}},"managementResponsibilities":{"type":"array","items":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the standardized alphanumeric classification code generated by Dun & Bradstreet used to identify the business function and hierarchical level of the key stakeholder based on their professional job title."},"children":[]}]}]}],"properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text description of the standardized alphanumeric classification code generated by Dun & Bradstreet that identifies the business function and hierarchical level of the highest ranking key stakeholder of the business or organization based on their professional job title."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example \" Chief Executive Officer\" in"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A1A7 Chief Executive Officer"},"children":[]}]}]}],"example":"President"},"mrcCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A standardized alphanumeric classification code generated by Dun & Bradstreet that identifies the business function of the highest ranking key stakeholder based on the associated job title data. This information is expressed as a standard Management Responsibility Code (MRC)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example \" A1A7\" in"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A1A7 Chief Executive Officer"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"27751[MRC]\" for all possible values."},"children":[]}]}]}],"example":"A1A6"}}}},"idNumbers":{"type":"array","items":{"type":"object","description":"Identification/registration numbers for the highest ranking key stakeholder of the organization.","properties":{"idNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number assigned by an external body or by Dun & Bradstreet which either uniquely identifies or helps to identify the highest ranking key stakeholder of the organization."},"children":[]}]}]}],"example":"11356097"},"idType":{"type":"object","properties":{"description":{"type":"string","description":"Text that identifies the type of \"Principal Identification Number\", e.g., Social Security Number for the highest ranking key stakeholder of the organization","example":"Super Person ID"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet that identifies the type of \"Principal Identification Number\", e.g., Social Security Number for the highest ranking key stakeholder of the organization"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"7 [Registration Number Type]\" for all possible values."},"children":[]}]}]}],"example":11694}},"description":"Identifies the type of \"Principal Identification Number\", e.g., Social Security Number for the highest ranking key stakeholder of the organization."}}}}}}},"mostSeniorPrincipal":{"type":"object","description":"The person identified as a highest ranking key stakeholder of a business or organization by the local registry or other official sources. A key stakeholder can be a natural person or an organization.","properties":{"givenName":{"type":"string","description":"The given name of the highest ranking key stakeholder who is an individual. In western cultures this is usually presented first.","example":"Leslie"},"middleName":{"type":"string","description":"Additional name associated to the highest ranking key stakeholder to distinguish them from other people with the same given name and surname. In several cultures, the middle name is a portion of a personal name that is written between the highest ranking key stakeholder's given name and their surname. In some countries such as the US, a single letter can be populated in this field.","example":"Ann"},"familyName":{"type":"string","description":"The family or surname of the highest ranking key stakeholder who is an individual. In western cultures this is usually presented last.","example":"Smith"},"fullName":{"type":"string","description":"The highest ranking key stakeholder's given and surname in addition to the middle name and name suffix (when available) listed on one field if the key stakeholder is an individual. This will be submitted in the appropriate format for the local country. If the highest ranking key stakeholder is an organization, the name of the organization will be populated in the full name field.","example":"Leslie Ann Smith"},"namePrefix":{"type":"string","description":"The correct form of address for the highest ranking key stakeholder (e.g., Dr., Professor, Lord).","example":"Dr."},"nameSuffix":{"type":"string","description":"Letters listed after the highest ranking key stakeholder's last name to provide additional details about the person's family generation(e.g., Senior, Junior, III. ) or their professional/qualification (e.g., MD, PhD etc.) Populated when available.","example":"PhD"},"associationStartDate":{"type":"string","description":"The date when this principal first became a principal of the subject. This is not necessarily the date that the principal first took up their current position.","example":"2026-10-21T13:37:18Z"},"otherLanguageNames":{"type":"array","description":"Records the names of the principal in other languages.","items":{"type":"object","description":"The details of the principal's name in a specific language with associated language and writing script information.","properties":{"givenName":{"type":"string","description":"Records the first name of the principal in other languages.","example":"アンソニー"},"familyName":{"type":"string","description":"Records the last name of the principal in other languages.","example":"ヴィンシクエラ"},"fullName":{"type":"string","description":"The full name of the most senior principal in other local languages.","example":"浩光 齋藤"},"language":{"type":"object","description":"Records the language in which this information was recorded.","properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text that records the language in which this information was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":"Japanese"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet that records the language in which this information was recorded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"3 [Language]\" for all possible values."},"children":[]}]}]}],"example":3807}}},"writingScript":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]}]}]}],"properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]}]}]}],"example":"Kana"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun&Bradstreet denoting the type of writing system for the language that was used in recording this textual information. For example, textual information recorded in the language 'Japanese' can be written in any of the following scripts: kanji, katakana, hiragana or romaji."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"466 [Writing Script]\" for all possible values."},"children":[]}]}]}],"example":19347}}}}}},"gender":{"type":"object","description":"The detail of the binary classification or unknown classification based on the highest ranking key stakeholder's personal identity when key stakeholder is an individual.","properties":{"description":{"type":"string","description":"Text description of the binary classification or unknown classification based on the highest ranking key stakeholder's personal identity when key stakeholder is an individual.","example":"Female"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify to define the male/female binary classification or unknown classification when the highest ranking key stakeholder is an individual."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- 190: Male"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- 191: Female"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- 3581: not specified"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"18 [Gender]\" for all possible values."},"children":[]}]}]}],"example":191}}},"jobTitles":{"type":"array","description":"Text string that denotes a position held by the highest ranking key stakeholder in the organization or recording of the title used by the organization to describe this person's job e.g., Leader Global Communication, Manager National Technical Support Center.","items":{"type":"object","description":"The details of the job title for the highest ranking key stakeholder.","properties":{"title":{"type":"string","description":"Text string that denotes a position held by the highest ranking key stakeholder in the organization or recording of the title used by the organization to describe this person's job e.g., Leader Global Communication, Manager National Technical Support Center.","example":"President"}}}},"managementResponsibilities":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the standardized alphanumeric classification code generated by Dun & Bradstreet used to identify the business function and hierarchical level of the highest ranking key stakeholder based on their professional job title."},"children":[]}]}]}],"items":{"type":"object","description":"The details of the management responsibility classification for the highest ranking key stakeholder.","properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text description of the standardized alphanumeric classification code generated by Dun & Bradstreet that identifies the business function and hierarchical level of the highest ranking key stakeholder of the business or organization based on their professional job title."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example \" Chief Executive Officer\" in"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A1A7 Chief Executive Officer"},"children":[]}]}]}],"example":"President"},"mrcCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A standardized alphanumeric classification code generated by Dun & Bradstreet that identifies the business function of the highest ranking key stakeholder based on the associated job title data. This information is expressed as a standard Management Responsibility Code (MRC)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example \" A1A7\" in"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A1A7 Chief Executive Officer"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"27751 [MRC]\" for all possible values."},"children":[]}]}]}],"example":"A1A6"}}}},"idNumbers":{"type":"array","description":"Identification/registration numbers for the highest ranking key stakeholder of the organization","items":{"type":"object","description":"The details of the identification/registration number for the highest ranking key stakeholder.","properties":{"idNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number assigned by an external body or by Dun & Bradstreet which either uniquely identifies or helps to identify the highest ranking key stakeholder of the organization."},"children":[]}]}]}],"example":"11356097"},"idType":{"type":"object","description":"Identifies the type of \"Principal Identification Number\", e.g., Social Security Number for the highest ranking key stakeholder of the organization.","properties":{"description":{"type":"string","description":"Text that identifies the type of \"Principal Identification Number\", e.g., Social Security Number for the highest ranking key stakeholder of the organization","example":"Super Person ID"},"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet that identifies the type of \"Principal Identification Number\", e.g., Social Security Number for the highest ranking key stakeholder of the organization"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"7 [Registration Number Type]\" for all possible values."},"children":[]}]}]}],"example":11694}}}}}}}}},"description":"The details of the entity."}},"components/schemas/DataBlock":{"id":"components/schemas/DataBlock","kind":"json-schema","title":"DataBlock","data":{"type":"object","description":"A data block is a collection of data elements that are logically grouped together. Enables you to retrieve data on a specific entity or category.","properties":{"transactionDetail":{"type":"object","description":"The information used to process this request.","properties":{"transactionID":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value assigned by the Dun & Bradstreet application to uniquely identify this request."},"children":[]}]}]}],"example":"rlh-hi9puyoijk-jop8u-kd-d-1"},"transactionTimestamp":{"type":"string","description":"The date and time, in ISO 8601 UTC Z standard, when this response was created.","example":"2026-10-21T13:37:18Z"},"inLanguage":{"type":"string","description":"An IETF BCP 47 code value that defines the language in which this product was rendered.","example":"en-US"}}},"inquiryDetail":{"type":"object","description":"The criteria used to process this request.","properties":{"duns":{"type":"string","description":"The D-U-N-S number provided in the request.","example":"804735132"},"blockIDs":{"type":"array","items":{"description":"The blockIDs provided in the request.","example":["blockID"],"type":"string"}},"tradeUp":{"type":"string","description":"The value of the tradeUp parameter provided in the request.","example":"hq"},"customerReference":{"type":"string","description":"A reference string provided by the customer for this particular transaction.","example":"Some text to describe the request."}}},"blockStatus":{"type":"array","items":{"type":"object","description":"Records the status of the data blocks requested by the customer.","properties":{"blockID":{"type":"string","description":"The unique identifier for the data block.","example":"blockID"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the data block fulfilled in this response."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"* OK"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"* Unavailable"},"children":[]}]}]}],"example":"OK"},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any specific reason why the data block is not delivered in this response."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"* Data is not available."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"* Data is not available for the branch."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"* Data is not available on the requested country code."},"children":[]}]}]}],"example":"Data is not available."}}}},"dataRestrictionStatus":{"type":"object","description":"Records the details of the data restriction status as per country regulations.","properties":{"isDataRestricted":{"type":"boolean","description":"When 'true' indicates that data restriction is required for the given request as per country regulations.","example":true},"dataRestrictionDetails":{"type":"array","description":"Records the details of the reasons due to which data restriction is required for the given request.","items":{"type":"object","description":"The details of the reasons due to which data restriction is required for the given request.","properties":{"dnbCode":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique code assigned by Dun & Bradstreet to identify the reason for data restriction."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to Reference code table \"199 [Subject Handling]\" for all possible values."},"children":[]}]}]}],"example":44915},"description":{"type":"string","description":"The reason due to which data restriction is required for the given request.","example":"Restricted content due to country regulations."}}}}}},"organization":{"$ref":"#/components/schemas/DataBlockOrganization"}}}},"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/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/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/SharingScopeId":{"id":"components/schemas/SharingScopeId","kind":"json-schema","title":"SharingScopeId","data":{"type":"string","description":"Unique identifier for the Sharing Scope.","example":"bfdfd6f7-562f-4d4a-921f-e68cba60d5cf"}},"components/schemas/SharingScopeDescription":{"id":"components/schemas/SharingScopeDescription","kind":"json-schema","title":"SharingScopeDescription","data":{"type":"string","description":"Description of defined sharing scope provided by customer","example":"Share customers from France.","maxLength":50}},"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/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/schemas-JobStatus":{"id":"components/schemas/schemas-JobStatus","kind":"json-schema","title":"schemas-JobStatus","data":{"type":"string","description":"Job execution status.","example":"RUNNING"}},"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/UserId":{"id":"components/schemas/UserId","kind":"json-schema","title":"UserId","data":{"type":"string","description":"Unique ID of a user.","example":"johndoe"}},"components/schemas/BusinessPartnerStorageName":{"id":"components/schemas/BusinessPartnerStorageName","kind":"json-schema","title":"BusinessPartnerStorageName","data":{"type":"string","description":"Name of the Business Partner Storage.","maxLength":100,"example":"CDQ AG"}},"components/schemas/DataMonitorId":{"id":"components/schemas/DataMonitorId","kind":"json-schema","title":"DataMonitorId","data":{"type":"string","description":"Unique alpha-numeric number of the Data Monitor.","example":"bfdfd6f7-562f-4d4a-921f-e68cba60d5cf"}},"components/schemas/DataMonitorTypeName":{"id":"components/schemas/DataMonitorTypeName","kind":"json-schema","title":"DataMonitorTypeName","data":{"type":"string","description":"Display name of the Data Monitor Type.","example":"Augmentation"}},"components/schemas/DataMonitorTypeTechnicalKey":{"id":"components/schemas/DataMonitorTypeTechnicalKey","kind":"json-schema","title":"DataMonitorTypeTechnicalKey","data":{"type":"string","description":"Technical key of a data monitor.","example":"AUGMENTATION"}},"components/schemas/DataMonitorToggle":{"id":"components/schemas/DataMonitorToggle","kind":"json-schema","title":"DataMonitorToggle","data":{"type":"boolean","description":"The toggle used to enable or disable the Data Monitor.","example":true}},"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/DataMonitorExecutionTypeTechnicalKey":{"id":"components/schemas/DataMonitorExecutionTypeTechnicalKey","kind":"json-schema","title":"DataMonitorExecutionTypeTechnicalKey","data":{"type":"string","description":"Technical key of the Data Monitor Execution Type.","example":"TRIGGER"}},"components/schemas/DataMonitorFrequency":{"id":"components/schemas/DataMonitorFrequency","kind":"json-schema","title":"DataMonitorFrequency","data":{"type":"string","description":"It is the interval at which updates are performed.","example":"BI_WEEKLY"}},"components/schemas/CreatedBy":{"id":"components/schemas/CreatedBy","kind":"json-schema","title":"CreatedBy","data":{"type":"string","description":"Creator of a resource.","example":"76248934691294444"}},"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/StatusDetailTechnicalKey":{"id":"components/schemas/StatusDetailTechnicalKey","kind":"json-schema","title":"StatusDetailTechnicalKey","data":{"type":"string","description":"Technical key to uniquely identify a message.","example":"JOB_FINISHED"}},"components/schemas/StatusDetailMessage":{"id":"components/schemas/StatusDetailMessage","kind":"json-schema","title":"StatusDetailMessage","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/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/JobName":{"id":"components/schemas/JobName","kind":"json-schema","title":"JobName","data":{"type":"string","description":"Name of a Job.","example":"Process vendor data."}},"components/schemas/JobDescription":{"id":"components/schemas/JobDescription","kind":"json-schema","title":"JobDescription","data":{"type":"string","description":"Detailed description of a Job.","example":"I started this job to improve quality of our data."}},"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/ApiErrorTimestamp":{"id":"components/schemas/ApiErrorTimestamp","kind":"json-schema","title":"ApiErrorTimestamp","data":{"type":"string","deprecated":true,"description":"ISO 8601 representation of the timestamp.","example":"2026-10-21T13:37:18Z"}},"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/schemas-CurationLevel":{"id":"components/schemas/schemas-CurationLevel","kind":"json-schema","title":"schemas-CurationLevel","data":{"type":"string","description":"Indicator for curation quality. Defines how good curation was.","example":"LEVEL_4"}},"components/schemas/ExpiresAt":{"id":"components/schemas/ExpiresAt","kind":"json-schema","title":"ExpiresAt","data":{"type":"string","description":"Date of expiration (ISO 8601-compliant).","example":"2026-10-21T13:37:18Z"}},"components/schemas/UpdateClassificationReason":{"id":"components/schemas/UpdateClassificationReason","kind":"json-schema","title":"UpdateClassificationReason","data":{"type":"string","description":"Reason why this classification has been applied","example":"The modified post code has deprecated format."}},"components/schemas/UpdateClassificationTechnicalKey":{"id":"components/schemas/UpdateClassificationTechnicalKey","kind":"json-schema","title":"UpdateClassificationTechnicalKey","data":{"type":"string","example":"MAJOR","description":"Technical key of an update classification."}},"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/schemas-Tag":{"id":"components/schemas/schemas-Tag","kind":"json-schema","title":"schemas-Tag","data":{"type":"string","description":"String describing and identifying a resource.","example":"Reporting"}},"components/schemas/DataMonitorExecutionTypeTechnicalKeyEnum":{"id":"components/schemas/DataMonitorExecutionTypeTechnicalKeyEnum","kind":"json-schema","title":"DataMonitorExecutionTypeTechnicalKeyEnum","data":{"type":"string","description":"Technical key of the Data Monitor Execution Type.","example":"TRIGGER","enum":["TRIGGER"],"x-enumDescriptions":{"TRIGGER":"Execution is engaged for only these business partners, where any change (added, modified or deleted concepts) was detected. Adding completely new businness partner or new updates from reference data sources are also a reason to start monitor."}}},"components/schemas/DataMonitorFrequencyEnum":{"id":"components/schemas/DataMonitorFrequencyEnum","kind":"json-schema","title":"DataMonitorFrequencyEnum","data":{"type":"string","description":"List of Data Monitor Frequency parapeters.","example":"BI_WEEKLY","enum":["BI_WEEKLY","MONTHLY","QUARTERLY"],"x-enumDescriptions":{"BI_WEEKLY":"The update is performed once for two weeks.","MONTHLY":"The update is performed once for one month.","QUARTERLY":"The update is performed once for three months."}}},"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/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"}}}},"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/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/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/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/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/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/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/StatusDetailMessageId":{"id":"components/schemas/StatusDetailMessageId","kind":"json-schema","title":"StatusDetailMessageId","data":{"type":"integer","description":"9-digit code which is uniquely identifying a message","example":200000004}},"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/schemas-PropertyNewContent":{"id":"components/schemas/schemas-PropertyNewContent","kind":"json-schema","title":"schemas-PropertyNewContent","data":{"type":"string","example":"AAB","description":"New value after change"}},"components/schemas/schemas-PropertyPreviousContent":{"id":"components/schemas/schemas-PropertyPreviousContent","kind":"json-schema","title":"schemas-PropertyPreviousContent","data":{"type":"string","example":"AAB","description":"Value before change"}},"schema_0":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerStorageId"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","example":"5712566172571652"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"default":500,"example":"100"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/RelationsReadFeatureParam"}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"array","description":"List of features to be deactivated.","items":{"$ref":"#/components/schemas/RelationsReadFeatureParam"}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerExternalId"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerDataSource"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerRelationTypeTechnicalKey"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerRelationClassTechnicalKey"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"string","example":"2026-10-21T13:37:18Z"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RelationsReadActingParam"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"array","description":"List of Reference Data Sources.","items":{"type":"string","description":"Reference data source as ALEI prefix of the linked Business Partner used to filter the result of links returned OR\nin case of link between Business Partners in own data sources, string consisting of storageId:dataSourceId.\n","example":"CDQ.POOL"}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"array","description":"List of Business Partner IDs.","items":{"$ref":"#/components/schemas/BusinessPartnerId"}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"array","description":"List of Business Partner externalIDs.","items":{"$ref":"#/components/schemas/BusinessPartnerExternalId"}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"array","description":"List of Data Source IDs.","items":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"array","description":"List of CDQ IDs.","items":{"type":"string","description":"CDQ ID.","example":"VIES:PL8660001429"}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"array","description":"List of Linkage Statuses.","items":{"$ref":"#/components/schemas/LinkageStatus"}},"id":"schema_16"},"schema_18":{"kind":"json-schema","data":{"example":"+id","type":"string"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/BusinessPartnerIdentityLinksReadFeatureParam"}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"array","description":"List of features to be deactivated.","items":{"$ref":"#/components/schemas/BusinessPartnerIdentityLinksReadFeatureParam"}},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"array","description":"List of features to be activated on.","items":{"$ref":"#/components/schemas/StorageDeleteFeatureParam"}},"id":"schema_21"},"schema_23":{"kind":"json-schema","data":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/SharingScopesReadFeatureParam"}},"id":"schema_23"},"schema_27":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/DataSourceDeleteFeatureParam"}},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"$ref":"#/components/schemas/JobId"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"array","description":"List of Features.","items":{"$ref":"#/components/schemas/UpdateMonitoringReferenceDataSourcesReadFeatureParam"}},"id":"schema_30"},"schema_32":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BusinessPartnerId"},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"array","description":"List of Data Sources.","items":{"$ref":"#/components/schemas/BusinessPartnerDataSource"}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"array","description":"List of country codes.","items":{"$ref":"#/components/schemas/CountryShortName"}},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"boolean","default":false,"example":"false"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"boolean","example":"true"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"array","description":"List of Business Partner externalIDs.","maxItems":100,"items":{"$ref":"#/components/schemas/BusinessPartnerExternalId"}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"array","description":"List of Business Partner Sharing Statuses.","items":{"type":"string","description":"Sharing Statuses which can be filtered out.","example":"UNDER_CONSIDERATION"}},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/BusinessPartnersReadFeatureParam"}},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"array","description":"List of features to be deactivated.","items":{"$ref":"#/components/schemas/BusinessPartnersReadFeatureParam"}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"array","description":"List of validation level statuses.","items":{"$ref":"#/components/schemas/ValidationLevelParam"}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"array","description":"List of curation level statuses.","items":{"$ref":"#/components/schemas/CurationLevelParam"}},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"string","example":"n/a"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ReviewStatusParam"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"array","description":"List of trigger types.","items":{"$ref":"#/components/schemas/ProcessingLogResultStatusTriggerTypeTechnicalKeyParam"}},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"array","description":"List of Provenance Technical Key.","items":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"}},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"array","description":"List of Business Partner type Technical Keys.","maxItems":1,"items":{"$ref":"#/components/schemas/BusinessPartnerTypeTechnicalKeyParam"}},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"array","description":"List of Tag Values.","items":{"$ref":"#/components/schemas/TagValue"}},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TagTypeTechnicalKey"},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ProcessingStatusTechnicalKeyEnum"},"id":"schema_50"},"schema_52":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CountryShortName"},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/ReadBusinessPartnerFeatureParam"}},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"array","description":"List of features to be deactivated.","items":{"$ref":"#/components/schemas/ReadBusinessPartnerFeatureParam"}},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"array","description":"List of Business Partner IDs.","maxItems":500,"items":{"$ref":"#/components/schemas/BusinessPartnerId"}},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/BusinessPartnerExternalId"}},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"array","description":"List of Concepts.","items":{"$ref":"#/components/schemas/BusinessPartnerConceptParam"}},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/BusinessPartnerPropertyParam"}},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ProvenanceTechnicalKey"}},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","description":"Filter for a data source (name or id)","example":"VIES"}},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","description":"Filter for countries.","example":"CH"}},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"string","description":"Filter for change types.","example":"ADDED","enum":["ADDED","MODIFIED","DELETED"]},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PropertyChangeClassificationParam"},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/BusinessPartnerUpdatesFeatureParam"}},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"maximum":10,"default":1,"example":"5"},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"array","description":"List of features to be used.","items":{"$ref":"#/components/schemas/FetchBusinessPartnerFeatureParam"}},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"array","description":"List of features to be excluded.","items":{"$ref":"#/components/schemas/FetchBusinessPartnerFeatureParam"}},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"object","description":"Import Job Request","properties":{"file":{"description":"XLSX or CSV file to be uploaded (SOAP currently only supports CSV). Supports up to 10MB of file size. For the file size greater than 10MB use Upload via Upload Request approach.","type":"string","format":"binary","example":"CH-import.csv"},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Url to file which will be used to import data from. Recommended. The file can be uploaded via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.cdq.com/documentation/instructions/uploading-cvs-xls-data"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" passing through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the result object."},"children":[]}]}]}],"example":"customer-uploads/CH-import.csv"},"storageId":{"type":"string","description":"Target storage ID for this import.","example":"72d6900fce6b326088f5d9d91049e3e6"},"dataSource":{"$ref":"#/components/schemas/BusinessPartnerStorageDataSourceId"},"externalIdColumn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the column which will be mapped to external ID. This is required if feature UPSERT_BY_EXTERNAL_ID is activated."},"children":[]}]}]}],"example":"BP_EXTERNAL_ID"},"dataMapperDefinitionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of data mapper to be used to transform the data before importing it. This or a data source is required if feature CUSTOM_DATA_MAPPER is activated. Disabled when CUSTOM_DATA_MAPPER feature is not provided in a request."},"children":[]}]}]}],"example":"6400955811c68a034bcef311"},"featuresOn":{"type":"array","description":"List of features to be activated.","items":{"type":"string","description":"Feature to be used on during the Import Job.","example":"UPSERT_BY_EXTERNAL_ID","enum":["ACCEPT_EMPTY_VALUES","UPSERT_BY_EXTERNAL_ID","CUSTOM_DATA_MAPPER","FULL_UPDATE","LAB_USE_QUEUES","LAB_USE_BACKPRESSURE"],"x-enumDescriptions":{"ACCEPT_EMPTY_VALUES":"Allows to import empty values to record in Business Partner.","UPSERT_BY_EXTERNAL_ID":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a Business Partners identified by external ID instead of an insert if the external ID is already present in this storage. If this feature is selected, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalIdColumn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mandatory. When selected, id must not be provided in a Business Partner."},"children":[]}]}]}],"CUSTOM_DATA_MAPPER":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies data transformation using data mapper identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataTransformationDefinitionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataMapperDefinitionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or fetched from the data source identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"FULL_UPDATE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forces the job to delete existing records which are not included in the import file. Records to be updated or to be deleted are identified by external IDs, i.e. not by the internal database IDs. To confirm this understanding, UPSERT_BY_EXTERNAL_ID feature must be activated in addition. When a FULL_UPDATE import job is completed, new records from the import file are created, existing ones are updated by keeping their internal database IDs and their external IDs, and records which are not provided by the file are deleted. If this feature is selected, dataSource and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPSERT_BY_EXTERNAL_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are mandatory. Whenever import errors occur then this action is not executed."},"children":[]}]}]}]}}}},"required":["storageId"]},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"array","description":"List of labels to be filtered by.","items":{"type":"string","description":"Label for filtering.","example":"Custom label"}},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":0,"default":0,"example":"10"},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"default":20,"example":"10"},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"string","example":"-modifiedAt"},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DataMapperDefinitionId"},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"array","description":"List of features.","items":{"$ref":"#/components/schemas/DataMonitorsReadFeatureParam"}},"id":"schema_74"},"schema_75":{"kind":"json-schema","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 attributes to sort by. Supported attribute is 'modifiedAt'. Sort direction can be specified in front of each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute. '+' means ascending, '-' means descending. If direction is not given default sort is ascending."},"children":[]}]}]}],"default":"-modifiedAt","example":"-modifiedAt"},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"array","description":"List of Data Monitor type Technical Keys.","items":{"$ref":"#/components/schemas/DataMonitorTypeTechnicalKeyEnum"}},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ConfigurationId"},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DataMonitorId"},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"type":"array","description":"List of features.","items":{"$ref":"#/components/schemas/StorageDataMonitorsReadFeatureParam"}},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"array","description":"Features to be deactivated.","items":{"$ref":"#/components/schemas/DataMonitorCreateFeatureParam"}},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DataMonitorScopeTechnicalKey"},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"array","description":"List of Features.","items":{"$ref":"#/components/schemas/DataMonitorProgressFeatureParam"}},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"string","example":"NmEyOThlMGM4MTAyNTI3NWM2M2M1Y2I3"},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/BusinessPartner"}},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/DnbRecordsReadFeatureParam"}},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"array","description":"List of features to be deactivated.","items":{"$ref":"#/components/schemas/DnbRecordsReadFeatureParam"}},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"$ref":"#/components/schemas/JobName","maxLength":50},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"$ref":"#/components/schemas/JobDescription","maxLength":200},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"string","example":"username"},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"string","example":"password"},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"array","description":"List of features to be activated.","items":{"$ref":"#/components/schemas/DnbImportJobFeature"}},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DnbStorageTechnicalKeyParam"},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"object","description":"DNB Import Job Request","properties":{"file":{"type":"string","format":"binary","description":"XLSX or CSV file to be uploaded, containing mandatory DUNS column (SOAP currently only supports CSV).","example":"CH-import.csv"}}},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"type":"array","description":"List of urls to delete.","minItems":1,"items":{"type":"string","description":"File to delete from customer-uploads/ directory.","example":"dq-chart.png or requestedDirectory/dq-chart.png"}},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"string","example":"requestedDirectory/ or requestedDirectory/otherDirectory"},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"string","example":"1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u"},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"integer","minimum":1,"format":"int32","default":300,"example":"200"},"id":"schema_97"}},"exampleStore":{"paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example1":{"value":{"description":"Share Customers From France.","dataSources":[{"id":"648824a691d8d2503d65103e"}],"countries":[{"shortName":"FR"}]},"key":"Example1","summary":"Create Sharing Scope for FR Business Partners","id":"paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example1"},"paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example2":{"value":{"description":"YOUR_DESCRIPTION.","dataSources":[{"id":"YOUR_DATASOURCE_ID"}],"countries":[{"shortName":"COUNTRY_CODE"}]},"key":"Example2","summary":"Create Sharing Scope Template","id":"paths/~1v4~1storages~1{storageId}~1sharingscopes/post/responses/200/content/application~1json/examples/Example2"},"paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example1":{"value":{"dataSource":"YOUR_DATASOURCE_ID","featuresOn":["UPSERT_BY_EXTERNAL_ID"],"businessPartners":[{"externalId":"YOUR_EXTERNAL_ID","record":"{\"Customer number\":\"YOUR_EXTERNAL_ID\", \"Name\":\"COMPANY_NAME\", \"Country\":\"COUNTRY_CODE\", \"City\":\"CITY\", \"Street\":\"STREET\", \"Postal code\":\"POSTAL_CODE\"}"}]},"key":"Example1","summary":"Single record update","id":"paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example1"},"paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example2":{"value":{"dataSource":"YOUR_DATASOURCE_ID","featuresOn":["UPSERT_BY_EXTERNAL_ID"],"businessPartners":[{"externalId":"123","record":"{\"MyId\":\"123\", \"City\":\"St. Gallen\"}"}]},"key":"Example2","summary":"Update the City of the Business Partner","id":"paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example2"},"paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example3":{"value":{"dataSource":"string","businessPartners":[{"id":"string","externalId":"string","dataSource":"string","disclosed":true,"updateMonitoring":true,"record":"{}","additionalInformation":[{"key":"KEY","value":1}],"names":[{"type":{"url":"string","name":"string","technicalKey":"string"},"value":"string","shortName":"string","language":{"name":"German","technicalKey":"DE"}}],"legalForm":{"name":"string","url":"https://meta.cdq.com/DataModel:CDQ/Business_Partner/Legal_Form/DE_9866","technicalKey":"DE_9866","language":{"name":"German","technicalKey":"DE"},"mainAbbreviation":"string"},"identifiers":[{"type":{"url":"string","name":"string","technicalKey":"string"},"value":"string","issuingBody":{"name":"string","url":"string","technicalKey":"string"},"status":{"name":"string","technicalKey":"string"}}],"categories":[{"name":"string","url":"string","technicalKey":"string"}],"status":{"type":{"name":"string","url":"string","technicalKey":"string"},"officialDenotation":"string","validFrom":"string","validUntil":"string"},"profile":{"minorityIndicator":{"value":"string"},"classifications":[{"value":"string","code":"string","type":{"name":"string","url":"string","technicalKey":"string"}}],"phoneNumbers":[{"countryPrefix":"string","number":"string","type":{"name":"string","url":"string","technicalKey":"string"},"value":"string"}],"websites":[{"url":"string","type":{"name":"string","url":"string","technicalKey":"string"}}],"contactEmails":[{"value":"string"}]},"relations":[{"startedAt":"2019-08-31T16:47+00:00","endedAt":"2019-08-31T16:47+00:00","type":{"name":"Organizational Unit","technicalKey":"BRANCH"},"class":{"name":"CDQ Hierarchy","technicalKey":"BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"},"startNode":"FR.RC:5664645","startNodeDataSource":"string","startNodeBusinessPartner":{"names":[{}],"addresses":[{"postCodes":[],"localities":[],"thoroughfares":[]}]},"endNode":"FR.RC:5664645","endNodeDataSource":"string","endNodeBusinessPartner":{"names":[{}],"addresses":[{"postCodes":[],"localities":[],"thoroughfares":[]}]}}],"types":[{"name":"string","url":"string","technicalKey":"string"}],"addresses":[{"id":"string","externalId":"string","cdqId":"string","version":{"language":{"name":"German","technicalKey":"DE"},"characterSet":{"name":"International","technicalKey":"INTERNATIONAL"}},"identifyingName":{"value":"string"},"careOf":{"value":"string"},"contexts":[{"value":"string"}],"country":{"shortName":"CH","value":"Switzerland"},"administrativeAreas":[{"value":"string","shortName":"string","type":{},"language":{}}],"postCodes":[{"value":"string","type":{}}],"localities":[{"type":{},"shortName":"string","value":"string","language":{}}],"thoroughfares":[{"type":{},"shortName":"string","number":"string","value":"string","name":"string","direction":"string","language":{}}],"premises":[{"value":"string","shortName":"string","number":"string","type":{},"language":{}}],"postalDeliveryPoints":[{"type":{},"shortName":"string","number":"string","value":"string","language":{}}],"geographicCoordinates":{"latitude":0,"longitude":0},"types":[{"name":"string","url":"string","technicalKey":"string"}]}],"bankAccounts":[{"internationalBankAccountIdentifier":"string","internationalBankIdentifier":"string","nationalBankAccountIdentifier":"string","nationalBankIdentifier":"string","countryCode":"string"}]}],"featuresOn":["FEATURE_1"],"featuresOff":["FEATURE_2"]},"key":"Example3","summary":"Full request example","id":"paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example3"},"paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example4":{"value":{"dataSource":"YOUR_DATASOURCE_ID","featuresOn":["UPSERT_BY_EXTERNAL_ID"],"businessPartners":[{"externalId":"YOUR_EXTERNAL_ID","disclosed":true,"record":"{\"Customernumber\":\"YOUR_EXTERNAL_ID\",\"Name\":\"COMPANY_NAME\",\"Country\":\"COUNTRY_CODE\",\"City\":\"CITY\",\"Street\":\"STREET\",\"Postalcode\":\"POSTAL_CODE\"}"}]},"key":"Example4","summary":"Disclose Business Partners by Upsert","id":"paths/~1v4~1storages~1{storageId}~1businesspartners/put/requestBody/content/application~1json/examples/Example4"},"paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example1":{"value":{"dataSource":"YOUR_DATASOURCE_ID","businessPartners":[{"externalId":"BP_EXTERNAL_ID"}],"featuresOn":["DELETE_BY_EXTERNAL_ID"]},"key":"Example1","summary":"Delete Business Partner Based on External Id","id":"paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example1"},"paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example2":{"value":{"dataSource":"string","businessPartners":[{"id":"string","externalId":"string","dataSource":"string"}],"featuresOn":["DELETE_BY_EXTERNAL_ID"]},"key":"Example2","summary":"Full request body","id":"paths/~1storages~1{storageId}~1businesspartners~1delete/post/requestBody/content/application~1json/examples/Example2"},"paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/Basic":{"value":{"name":"CustomDataMapperDefinition","labels":["CustomDataMapperLabel"],"shareWithOrganization":true,"valueMappings":[{"sourceValue":"en","targetValue":"INTERNATIONAL","targetAttribute":"address.version.characterSet"}],"inputMapping":{"businessPartnerAttributeMappings":[{"sourceConstant":"LOCAL","sourceAttributes":["Name"],"targetAttributes":["businessPartner.names[0].value"],"targetAttributeTypes":["LOCAL"],"countryScopes":["DE"],"selectionType":"COMMA","separationType":"LENGTH","isMandatoryAttribute":"true","valueMapping":"INTERNATIONAL","defaultValue":"GB","transformations":[{"type":"UPPER_CASE","parameters":[{}]}]}],"addressesAttributeMappings":[[{"sourceConstant":"LOCAL","sourceAttributes":["Name"],"targetAttributes":["businessPartner.names[0].value"],"targetAttributeTypes":["LOCAL"],"countryScopes":["DE"],"selectionType":"COMMA","separationType":"LENGTH","isMandatoryAttribute":"true","valueMapping":"INTERNATIONAL","defaultValue":"GB","transformations":[{"type":"UPPER_CASE","parameters":[null]}]}]]},"outputMapping":{"businessPartnerAttributeMappings":[{"sourceConstant":"LOCAL","sourceAttributes":["Name"],"targetAttributes":["businessPartner.names[0].value"],"targetAttributeTypes":["LOCAL"],"countryScopes":["DE"],"selectionType":"COMMA","separationType":"LENGTH","isMandatoryAttribute":"true","valueMapping":"INTERNATIONAL","defaultValue":"GB","transformations":[{"type":"UPPER_CASE","parameters":[{}]}]}],"addressesAttributeMappings":[[{"sourceConstant":"LOCAL","sourceAttributes":["Name"],"targetAttributes":["businessPartner.names[0].value"],"targetAttributeTypes":["LOCAL"],"countryScopes":["DE"],"selectionType":"COMMA","separationType":"LENGTH","isMandatoryAttribute":"true","valueMapping":"INTERNATIONAL","defaultValue":"GB","transformations":[{"type":"UPPER_CASE","parameters":[null]}]}]]}},"key":"Basic","summary":"Basic Data Mapper Definition","id":"paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/Basic"},"paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/DisclosedBP":{"value":{"name":"CustomDataMapperDefinition","shareWithOrganization":true,"inputMapping":{"businessPartnerAttributeMappings":[{"sourceAttributes":["Name"],"targetAttributes":["businessPartner.names[0].value"],"targetAttributeTypes":["LOCAL"]},{"sourceConstant":"TRUE","targetAttributes":["businessPartner.disclosed"]}],"addressesAttributeMappings":[[{"sourceAttributes":["country"],"targetAttributes":["address.country.shortName"],"targetAttributeTypes":[]}]]}},"key":"DisclosedBP","summary":"Disclosed Business Partner","id":"paths/~1datamapperdefinitions/post/requestBody/content/application~1json/examples/DisclosedBP"},"paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/Basic":{"value":{"name":"CustomDataMapperDefinition","labels":["CustomDataMapperLabel"],"shareWithOrganization":true,"valueMappings":[{"sourceValue":"en","targetValue":"INTERNATIONAL","targetAttribute":"address.version.characterSet"}],"inputMapping":{"businessPartnerAttributeMappings":[{"sourceConstant":"LOCAL","sourceAttributes":["Name"],"targetAttributes":["businessPartner.names[0].value"],"targetAttributeTypes":["LOCAL"],"countryScopes":["DE"],"selectionType":"COMMA","separationType":"LENGTH","isMandatoryAttribute":"true","valueMapping":"INTERNATIONAL","defaultValue":"GB","transformations":[{"type":"UPPER_CASE","parameters":[{}]}]}],"addressesAttributeMappings":[[{"sourceConstant":"LOCAL","sourceAttributes":["Name"],"targetAttributes":["businessPartner.names[0].value"],"targetAttributeTypes":["LOCAL"],"countryScopes":["DE"],"selectionType":"COMMA","separationType":"LENGTH","isMandatoryAttribute":"true","valueMapping":"INTERNATIONAL","defaultValue":"GB","transformations":[{"type":"UPPER_CASE","parameters":[null]}]}]]},"outputMapping":{"businessPartnerAttributeMappings":[{"sourceConstant":"LOCAL","sourceAttributes":["Name"],"targetAttributes":["businessPartner.names[0].value"],"targetAttributeTypes":["LOCAL"],"countryScopes":["DE"],"selectionType":"COMMA","separationType":"LENGTH","isMandatoryAttribute":"true","valueMapping":"INTERNATIONAL","defaultValue":"GB","transformations":[{"type":"UPPER_CASE","parameters":[{}]}]}],"addressesAttributeMappings":[[{"sourceConstant":"LOCAL","sourceAttributes":["Name"],"targetAttributes":["businessPartner.names[0].value"],"targetAttributeTypes":["LOCAL"],"countryScopes":["DE"],"selectionType":"COMMA","separationType":"LENGTH","isMandatoryAttribute":"true","valueMapping":"INTERNATIONAL","defaultValue":"GB","transformations":[{"type":"UPPER_CASE","parameters":[null]}]}]]}},"key":"Basic","summary":"Basic Data Mapper Definition","id":"paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/Basic"},"paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/DisclosedBP":{"value":{"name":"CustomDataMapperDefinition","shareWithOrganization":true,"inputMapping":{"businessPartnerAttributeMappings":[{"sourceAttributes":["Name"],"targetAttributes":["businessPartner.names[0].value"],"targetAttributeTypes":["LOCAL"]},{"sourceConstant":"TRUE","targetAttributes":["businessPartner.disclosed"]}],"addressesAttributeMappings":[[{"sourceAttributes":["country"],"targetAttributes":["address.country.shortName"],"targetAttributeTypes":[]}]]}},"key":"DisclosedBP","summary":"Disclosed Business Partner","id":"paths/~1datamapperdefinitions~1{id}/put/requestBody/content/application~1json/examples/DisclosedBP"},"paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/dataMonitor":{"value":{"type":{"technicalKey":"YOUR_TECHNICAL_KEY"},"dataSources":[{"id":"YOUR_DATA_SOURCE"}],"enabled":"true","configuration":{"id":"ID_OF_AUGMENTATION_CONFIGURATION"},"executions":[{"type":{"technicalKey":"YOUR_TECHNICAL_KEY"}}]},"key":"dataMonitor","summary":"Create an Data Monitor","id":"paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/dataMonitor"},"paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/augmentationMonitor":{"value":{"technicalKey":"AUGMENTATION","dataSources":[{"id":"YOUR_DATA_SOURCE"}],"enabled":"true","configuration":{"id":"ID_OF_AUGMENTATION_CONFIGURATION"},"executions":[{"type":{"technicalKey":"TRIGGER"}}]},"key":"augmentationMonitor","summary":"Create an Augmentation Monitor","id":"paths/~1v2~1storages~1{storageId}~1datamonitors/post/requestBody/content/application~1json/examples/augmentationMonitor"},"paths/~1jobs~1transformationjobs/post/requestBody/content/application~1json/examples/example1":{"value":{"dataSourceId":"YOUR_DATA_SOURCE_ID","storageId":"YOUR_DATA_MIRROR_ID","featuresOn":["UPSERT_CHANGES_ONLY"]},"key":"example1","summary":"Transform HCP/HCO Business Partners","id":"paths/~1jobs~1transformationjobs/post/requestBody/content/application~1json/examples/example1"}},"securitySchemeStore":{"apiKey":{"id":"apiKey","type":"apiKey","in":"header","paramName":"X-API-KEY"}},"servers":[{"url":"https://api.cdq.com/data-exchange/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-exchange-api/@data-exchange-api-v4/api-v4.json?download"},{"url":"/_bundle/apis/data-exchange-api/@data-exchange-api-v4/api-v4.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Data Exchange API","description":"This API provides services to upload, manipulate and download businesspartner data in the CDL Cloud."}},"baseSlug":"/apis/data-exchange-api/data-exchange-api-v4/api-v4","routesMapping":{}}