{ "openapi" : "3.0.1", "info" : { "title" : "Boomi Data Hub Repository API", "description" : "The Boomi Data Hub Repository API enables programmatic access to Boomi Data Hub repositories and its hosted domains (referred to as universes). This API provides comprehensive endpoints for managing records, universes, data quality operations, and repository configurations.\n\n## Base URL\nUse **Data Hub** > **Repositories** > *Repository name* > **Configure** > **Base URL for API Requests**, then append `/mdm`.\n\n**Example:** `https://c01-usa-east.hub-test.boomi.com/mdm`\n\n## Authentication\nYou must authenticate requests to the Repository API using one of the following options:\n- **Basic Authentication**\n- **JSON Web Token (JWT) Authentication**\n\n**Customer Support:** support@boomi.com\n**URL:** https://community.boomi.com/s/support\n**Download OpenAPI Specification:** [Download](https://c01-usa-east.hub.boomi.com/mdm/openapi)", "version" : "1.0.0" }, "servers" : [ { "url" : "https://c01-aus-local.hub.boomi.com/mdm", "description" : "ANZ Local Hub Cloud 01" }, { "url" : "https://c01-aus.hub.boomi.com/mdm", "description" : "ANZ Hub Cloud" }, { "url" : "https://c01-ca.hub.boomi.com/mdm", "description" : "Canada Hub Cloud 01" }, { "url" : "https://c01-deu.hub.boomi.com/mdm", "description" : "DEU Hub Cloud 01" }, { "url" : "https://c01-gbr.hub.boomi.com/mdm", "description" : "GBR Hub Cloud" }, { "url" : "https://c01-gbr.hub.gb.boomi.com/mdm", "description" : "GB Hub Cloud" }, { "url" : "https://c01-jp.hub.boomi.com/mdm", "description" : "Japan Hub Cloud 01" }, { "url" : "https://c01-sg.hub.boomi.com/mdm", "description" : "Singapore Hub Cloud 01" }, { "url" : "https://c01-usa-east.hub.boomi.com/mdm", "description" : "USA East Hub Cloud" }, { "url" : "https://c02-usa-east.hub.boomi.com/mdm", "description" : "USA East Hub Cloud 02" } ], "tags" : [ { "name" : "Batch", "description" : "Process large volumes of data efficiently. Submit, monitor, and manage bulk updates that create or modify golden records. Use this API for high-volume data loads or scheduled synchronization jobs." }, { "name" : "Channels", "description" : "Integrate real-time updates with external systems. Fetch, acknowledge, and manage channel-based updates exchanged between Data Hub and contributing or consuming systems. Use this API to synchronize mastered data changes across applications." }, { "name" : "Quarantine", "description" : "Review and resolve data issues before they impact golden records. Query, retrieve, approve, reject, and resolve quarantined entries created through validation or matching failures. Use this API to maintain data quality and prevent incorrect updates from being applied." }, { "name" : "Records", "description" : "Manage the full lifecycle of golden records. Retrieve, search, end-date, restore, and purge golden records, including their metadata, history, and contributing source links. Use this API when you need direct stewardship or operational control over golden records." }, { "name" : "Staging", "description" : "Prepare and review incoming source data before mastering. Load, inspect, and manage staged source entities prior to validation, matching, or merging into golden records. Use this API to validate and troubleshoot data before it affects mastered records." }, { "name" : "Transactions", "description" : "Manage and audit record changes. Retrieve and query transactions that represent contributions, matching events, merges, and other record updates. Use this API for auditing, troubleshooting, or analyzing how golden records evolved over time." }, { "name" : "Universes", "description" : "Configure and manage data domains. Create and manage universes (domains), deploy models, and control repository-level configuration. Use this API to administer and structure your Data Hub environment." } ], "paths" : { "/universes/{universeId}/records" : { "post" : { "tags" : [ "Batch" ], "summary" : "Update Golden Records", "description" : "Updates a batch of XML-formatted entities from a contributing source to update a specified universe (domain) under an authenticated account.\n\n**Additional Information:**\n*Note:* You can implement requests for this operation in processes using the [Boomi Data Hub connector's update golden records operation](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/int-BDH_Update_Golden_Records).\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Batch Admin", "operationId" : "storeRecords", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "async", "in" : "query", "description" : "Process asynchronously. When true, returns immediately with batch URL. When false, waits for processing to complete.", "required" : false, "example" : "true" }, { "name" : "returnEntities", "in" : "query", "description" : "Include entity details in the response when async=false", "required" : false, "example" : "false" } ], "requestBody" : { "description" : "In the request body wrap the entities in a `` element. Specify the contributing source by its ID in the `` element's `src` attribute. The entities must conform to the deployed model for the universe. In each entity, wrap the source record ID in an `` element.\n\n**Entity operation (op) and example:**\n\nThe first entity in the example is a normal update — creating a new golden record or a potential update to a linked golden record. If you omit the `op` attribute, its presence is implied with the value of \"UPSERT\".\n\nIn the second entity, the `op` attribute value CREATE indicates a request to force the creation of a golden record. In this case, it skips matching. The created golden record can potentially duplicate if the entity is successfully incorporated. If an incorporation error occurs because a source entity with the ID specified in the entity has a linked golden record and you configure the contributing source to disallow multiple links from individual golden records to source entities, it quarantines the entity.\n\nIn the third entity the presence of the `op` attribute value DELETE on the entity's root `` element indicates a request for the end-dating of the linked golden record.\n\n*Note:* Dedicated repository API operations, End-date Single Golden Record and End-date Multiple Golden Records, exist for end-dating a golden record(s).\n\nIn the fourth entity, a routine update, the `op` attribute value UPSERT in collection items indicates a request for an update to collection items with matching keys in a linked golden record. Add the specified items to the collection if there are no such items. Either none or all items in an individual collection in an entity must have an operation specified. The supported operation types are UPSERT and DELETE. In addition, you can select operations only for collections for which you enable item identification by key field value. For examples on how collections are processed for match by key and match by occurrence, refer to [Collection item matching examples](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Hub%20system/c-mdm-Collection_item_matching_examples_28c6e54f-63a5-4af2-9555-3a008ecdba4d). For more information on match by key collections, refer to [Collection item operations](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Hub%20system/c-mdm-Collection_item_operations_b1f16fbe-a3bf-4d6f-906d-5bcdcbec284b).\n\n**grid attribute:** The `grid` attribute is optional in an entity. The `grid` attribute value is expected to be a golden record ID. Suppose a golden record with a specific ID exists in the domain, but there is no link from the golden record to the source. In that case, it establishes a link from the golden record to the source entity specified in the entity's `` element. This technique is most applicable to a non-contributing source, such as a data warehouse. However, the alternative of designating the source upon attachment as non-contributing is preferred because links to selected non-contributing sources establish automatically and would not need a Source to Boomi Data Hub integration. Suppose a golden record with the specified ID exists in the domain. In that case, links go from the golden record to the source. You can configure the contributing source to disallow multiple links from individual golden records to source entities. The updated golden record links to the source entity specified in the entity's `` element. References in other golden records to the entity are updated accordingly.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/InputStream" }, "example" : "\n\n \n \n 1\n bob\n berwyn\n \n \n 311 555-1234\n home\n \n \n 311 555-4321\n mobile\n \n \n bob@gmail.com\n \n\n \n \n 2\n sam\n pottstown\n \n \n 311 555-8765\n mobile\n \n \n sam@gmail.com\n \n\n \n \n 3\n eric\n lansdale\n \n \n 311 555-9012\n home\n \n \n 311 555-2109\n mobile\n \n \n eric@gmail.com\n \n\n \n \n 4\n bill\n malvern\n \n \n 311 555-3456\n home\n \n \n 311 555-6543\n mobile\n \n \n bill@gmail.com\n \n\n" } }, "required" : true }, "responses" : { "202" : { "description" : "The request body conformed to all of batch update format requirements, and the update was accepted by the Repository for processing. The response body specifies the URL of the created batch update resource. The last segment of the URL specifies the ID assigned to the batch update resource. You can use this ID to get the accepted batch update status.\n\n*Note:* `*MDM*` (exactly as shown here in uppercase with leading and trailing asterisks) is not a valid source ID because it is used to distinguish batches submitted manually in the Boomi Data Hub service. If `*MDM*` is specified as the source ID, the response is an unknown source error.", "content" : { "application/xml" : { "schema" : { "type" : "string", "example" : "https://c01-usa-east.hub.boomi.com/mdm/universes/851a6a64-6a88-4916-a5b7-d6a974d54318/records/updates/42", "xml" : { "name" : "response" } }, "example" : "https://c01-usa-east.hub.boomi.com/mdm/universes/851a6a64-6a88-4916-a5b7-d6a974d54318/records/updates/42" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/staging/{stagingCode}" : { "post" : { "tags" : [ "Batch" ], "summary" : "Update Golden Records (Stage)", "description" : "Stages a batch of XML-formatted entities from a contributing source to update a specified universe (domain) under an authenticated account.\n\n**Additional Information:**\n*Note:* You can implement requests for this operation in processes using the [Boomi Data Hub connector's update golden records operation](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/int-BDH_Update_Golden_Records).\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Batch Admin", "operationId" : "stageRecords", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "stagingCode", "in" : "path", "description" : "Staging area code", "required" : false, "example" : "SFStaging" }, { "name" : "async", "in" : "query", "description" : "Process asynchronously. When true, returns immediately with batch URL. When false, waits for processing to complete.", "required" : false, "example" : "true" }, { "name" : "returnEntities", "in" : "query", "description" : "Include entity details in the response when async=false", "required" : false, "example" : "false" } ], "requestBody" : { "description" : "In the request body wrap the entities in a `` element. Specify the contributing source by its ID in the `` element's `src` attribute. The entities must conform to the deployed model for the universe. In each entity, wrap the source record ID in an `` element.\n\n**Entity operation (op) and example:**\n\nThe first entity in the example is a normal update — creating a new golden record or a potential update to a linked golden record. If you omit the `op` attribute, its presence is implied with the value of \"UPSERT\".\n\nIn the second entity, the `op` attribute value CREATE indicates a request to force the creation of a golden record. In this case, it skips matching. The created golden record can potentially duplicate if the entity is successfully incorporated. If an incorporation error occurs because a source entity with the ID specified in the entity has a linked golden record and you configure the contributing source to disallow multiple links from individual golden records to source entities, it quarantines the entity.\n\nIn the third entity the presence of the `op` attribute value DELETE on the entity's root `` element indicates a request for the end-dating of the linked golden record.\n\n*Note:* Dedicated repository API operations, End-date Single Golden Record and End-date Multiple Golden Records, exist for end-dating a golden record(s).\n\nIn the fourth entity, a routine update, the `op` attribute value UPSERT in collection items indicates a request for an update to collection items with matching keys in a linked golden record. Add the specified items to the collection if there are no such items. Either none or all items in an individual collection in an entity must have an operation specified. The supported operation types are UPSERT and DELETE. In addition, you can select operations only for collections for which you enable item identification by key field value. For examples on how collections are processed for match by key and match by occurrence, refer to [Collection item matching examples](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Hub%20system/c-mdm-Collection_item_matching_examples_28c6e54f-63a5-4af2-9555-3a008ecdba4d). For more information on match by key collections, refer to [Collection item operations](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Hub%20system/c-mdm-Collection_item_operations_b1f16fbe-a3bf-4d6f-906d-5bcdcbec284b).\n\n**grid attribute:** The `grid` attribute is optional in an entity. The `grid` attribute value is expected to be a golden record ID. Suppose a golden record with a specific ID exists in the domain, but there is no link from the golden record to the source. In that case, it establishes a link from the golden record to the source entity specified in the entity's `` element. This technique is most applicable to a non-contributing source, such as a data warehouse. However, the alternative of designating the source upon attachment as non-contributing is preferred because links to selected non-contributing sources establish automatically and would not need a Source to Boomi Data Hub integration. Suppose a golden record with the specified ID exists in the domain. In that case, links go from the golden record to the source. You can configure the contributing source to disallow multiple links from individual golden records to source entities. The updated golden record links to the source entity specified in the entity's `` element. References in other golden records to the entity are updated accordingly.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/InputStream" }, "example" : "\n\n \n \n 1\n bob\n berwyn\n \n \n 311 555-1234\n home\n \n \n 311 555-4321\n mobile\n \n \n bob@gmail.com\n \n\n \n \n 2\n sam\n pottstown\n \n \n 311 555-8765\n mobile\n \n \n sam@gmail.com\n \n\n \n \n 3\n eric\n lansdale\n \n \n 311 555-9012\n home\n \n \n 311 555-2109\n mobile\n \n \n eric@gmail.com\n \n\n \n \n 4\n bill\n malvern\n \n \n 311 555-3456\n home\n \n \n 311 555-6543\n mobile\n \n \n bill@gmail.com\n \n\n" } }, "required" : true }, "responses" : { "202" : { "description" : "The request body conformed to all of batch update format requirements, and the update was accepted by the Repository for processing. The response body specifies the URL of the created batch update resource. The last segment of the URL specifies the ID assigned to the batch update resource. You can use this ID to get the accepted batch update status.\n\n*Note:* `*MDM*` (exactly as shown here in uppercase with leading and trailing asterisks) is not a valid source ID because it is used to distinguish batches submitted manually in the Boomi Data Hub service. If `*MDM*` is specified as the source ID, the response is an unknown source error.", "content" : { "application/xml" : { "schema" : { "type" : "string", "example" : "https://c01-usa-east.hub.boomi.com/mdm/universes/851a6a64-6a88-4916-a5b7-d6a974d54318/records/updates/42", "xml" : { "name" : "response" } }, "example" : "https://c01-usa-east.hub.boomi.com/mdm/universes/851a6a64-6a88-4916-a5b7-d6a974d54318/records/updates/42" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/records/updates/{batchId}" : { "get" : { "tags" : [ "Batch" ], "summary" : "Get Batch Update Status", "description" : "The Get Batch Update Status operation retrieves the status, in XML format, of a particular batch update for a universe (domain) under the authenticated account. There is an option to also retrieve the individual entity status in the batch.\n\n**Additional Information:**\n*Note:* You can implement requests for this operation in processes using the [HTTP Client connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-HTTP_Client_connector_d64af80e-febe-4cd2-89ad-e3d0fc53c502), as demonstrated by example 2 in the sample process [Hub: Read Batch Information](https://platform.boomi.com/AtomSphere.html#build;processLibrary=4195924d-7d8a-4b94-ba77-b2d0b56f2824), which you can install in your account from the process library in Integration.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Batch Admin\n OR\n - MDM - Activity Reporting", "operationId" : "batchUpdateStatus", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "batchId", "in" : "path", "description" : "Batch update ID. To obtain the needed batch update resource ID, first perform an Update Golden Records or Update Golden Records (Stage) operations and extract the ID from the response body — the ID is the last segment of the batch update resource URL.", "required" : false, "example" : "42" }, { "name" : "includeEntities", "in" : "query", "description" : "Set to true to request entity status in addition to batch status. Set to false (the default) to request batch status only.", "required" : false, "example" : "false" } ], "responses" : { "200" : { "description" : "XML representation of batch status. When includeEntities=false (default), returns only batch-level information. When includeEntities=true, also includes individual entity processing details in an section. Note: A element appears within entity details only when an entity is quarantined, indicating the cause of the quarantining.\n\n**Within the root `` element:**\n\n- `` is the ID of the batch's contributing source.\n\n- `` indicates the type of submission, using one of the following tokens:\n - **API** — contributed the batch.\n - **STAGING** — staged the batch.\n - **EDIT** — created the batch as a result of the editing and resubmission by a user of a quarantined entity.\n - **RESUBMIT** — created the batch as a result of the resubmission (without editing) by a user of one or more quarantined entities.\n - **SELECTIVE_MERGE** — created the batch as a result of the selective merging by a user of fields in a quarantined entity into a matching golden record.\n - **STAGING_COMMIT** — created the batch as a result of the committing by a user of one or more staged entities for incorporation in the target domain.\n - **STAGING_REPLAY** — created the batch as a result of the resubmission by a user of one or more staged entities.\n\n- `` is included if the batch was contributed only as a result of connector operation during the run of a process. The element content is in the format atomsphere:@, where account_ID is that of the account in which the process ran and execution_ID is the system run ID.\n\n- `` indicates the batch status, using one of the following tokens:\n - **CREATED** — created the batch, but processing has not begun.\n - **PARSING** — validating the batch for specification of a valid contributing source for the target universe or validating the batch entities for conformance with the universe layout.\n - **PARSED** — the batch specifies a valid contributing source for the target universe and the batch entities conform with the universe layout. The entities are ready for enrichment.\n - **ENRICHING** — applying data quality steps to the batch entities.\n - **ENRICHED** — applied data quality steps to the batch entities and the entities are ready for processing for incorporation in the target universe.\n - **PROCESSING** — processing the batch entities for incorporation in the target universe.\n - **ERRORED** — processing failed for all batch entities with an unexpected error.\n - **COMPLETED** — incorporated all batch entities in the target universe.\n - **COMPLETED_ERRORS** — could not process one or more batch entities for incorporation in the target universe due to an unexpected error.\n\n- `` is the creation time of the batch record.\n\n- `` is the last update time of the batch record.\n\n- `` is the starting time of the parsing (validation) phase of processing.\n\n- `` is the ending time of the parsing (validation) phase of processing.\n\n- `` is the starting time of the enrichment phase of processing during which data quality steps are applied.\n\n- `` is the ending time of the enrichment phase of processing during which data quality steps are applied.\n\n- `` is the starting time of the incorporation phase of processing.\n\n- `` is the ending time of the incorporation phase of processing.\n\n- `` is the ending time of processing.\n\n- `` is the count of entities.\n\n- `` is the count of quarantined entities.\n\n- `` is the count of golden records created as a result of processing.\n\n- `` is the count of golden records deleted as a result of processing.\n\n- `` is the count of golden records updated as a result of processing.\n\n- `` is included if the query parameter includeEntities is true. Within `` there is an `` element for each entity in the batch. The id attribute value is the system-assigned batch entity ID.\n\n**Within an `` element:**\n\n- `` is the creation time of the entity in the batch.\n\n- `` is the update time of the entity in the batch.\n\n- `` indicates the entity state, using one of the following tokens:\n - **PARSED** — the entity conforms with the universe layout and is ready for enrichment.\n - **ENRICHED** — applied the data quality steps and the entity is ready for processing for incorporation in the target universe.\n - **PROCESSING** — processing is in progress to incorporate the entity in the target universe.\n - **ERRORED** — the entity failed processing with an unexpected error.\n - **QUARANTINED** — quarantined the entity. The reason for quarantining is given in ``.\n - **COMPLETED** — completed the processing of the entity. The manner of resolution is given in ``.\n\nIf processing of the entity completed or quarantined, `` indicates the resolution manner of the entity, using one of the following tokens:\n - **CREATED** — a golden record.\n - **UPDATED** — a matching golden record.\n - **DELETED** — end-dated a matching golden record.\n - **LINKED** — a matching golden record to the source entity.\n - **LINKED_WITH_UPDATE** — linked and updated a matching golden record to the source entity.\n - **NOOP** — did not create, update, end-date, or link a golden record.\n - **AMBIGUOUS_MATCH** — quarantined due to matching 10 or more golden records, regardless of links to source records (1,000 or more in the case of an exact matching expression grouped with a fuzzy matching expression).\n - **DUPLICATE_KEY** — quarantined because it contained multiple collection items with the same key values.\n - **ENRICH_ERROR** — quarantined due to data quality step failure.\n - **FIELD_FORMAT_ERROR** — quarantined because it contained data not in conformance with either their field type, validation options for that field type specified in the domain model, or with the system 255-character limit for text and Enumeration field values.\n - **INCORPORATE_ERROR** — quarantined during incorporation due to an error other than an unresolvable collection item reference.\n - **MATCH_REFERENCE_UNKNOWN** — quarantined due to having reference field values that do not resolve to golden records.\n - **MULTIPLE_MATCHES** — quarantined due to matching multiple golden records not yet linked to a record in the source.\n - **PARSE_FAILURE** — quarantined due to failure to structurally conform with the field layout specified in the domain model.\n - **POSSIBLE_DUPLICATE** — quarantined due to matching golden records already linked to a record in the source.\n - **RECORD_ALREADY_ENDDATED** — quarantined due to having a link from an end-dated golden record.\n - **REFERENCE_UNKNOWN** — quarantined due to unresolvable collection item reference errors.\n - **REQUIRED_FIELD** — quarantined due to the omission of fields specified as required or as key fields for collections in the domain model.\n - **REQUIRES_APPROVAL** — quarantined due to the satisfaction of conditions configured for the source requiring the manual approval of new entity contributions.\n - **REQUIRES_END_DATE_APPROVAL** — quarantined due to the source being configured to require manual approval of contributed entities that would end-date matching golden records.\n - **REQUIRES_UPDATE_APPROVAL** — quarantined due to the satisfaction of conditions configured for the source requiring the manual approval of contributed entities that would match golden records.\n - **REQUIRES_UPDATE_WITH_BASE_VALUE_APPROVAL** — quarantined because there is a pending link from the matching golden record to the contributing source and the entity has a field with a base value (the value of the field in the golden record's base version for the source when creating the pending link).\n\n- `` indicates the cause of the quarantining of the entity, if applicable.\n\n- `` is the source entity ID.\n\n- `` is the ID of the created, updated, or end-dated golden record, if applicable.\n\n- `` is the system transaction ID assigned upon the entity's initial submission.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/BatchMetaData" }, "example" : "\n 42\n CRM_SYSTEM\n string\n string\n \n string\n COMPLETED\n 2016-10-31T15:12:21Z\n 2016-10-31T15:12:21Z\n 2016-10-31T15:12:21Z\n 2016-10-31T15:12:21Z\n 2016-10-31T15:12:21Z\n 2016-10-31T15:12:21Z\n 2016-10-31T15:12:21Z\n 2016-10-31T15:12:21Z\n 2016-10-31T15:12:21Z\n 5\n 5\n 5\n 5\n 5\n \n \n 2016-10-31T15:12:21Z\n 2016-10-31T15:12:21Z\n COMPLETED\n CREATED\n 6f78f990-dbb9-4d97-94ff-64f7d31bc66f\n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n d1684e83-5e78-4fbe-99f0-32f08e507288\n \n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/records/updates" : { "post" : { "tags" : [ "Batch" ], "summary" : "Query Batch History", "description" : "The Query Batch History operation retrieves records of incoming batches of source entries contributed to a specific universe (domain) under the authenticated account. The response provides information about each batch, including the batch ID, contributing source, batch status, creation timestamp, and processing end time.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Batch Admin\n OR\n - MDM - Activity Reporting", "operationId" : "queryBatchUpdates", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" } ], "requestBody" : { "description" : "The body of the request must conform to the following structure.\n\n**Paging:** The optional `offsetToken` and `limit` attributes for `` are used for paging. The `limit` value is the maximum number of batches to return per page. Boomi Data Hub enforces a maximum of 200 entries per page regardless of the limit value. The `offsetToken` value corresponds to the `offsetToken` value returned from a previous Query Batch History request.\n\n**Child elements of ``** set query filter parameters:\n\n- `` (optional) — sets a filter by source. Specify the source by its unique ID.\n\n- `` and `` (both optional) — set a time span filter. The date and time format is YYYY-MM-ddTHH:mm:ssZ (UTC).\n\n- `` (optional) — sets a filter by the batch status. This element can repeat — one token per occurrence. The following tokens are valid:\n - **CREATED** — Batches created for which processing has not yet begun.\n - **PARSING** — Validate batches for specification of a valid contributing source for the target universe and validate batches whose entities are for conformance with the universe layout.\n - **PARSED** — Batches specify a valid contributing source for the target universe and whose entities conform with the universe layout and are ready for enrichment.\n - **ENRICHING** — Batches to which to apply data quality steps are to the entities.\n - **ENRICHED** — Batches to which data quality steps have been applied to the batch entities and the entities are ready to be processed for incorporation in the target universe.\n - **PROCESSING** — Batches whose entities are being processed for incorporation in the target universe.\n - **ERRORED** — Batches whose entities failed processing with an unexpected error.\n - **COMPLETED** — Batches where incorporation of entities are in the target universe.\n - **COMPLETED_ERRORS** — Could not process entities in batches for incorporation into the target universe due to an unexpected error.\n\nYou must omit elements corresponding to unused filter parameters from ``.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/BatchHistoryQuery" }, "example" : "\n SFDC\n 2023-01-01T00:00:00Z\n 2023-01-01T00:00:00Z\n string\n" } }, "required" : true }, "responses" : { "200" : { "description" : "The body contains the XML representation of the query results. The root element `` has a totalCount attribute that specifies the total number of batches satisfying the query and a resultCount attribute that specifies the number of batches returned on this \"page\" of results. The offsetToken attribute is returned only if there are additional results to retrieve for the query. You can use the returned token in a subsequent Query Batch History request to get the next \"page\" of results.\n\n**Within each `` element:**\n\n- `` is the system ID of the batch.\n\n- `` is the ID of the batch's contributing source.\n\n- `` is the query filter token corresponding to the batch status.\n\n- `` is the time stamp of the creation of the batch.\n\n- `` is the time stamp of the completion of processing of the batch. This element may not be present for batches in CREATED state.\n\nSorting of the `` elements is in the same manner as sorting batches in the Batch Report Detail view in Boomi Data Hub: by the time stamp returned in the `` element, from newest to oldest.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/BatchHistoryResponse" }, "example" : "\n \n 42\n CRM_SYSTEM\n COMPLETED\n 2016-10-31T15:12:21Z\n 2016-10-31T15:12:21Z\n \n \n 42\n CRM_SYSTEM\n COMPLETED\n 2016-10-31T15:12:21Z\n 2016-10-31T15:12:21Z\n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/sources/{sourceId}/cancelPendingBatches" : { "post" : { "tags" : [ "Batch" ], "summary" : "Cancel Pending Batches", "description" : "The Cancel Pending Batches operation sets pending batches that are in an ENRICHED or PARSED status to CANCELED for a given universe and source.\n\n**Additional Information:**\nThe operation cancels up to 10,000 pending batches. If you have more than 10,000 pending batches, repeat the request until all pending batches are canceled. Contact Boomi Support for assistance in determining the amount of pending batches.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Batch Admin", "operationId" : "cancelPendingBatch", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" } ], "responses" : { "202" : { "description" : "The pending batches for the given universe ID and source ID that are in Parsed or Enriched states are canceled successfully. Returns the job ID for tracking the cancellation operation.", "content" : { "application/xml" : { "schema" : { "type" : "string", "example" : "1638472951234", "xml" : { "name" : "response" } }, "example" : "1638472951234" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/sources/{sourceId}/updates/{updateId}" : { "post" : { "tags" : [ "Channels" ], "summary" : "Fetch Channel Updates", "description" : "The Fetch Channel Updates operation fetches a batch, if present, in XML format, of up to 200 source record update requests on a specified contributing source's channel from a universe (domain) under the authenticated account.\n\n**Additional Information:**\n*Note:* You can implement requests for this operation in processes using the [Boomi Data Hub connector's fetch channel updates operation](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/int-BDH_Fetch_Channel_Updates). You can also implement requests in their standard form using the [Boomi Master Data Hub connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-MDM_connector_ff690a6f-288d-44b3-96fb-e81afb046703), as demonstrated by the sample process [Hub: Fetch Channel Updates - Auto](https://platform.boomi.com/AtomSphere.html#build;processLibrary=4195924d-7d8a-4b94-ba77-b2d0b56f2824), which you can install in your account from the process library in Integration.\n\nFor a channel configured to propagate source record update requests that contain entities with all fields from golden records, the entities in fetched requests represent the current states of golden records. This sequence is also the case even for golden records for which multiple updates occurred since the most recently delivered request.\n\nSuppose a channel configured to propagate source record update requests contains entities with only updated fields from golden records. In that case, the fetched requests are accumulations of all field updates since the most recently delivered requests are associated with the golden records.\n\nSuppose deliverable update requests are among the first 201 update requests on the channel. In that case, no further update requests are evaluated for possible delivery in the batch, even if the batch contains less than the number of update requests specified in the limit query parameter (default 200).\n\nOptionally, the operation acknowledges delivery of a previous batch of requests fetched through the same channel.\n\nThe operation automatically acknowledges delivery of a batch of requests previously fetched through the same channel if all requests in the batch have in the meantime been manually deleted.\n\nThe operation automatically deletes from batches requests in which there are no fields present as a result of the application of field-level delivery exclusions configured for the source. When all records in a batch are deleted in this manner, the resulting empty batch is automatically acknowledged by the next operation.\n\n**Multiple Channels:** If the source is configured with multiple channels, instead send an HTTP POST request to: `/universes/{universeId}/sources/{sourceId}/channels/{channelId}/updates/{updateId}`. (Boomi maintains this form for backward compatibility - you cannot configure newly attached sources with multiple channels.)\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Activity Reporting and MDM - View Data and MDM - Stewardship\n OR\n - MDM - Activity Reporting and MDM - View Data and MDM - Stewardship Management", "operationId" : "getPrimaryChannelUpdates", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" }, { "name" : "updateId", "in" : "path", "description" : "ID of the channel update to be acknowledged", "required" : false, "example" : "3" }, { "name" : "limit", "in" : "query", "description" : "Maximum number of source record update requests in the fetched batch. 200 is the maximum meaningful value and the default.", "required" : false, "example" : "200" } ], "responses" : { "200" : { "description" : "Channel updates are pending. The response body contains the source record update requests in XML format.\n\n**Response Structure:**\n\nThe root element, ``, has the following attributes:\n\n- **id** - batch ID. To acknowledge the receipt of this batch of source record update requests and receive the next batch, the API client would, in a subsequent Fetch Channel Updates operation, specify the id attribute value as the updateID parameter value.\n\n- **fmt** - channel type (FULL or DIFF). Update requests sent through FULL channels contain all fields in the golden record. Update requests sent through DIFF channels include only the fields that have changed values.\n\n- **src** - destination source system ID for the update requests. The update requests represented in `` are ordered based on the occurrence of their associated golden record updates, from oldest to newest.\n\nThe root element for each update request contains a child element, ``, in addition to master data. The `` element contains the source entity ID in the case of a UPDATE, DELETE, RESTORE, or REJECT_DUPLICATE operation but is empty in the case of a CREATE operation.\n\nThe root element for each update request has the following attributes:\n\n- **grid** (CREATE, UPDATE, RESTORE, or DELETE operation only) - associated golden record ID.\n\n- **ts** - timestamp for the associated golden record update in the case of a CREATE or UPDATE operation, for the end-dating of the associated golden record in the case of a DELETE operation, for the restoring of the associated golden record in the case of a RESTORE operation, or for the rejection of the quarantined entity in the case of a REJECT_DUPLICATE operation.\n\n- **op** - operation (CREATE, UPDATE, DELETE, RESTORE, or REJECT_DUPLICATE).\n\n- **enddate** (DELETE operation only) - timestamp for the end-dating of the associated golden record. If this attribute is populated, its value is the same as the ts attribute value.", "content" : { "application/xml" : { "schema" : { "type" : "string", "xml" : { "name" : "response" } }, "example" : "\n \n 4\n jeff\n \n \n \n jason\n east norriton\n jason@gmail.com\n \n \n 5\n pete\n king of prussia\n pete@gmail.com\n \n" } } }, "204" : { "description" : "There are no update requests on the specified channel." }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/sources/{sourceId}/updates/{updateId}/acknowledge" : { "post" : { "tags" : [ "Channels" ], "summary" : "Acknowledge Previously Fetched Channel Updates", "description" : "The Acknowledge Previously Fetched Channel Updates operation acknowledges the receipt of a previously fetched batch of channel updates.\n\n**Additional Information:**\n**Multiple Channels:** If the source is configured with multiple channels, instead send an HTTP POST request to: `/universes/{universeId}/sources/{sourceId}/channels/{channelId}/updates/{updateId}/acknowledge`. (Boomi maintains this form for backward compatibility - you cannot configure newly attached sources with multiple channels.)\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Source Management", "operationId" : "ackPrimaryChannelUpdates", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" }, { "name" : "updateId", "in" : "path", "description" : "ID of the channel update to acknowledge", "required" : false, "example" : "3" } ], "responses" : { "200" : { "description" : "Acknowledgment was successful." }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/sources/{sourceId}/channels/query" : { "post" : { "tags" : [ "Channels" ], "summary" : "Query Outbound Activity", "description" : "The Query Outbound Activity operation lets you programmatically retrieve data about pending and delivered record update requests to outbound sources. The data aligns with information you can access in the user interface on the **Reporting** > **Outbound Activity** screen.\n\n**Additional Information:**\nA delivery is recorded only upon acknowledgment by an integration process on behalf of the targeted source. Read [Fetch Channel Updates](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/r-mdm-Fetch_Channel_Updates_403852dd-1ebe-4cca-861f-8d423f6415a9) for more information on automatic and [Acknowledge Previously Fetched Channel Updates](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/r-mdm-Acknowledge_Previously_Fetched_Channel_Updates_896ca6ee-56b4-4ff7-afe1-8849feec1d3b) for more information on manual acknowledgement.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Activity Reporting", "operationId" : "queryChannelUpdates", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" } ], "requestBody" : { "description" : "The request body root element is ``.\n\n**Request parameters:**\n\n- **queryType** — Status of the update requests you want to query. String. Required. Values are:\n - **PENDING** — Displays pending update requests for the specified universe and target source.\n - **HISTORY** — Displays delivered and acknowledged update requests for the specified universe and target source.\n\n- **offsetToken** — Add the offset token value from the previous page of results to retrieve the next page of results. String. Optional.\n\n- **limit** — Indicates the maximum number of results to include in a page. Boomi Data Hub enforces a maximum of 200 requests per page regardless of the limit value. Integer. Optional.\n\n- **sortBy** — Indicates that you want to sort by a filter parameter. For example, createdDate. String. Optional.\n\n- **sortAsc** — Sorts results in ascending or descending order. Boolean. Optional.\n - **true** — sorts results in ascending order.\n - **false** — sorts results in descending order.\n\n**Query filter parameters:**\n\nWrap the following query filter parameters in the `` tag.\n\n- **deliveryId** — Filters record updates based on the Delivery ID assigned when the batch of update requests is delivered. This filter only applies when the queryType is set to HISTORY. String. Optional.\n\n- **grid** — Filter by golden record ID. String. Optional.\n\n- **createdDate** — Filter by date and time at which the update request was created in the batch. Datetime. Optional. This tag wraps the `to` and `from` tags:\n - **from**: The start datetime for filtering requests. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n - **to**: The end datetime for filtering requests. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n If `createdRelativeTime` filter is specified, it overrides this filter.\n\n- **createdRelativeTime** — Filters by a time frame relative to the current date and time. String. Optional. Values are: PAST_HOUR, PAST_24_HOURS, PAST_WEEK.\n\n- **deliveryType** — Filters by deliverable and undeliverable update requests only when queryType is PENDING. String. Optional.\n - **UNDELIVERABLE** — Held update requests are undeliverable. An update request is held if it is for a golden record that references a golden record that is not linked to a record in the source and then only if the underlying domain model enforces referential integrity for update requests.\n - **DELIVERABLE** — Pending update requests that are not held.\n\n- **opType** — Filters by operation type. String. Optional. Values are:\n - **CREATE** — filter by update requests for record creation.\n - **UPDATE** — filter by update requests for record changes.\n - **DELETE** — filter by update requests for record deletion.\n - **RESTORE** — filter by update requests for record restoration from end-dated to active status.\n - **REJECT_DUPLICATE** — filter by update requests to reject the update as a duplicate of existing source entities.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/OutboundActivityRequest" }, "example" : "\n \n \n CREATE\n \n" } }, "required" : true }, "responses" : { "200" : { "description" : "The body contains the XML representation of the query results. It returns a maximum of 200 results per request unless the limit parameter for a given request specifies a lower maximum number of results.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/OutboundActivityResponse" }, "example" : "\n \n 4\n 539e13f5-4cab-4d83-8457-6f79c49a3828\n Lola Rubin\n CREATE\n 2025-02-21T00:19:43Z\n \n \n 3\n 5cc30f9a-dfc7-4326-a299-61ac8c953177\n Robert Reeves\n CREATE\n 2025-02-21T00:19:42Z\n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/sources/{sourceId}/updates/{messageId}" : { "get" : { "tags" : [ "Channels" ], "summary" : "Retrieve real time outbound message by ID", "description" : "\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Activity Reporting and MDM - View Data and MDM - Stewardship\n OR\n - MDM - Activity Reporting and MDM - View Data and MDM - Stewardship Management", "operationId" : "getPrimaryChannelUpdatesByMessageId", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" }, { "name" : "messageId", "in" : "path", "description" : "ID of the message published for the update", "required" : false, "example" : "3" } ], "responses" : { "200" : { "description" : "A response body containing the updates associated with the messageId.", "content" : { "application/xml" : { "schema" : { "type" : "string", "example" : "string", "xml" : { "name" : "response" } }, "example" : "string" } } }, "204" : { "description" : "There are no updates associated with the message id." }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/sources/{sourceId}/records/updates" : { "post" : { "tags" : [ "Channels" ], "summary" : "Propagate Channel Updates", "description" : "The Propagate Channel Updates operation requests the propagation of source record update requests to a specific source on its channel for golden records in a universe (domain) under the authenticated account.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Source Management", "operationId" : "sendChannelUpdatesForRecords", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" } ], "requestBody" : { "description" : "Requests for this operation are processed asynchronously. At any given time, processing only a single instance of manually propagated update requests can be in progress for a universe and source combination. Propagation of an update request for an individual golden record is subject to propagation rules configured for a given universe and source combination.\n\nAfter receiving a request by the repository, you can obtain the processing status with a Get Channel Updates Status operation, and you can cancel processing with a Cancel Channel Updates operation.\n\n**Root element:** ``. If this element's `recordStatus` attribute value is ACTIVE (the default), propagation of update requests is limited to active golden records. If the value is END_DATED, propagation is limited to end-dated (inactive) golden records. Within ``, each `` (optional) specifies a golden record for which to propagate update requests by its ID.\n\n**``** sets query filter parameters and the query operator. The optional `op` attribute specifies the query operator: AND (all criteria) or OR (any criterion). Default is AND. The order in which you specify filter parameters in `` is insignificant.\n\n**Filter parameter types:**\n\n- **``** — Filter by date and time of golden record creation. `` and `` set the range (format yyyy-MM-dd'T'HH:mm:ss'Z'). Omitting `` filters records created before ``; omitting `` filters records created after ``.\n\n- **``** — Filter by date and time of last golden record update. Same ``/`` format and omission behavior as ``.\n\n- **``** — Filter by golden record field value. `` specifies the field ID; `` the operator; `` the value (see below). Operators valid for all types: EQUALS. For all types except Reference and collection fields: NOT_EQUALS, IS_NOT_NULL, IS_NULL. Text/Long Text: CONTAINS, ENDS_WITH, STARTS_WITH. Integer/Float: GREATER_THAN, GREATER_THAN_EQUAL, LESS_THAN, LESS_THAN_EQUAL. Date/Date and Time/Time: BETWEEN. Enumeration: IS_INVALID. BETWEEN requires two `` elements (date/time format varies by type). EQUALS with Enumeration allows multiple `` elements. IS_INVALID, IS_NOT_NULL, IS_NULL do not use ``. Boolean values: true or false.\n\n- **``** — Filter by one or more tags via ``. A golden record having any one of the specified tags meets the criteria.\n\n- **``** — Filter by creating source specified by its source ID.\n\n- **``** — Filter by presence or absence of links to a source. `` specifies the source; `` is LINKED or NOT_LINKED. *Note:* If the universe has sources configured to allow multiple links to golden records, processing time for requests using `` may be significantly longer.\n\n- **``** — Filter by presence of unresolved reference field data. `` specifies the reference field; `` is a source ID or `@all` (limits results to golden records for which all source contributions are unresolved). *Note:* You can find a field's ID on the model page's Fields tab in Boomi Data Hub; a source's ID on the Sources page.\n\n*Note:* If the request body `` is either empty or contains an empty `` and no `` elements, propagation is requested for either all active or all end-dated golden records in the specified universe, depending on the `recordStatus` attribute value.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/RecordSourceUpdateRequest" }, "examples" : { "filter" : { "summary" : "Records by Filter", "description" : "Specify golden records by applying a filter. Processing is asynchronous.", "value" : "\n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n \n FIRST_NAME\n EQUALS\n Sample Value\n Sample Value\n \n \n FIRST_NAME\n EQUALS\n Sample Value\n Sample Value\n \n \n SFDC\n LINKED\n \n SFDC\n \n VIP_CUSTOMER\n VIP_CUSTOMER\n \n \n SFDC\n FIRST_NAME\n \n \n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n \n FIRST_NAME:John AND STATUS:ACTIVE\n \n" }, "activeRecords" : { "summary" : "Active Records by Record IDs", "description" : "Specify active golden records by their IDs. The recordStatus attribute is omitted (defaults to ACTIVE).", "value" : "\n 1ca890ab-ed57-4534-809e-fd7fc117f2d9\n 90542057-a68b-4b17-857d-1706d661694a\n 6bb11d94-6f75-4a9a-a8c9-6cca8850a396\n" }, "endDatedRecords" : { "summary" : "End-dated Records by Record IDs", "description" : "Specify end-dated (inactive) golden records by their IDs. The recordStatus attribute is set to END_DATED.", "value" : "\n 9d2f711c-f7df-e908-4354-75deba098ac1\n a496166d-6017-d758-71b4-b68a75024509\n 693a0588-acc6-9c8a-a9a4-57f649d11bb6\n" } } } }, "required" : true }, "responses" : { "202" : { "description" : "Received the request by the repository. The response body contains a system-assigned request ID for use in a Get Channel Updates Status or Cancel Channel Updates request.\n\n**Note:** If a request includes both `` elements and ``, it disregards ``.", "content" : { "application/xml" : { "schema" : { "type" : "string", "example" : "147", "xml" : { "name" : "response" } }, "example" : "147" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/sources/{sourceId}/records/updates/{jobId}" : { "get" : { "tags" : [ "Channels" ], "summary" : "Get Channel Updates Status", "description" : "The Get Channel Updates Status operation retrieves by request ID, the status of a Propagate Channel Updates request.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Source Management\n OR\n - MDM - Activity Reporting", "operationId" : "getChannelUpdatesForRecordsStatus", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" }, { "name" : "jobId", "in" : "path", "description" : "ID of the Propagate Channel Updates request. You can obtain this ID from the response body for that request.", "required" : false, "example" : "139" } ], "responses" : { "200" : { "description" : "The body of the response is XML. The root `` element has the following attributes. The attribute values are counts of golden records processed in response to the Propagate Channel Updates request:\n\n- **totalCount** — If you specify `` elements in the Propagate Channel Updates request body, this count is the sum of all specified golden records and any specified invalid golden record IDs. If you specify `` in the Propagate Channel Updates request body and did not specify `` elements, this count is of the golden records that met all of the filtering criteria.\n\n- **successCount** — The sum of golden records for propagated update requests and golden records that did not propagate update requests due to the application of propagation rules configured for the specified universe and source combination.\n\n- **errorCount** — Golden records that did not propagate update requests due to the specification of invalid golden record IDs in the Propagate Channel Updates request body.\n\n**`` contains the following child elements:**\n\n- **``** — The submittal date and time of the Propagate Channel Updates request.\n\n- **``** — Date and time the processing of the Propagate Channel Updates request ended. If the status is SUBMITTED or PROCESSING, this element is omitted.\n\n- **``** — Contains one of the following tokens:\n - **SUBMITTED** — Accepted the request submission, but processing of golden records specified in the request has not begun.\n - **PROCESSING** — Processing of golden records specified in the request is in progress.\n - **COMPLETED** — Propagated the update requests for all golden records specified in the request.\n - **COMPLETED_WITH_ERRORS** — Processed all golden records specified in the request. Propagated update requests for some golden records but errors occurred processing others.\n - **TERMINATED** — Processing of golden records stopped after errors occurred for 500 golden records.\n - **FAILED** — Processing of the request failed due to an unhandled exception.\n - **CANCELED** — The request was canceled as a result of a Cancel Channel Updates operation.\n\n- **``** — Each child `` contains either the ID of a golden record for which an error prevented the propagation of an update request or an invalid golden record ID specified in the Propagate Channel Updates request body. `` is empty if `` is SUBMITTED, PROCESSING, COMPLETED, or CANCELED.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/ChannelUpdatesStatus" }, "example" : "\n 2023-01-01T00:00:00Z\n 2023-01-01T00:00:00Z\n COMPLETED_WITH_ERRORS\n \n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] }, "delete" : { "tags" : [ "Channels" ], "summary" : "Cancel Channel Updates", "description" : "The Cancel Channel Updates operation cancels a Propagate Channel Updates request specified by its ID.\n\n**Additional Information:**\nThis operation is applicable to a request with a status of SUBMITTED or PROCESSING. You can obtain the status using a Get Channel Updates Status request.\n\n*Note:* You can implement requests for this operation in processes using the [HTTP Client connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-HTTP_Client_connector_d64af80e-febe-4cd2-89ad-e3d0fc53c502).\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Source Management", "operationId" : "cancelChannelUpdatesForRecordsStatus", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" }, { "name" : "jobId", "in" : "path", "description" : "ID of the Propagate Channel Updates request. You can obtain this ID from the response body for that request.", "required" : false, "example" : "139" } ], "responses" : { "200" : { "description" : "A response body containing `` indicates the successful cancellation of the Propagate Channel Updates request.", "content" : { "application/xml" : { "schema" : { "type" : "string", "example" : "", "xml" : { "name" : "response" } }, "example" : "" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/match" : { "post" : { "tags" : [ "Records" ], "summary" : "Match Entities", "description" : "The Match Entities operation sends a batch of entities from a contributing source, applies match rules, and returns match results for each entity in the batch. This operation helps you test how match rules apply to entities coming from a source so you can see potential duplicate records and make match rule adjustments.\n\n**Additional Information:**\nThe entities are represented in XML format. The batch is not staged - you can use the Update Golden Records operation to stage a batch of entities.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the View Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "matchEntities", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "ambiguousMatchSampleSize", "in" : "query", "description" : "Returns a specified number of sample ambiguous matches when a match fails due to too many potential matches. The response includes matched entities, match rounds, and fuzzy scores to help diagnose and refine match rules. Information returned also involves information about the golden record for the match. If fuzzy rules are used and more than 1,000 candidates are evaluated, up to 200 samples can be returned.", "required" : false } ], "requestBody" : { "description" : "In the request body, wrap the entities in a `` element. Specify the contributing source by its ID in the `` element's `src` attribute. In each entity, wrap the source record ID in an `` element.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/String" }, "example" : "\n \n 1\n bobby\n berwyn\n \n \n 311 555-1234\n home\n \n \n 311 555-4321\n mobile\n \n \n bob@gmail.com\n 1001\n \n \n 2\n mike\n chesterbrook\n \n \n 311 555-2345\n home\n \n \n 311 555-5432\n mobile\n \n \n mike@gmail.com\n 1002\n \n" } }, "required" : true }, "responses" : { "200" : { "description" : "In the response body the root element `` consists of a `` element for each batch entity. A `` element has the following attributes:\n\n**matchRule** - the match rule whose application resulted in a match (if there was a match).\n\n**status** - these are the possible values:\n\n- **SUCCESS** - the request was successfully processed.\n\n- **FAILED_TO_RUN** - an internal error occurred.\n\n- **TOO_MANY_MATCHES** - there are 10 or more matching elements (1,000 or more in the case of an exact matching expression grouped with a fuzzy matching expression).\n\n- **ALREADY_LINKED** - the records and IDs are the same and the entity is already linked to an entity in the source system.\n\n- **MATCH_REFERENCE_FAILURE** - the entity matches on a reference field but the field value does not resolve to a golden record.\n\n- **DUPLICATE** - two records have the same data, but different IDs.\n\nThe first child element in `` is ``, which contains a copy of the entity as it appeared in the request body.\n\nFor a result with status SUCCESS, `` is followed by a `` element for each matching golden record not yet linked to an entity in the source system. There is also a `` element for each matching golden record already linked to an entity in the source system. In the golden record representations in `` and `` elements, the id attribute value is the system golden record ID.\n\nIf you apply a match rule specifying fuzzy matching, it includes the `` element in the `` or `` element for each matching golden record. The `` element has these children:\n\n- **field** - the field containing the data used for matching.\n\n- **first** - the field value referenced first in the applied match rule. This value is either from the incoming entity or the matched golden record.\n\n- **second** - the field value referenced second in the applied match rule. This value is either from the incoming entity or the matched golden record.\n\n- **method** - the similarity algorithm specified by the applied match rule - either [jarowinkler (Jaro-Winkler)](https://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance), [levenshtein](https://en.wikipedia.org/wiki/Levenshtein_distance), [bigram](https://en.wikipedia.org/wiki/N-gram), [trigram](https://en.wikipedia.org/wiki/N-gram) or [soundex](https://en.wikipedia.org/wiki/Soundex).\n\n- **matchStrength** - the strength of the fuzzy match. A value of 1.0 indicates perfect similarity.\n\n- **threshold** - the tolerance level for application of the similarity algorithm specified by the applied match rule.\n\nField values are masked if masking is configured in the model and the user cannot view masked data.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/MatchEntitiesResponse" }, "examples" : { "matchReferenceFailure" : { "summary" : "Match Reference Failure", "description" : "For a result with status MATCH_REFERENCE_FAILURE, it omits the element. The element is instead followed by , which contains details about the match reference failure.", "value" : "\n \n \n \n 1\n bobby\n berwyn\n \n \n 311 555-1234\n home\n \n \n 311 555-4321\n mobile\n \n \n bob@gmail.com\n 1313\n \n \n Unable to match on {spouse} field value '1313' because it does not resolve to a golden record.\n \n" }, "tooManyMatches" : { "summary" : "Too Many Matches", "description" : "For a result with status TOO_MANY_MATCHES, the response includes matched entities, match rounds, and fuzzy scores. Shows multiple potential matches with detailed fuzzy matching information for each match candidate.", "value" : "\n \n \n \n person1-SF\n Elvira\n Holden\n 156-96-2973-\n JosephRSalazar@dodgit.com\n 57\n 1967-05-13\n female\n
\n 3344 Nixon Avenue\n Ooltewah\n TN\n 37363\n US\n 35.054935\n -85.118251\n
\n \n \n Home\n 423-238-8261\n \n \n 1994 Porsche 928\n Terrazzo worker\n Asian Fusion\n Haided\n oF5aiqueu\n 183\n 93.8\n \n \n \n \n 102f8bdb-75b0-4c23-87ab-7d36c081a938\n Shirley\n Holden\n 156-96-2972\n ShirleyJHolden@spambob.com\n 55\n 1969-03-18\n female\n
\n 255 Watson Street\n Ventnor City\n NJ\n 08046\n US\n 39.250841\n -74.482126\n
\n \n \n Home\n 609-822-2590\n \n \n 2001 Chevrolet Trans Sport\n Marketing manager\n The White Rabbit\n Scance\n UShahwee5gai\n 173.0\n 71.1\n 667f523b-bccd-4632-b311-b8d405d4399d\n \n \n last_name\n Holden\n Holden\n jarowinkler\n 1.0\n 0.85\n \n \n first_name\n Shirley\n Elvira\n jarowinkler\n 0.53968257\n 0.85\n \n \n \n \n 1534a837-e13b-459c-bb8f-3f004bc799a1\n Frances\n Hodge\n 392-20-0441\n FrancesJHodge@dodgit.com\n 56\n 1968-07-18\n female\n
\n 3405 Hartland Avenue\n Appleton\n WI\n 54911\n US\n 44.252196\n -88.418601\n
\n \n \n Home\n 920-381-5650\n \n \n 2003 Rover City\n Instrumentation technician\n Strategic Profit\n Cinceres\n aih0jueK\n 169.0\n 85.0\n 0e16c88f-6a9c-48b9-a784-7163a78ad1b3\n \n \n last_name\n Hodge\n Holden\n jarowinkler\n 0.8577778\n 0.85\n \n \n first_name\n Frances\n Elvira\n jarowinkler\n 0.0\n 0.85\n \n \n \n" }, "successfulMatch" : { "summary" : "Successful Match with Fuzzy Matching", "description" : "Shows a successful match result (status=SUCCESS) with both match and duplicate elements. Includes fuzzy match details demonstrating Jaro-Winkler similarity scoring. Also includes an ALREADY_LINKED result showing an entity already linked to a source record.", "value" : "\n \n \n \n 1\n bobby\n berwyn\n \n \n 311 555-1234\n home\n \n \n 311 555-4321\n mobile\n \n \n bob@gmail.com\n 1001\n \n \n \n \n e6e1b847-d61a-46d9-a610-c678ba40ca41\n bob\n berwyn\n \n \n 311 555-1234\n home\n \n \n 311 555-4321\n mobile\n \n \n bob@gmail.com\n 1001\n \n \n name\n BOBBY\n BOB\n jarowinkler\n 0.90666664\n 0.85\n \n \n \n \n fc8cd5be-ac26-4e9a-9d0c-6b397a124172\n bob\n berwyn\n \n \n 311 555-5678\n home\n \n \n 311 555-8765\n mobile\n \n \n bob@gmail.com\n 1001\n \n \n name\n BOBBY\n BOB\n jarowinkler\n 0.90666664\n 0.85\n \n \n \n \n \n \n 2\n mike\n chesterbrook\n \n \n 311 555-2345\n home\n \n \n 311 555-5432\n mobile\n \n \n mike@gmail.com\n 1002\n \n \n \n" } } } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_VIEW)" : [ ] } ] } }, "/universes/{universeId}/quarantine/query" : { "post" : { "tags" : [ "Quarantine" ], "summary" : "Query Quarantine Entries", "description" : "The Query Quarantine Entries operation sends a query of the quarantine entries for a specified universe (domain) under the authenticated account. The query response includes the resolution status, the source entity involved, the quarantine cause, and a detailed reason for the quarantine.\n\nThe data provided in the response is historical. This means that if a model or match rule changes, the response contains not only the current quarantined entries for the entity but also any previous ones that were quarantined before you made changes.\n\nField values are masked if model fields contain masking configurations, the request uses JWT authentication, and you do not have permission to view masked data. You can view masked data if you have the MDM Administrator or MDM Privileged Data Steward role, the MDM - Reveal Masked Data privilege, or the Reveal Masked Data entitlement.\n\n**Additional Information:**\n*Note:* You can implement requests for this operation in processes using the [Boomi Data Hub connector's query quarantine entries operation](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/int-BDH_Query_Quarantine_Entries).\n\nAlternatively, you can use the [HTTP Client connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-HTTP_Client_connector_d64af80e-febe-4cd2-89ad-e3d0fc53c502), as demonstrated by the sample process [Hub: Query Quarantine Entries](https://platform.boomi.com/#build;processLibrary=7a24b7d3-a197-410c-aa98-1a2519896ffa), which you can install in your account from the process library in Integration.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the View Quarantine [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "queryQuarantine", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" } ], "requestBody" : { "description" : "You can use the optional `offsetToken` and `limit` attributes for `` for paging. The `limit` value is the maximum number of quarantine entries to return per page. It enforces a maximum of 200 entries per page regardless of the limit value. The `offsetToken` value corresponds to the same value returned from a previous Query Quarantine Entries request.\n\nThe optional `includeData` attribute has a Boolean value: Set to **true** (the default) to request entity data in addition to quarantine entry metadata. Set to **false** to request only quarantine entry metadata.\n\nThe optional `type` attribute for `` sets a filter by status. Valid values: **ACTIVE** (default) — retrieve only active quarantine entries. **ALL** — retrieve active and resolved quarantine entries. **RESOLVED** — retrieve only resolved quarantine entries.\n\n**``** sets query filter parameters and the query operator. The optional `op` attribute specifies the query operator. Valid values are AND (all filtering criteria) or OR (any filtering criterion). The default is AND.\n\nEach child element of `` sets a query filter parameter:\n\n- **``** (optional) — Sets a filter by source. Specify the source by its unique ID.\n\n- **``** (optional) — Sets a filter by source entity ID. This filter is effective only if you set a filter, using sourceId, for the source of the quarantined entity.\n\n- **``** (optional) — Sets a filter by the date and time of quarantine entry creation. `` sets the range's starting date and time; `` sets the range's ending date and time. Format for both is yyyy-MM-dd'T'HH:mm:ss'Z'. Omitting `` filters entries created before the `` date and time. Omitting `` filters entries created after the `` date and time.\n\n- **``** (optional) — Sets a filter by date and time of quarantine entry resolution. Same ``/`` format and omission behavior as `` for resolved entries.\n\n- **``** (optional, repeatable) — Sets a filter by the reason for quarantining. One token per occurrence. Valid tokens:\n - **AMBIGUOUS_MATCH** — entities matching 10 or more golden records (1,000+ with exact+fuzzy).\n - **DUPLICATE_KEY** — multiple collection items with same key values.\n - **ENRICH_ERROR** — failed data quality steps.\n - **FIELD_FORMAT_ERROR** — data not conforming to field type/validation or 255-character limit.\n - **INCORPORATE_ERROR** — errors other than unresolvable references during incorporation.\n - **MATCH_REFERENCE_UNKNOWN** — reference field value in match rule does not resolve to a golden record.\n - **MULTIPLE_MATCHES** — matching multiple golden records not linked to source.\n - **PARSE_FAILURE** — missing source entity ID or exceeding collection item limit.\n - **POSSIBLE_DUPLICATE** — matching golden records linked to source.\n - **RECORD_ALREADY_ENDDATED** — link from an end-dated golden record.\n - **REFERENCE_UNKNOWN** — unresolvable references (collection items or referential integrity fields).\n - **REQUIRED_FIELD** — omitted required fields.\n - **REQUIRES_APPROVAL** — conditions requiring manual approval of new contributions.\n - **REQUIRES_END_DATE_APPROVAL** — source requires manual approval to end-date.\n - **REQUIRES_UPDATE_APPROVAL** — conditions requiring manual approval to update matching records.\n - **REQUIRES_UPDATE_WITH_BASE_VALUE_APPROVAL** — pending link and field with base value.\n\n- **``** (optional, repeatable) — Sets a filter by the resolution of a quarantine entry. One token per occurrence. Effective only if `type` is RESOLVED. Valid tokens:\n - **GRID_DELETED** — user deleted the golden record.\n - **INCORPORATE_SUCCESS** — resolved by successful incorporation of replacement.\n - **RESTORED** — resolved by restoring end-dated golden record.\n - **SUPERSEDED** — newer version contributed.\n - **USER_APPROVED** — user approved entity.\n - **USER_IGNORE** — user requested deletion.\n - **USER_IGNORED_ENRICHMENT** — user resubmitted ignoring enrichment.\n - **USER_MATCHED** — user resolved matching issue.\n - **USER_REJECTED** — user rejected entity.\n - **USER_REPLAY** — user resubmitted without editing.\n - **USER_REPLAY_WITH_EDITS** — user edited and resubmitted.\n - **USER_RETRIED_ENRICHMENT** — user resubmitted retrying enrichment.\n - **USER_SELECTIVE_MERGED** — user merged fields into golden record and rejected entity.\n\n- **``** (optional, repeatable) — Sets a filter by field value. The `name` attribute specifies the field Unique ID. The `value` attribute matches on the beginning of the field value. For example, 4617 Main St matches 4 or 4617 Main.\n\nElements corresponding to unused filter parameters must be omitted from ``.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/QuarantineQueryRequest" }, "example" : "\n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n 6f78f990-dbb9-4d97-94ff-64f7d31bc66f\n SFDC\n POSSIBLE_DUPLICATE\n USER_APPROVED\n \n \n" } }, "required" : true }, "responses" : { "200" : { "description" : "The response body contains the XML representation of the query results.\n\n**`` Root Element:**\n\nThe root element `` has the following attributes:\n\n- `resultCount`: Specifies the number of quarantine entries returned on this page of results\n- `totalCount`: Specifies the total number of quarantine entries satisfying the query\n- `offsetToken` (returned only if there are additional results): You can use the returned token in a subsequent Query Quarantine Entries request to get the next page of results\n\n**`` Element:**\n\nEach `` element contains:\n\n- ``: The query filter token corresponding to the category of the reason for quarantining\n- ``: The reason for quarantining\n- `` (optional): A comma-delimited list of fields in the entity requiring approval or containing invalid data. This element is omitted for an entity quarantined due to a parsing failure, an enrichment error, or a matching issue\n- `` (optional): The ordinal of the match rule in the domain model whose application resulted in a matching error and the quarantining of the entity. This element is present only for an entity quarantined due to a matching error\n- `` (optional): The query filter token corresponding to the reason for resolution. This element is present only for a resolved quarantine entry\n- `` (optional): The quarantined entity. This element is present only if the attribute `includeData` in `` has the value `true` or the attribute is omitted\n\n**QuarantineEntry Attributes:**\n\n- `createdDate`: Time stamp of the quarantining of this entity\n- `sourceId`: source ID of the quarantined entity\n- `sourceEntityId`: Source entity ID of the quarantined entity\n- `transactionId`: Internal ID associated with this entity upon its initial receipt for processing. You can use this ID to individually fetch the quarantine entry using a Get Quarantine Entry operation\n- `endDate` (resolved quarantine entries only): Time stamp of the resolution of this quarantine entry\n\n**Sorting:**\n\n`` elements are sorted in the same manner as active quarantine entries are sorted by default on the Quarantine page: primarily by the `createdDate` time stamp attribute value, from newest to oldest.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/QuarantineQueryResponse" }, "example" : "\n \n ENRICH_ERROR\n At data quality step 'boomi-internal-sitest-priv_dev:::AddressVerification': [304] Address Not Found.\n \n \n 2\n jack\n not home\n berwyn\n PA\n 19312\n \n \n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (QUARANTINE_VIEW)" : [ ] } ] } }, "/universes/{universeId}/quarantine/{transactionId}/approve" : { "post" : { "tags" : [ "Quarantine" ], "summary" : "Approve Quarantined Entity", "description" : "The Approve Quarantine Entity operation allows the authenticated user to approve a quarantined entity to create, update, or end-date a golden record.\n\nYou can obtain a list of entity transactions using the [Query Transactions operation](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Query_Transactions) or in the quarantined entity detail screen in the user interface.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "approveTransaction", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "transactionId", "in" : "path", "description" : "Transaction ID you want to approve. You can obtain a list of entity transactions using the Query Transactions operation or in the quarantined entity detail screen in the user interface.", "required" : false }, { "name" : "approvalType", "in" : "query", "required" : false }, { "name" : "baseValueUpdate", "in" : "query", "description" : "If set to `true`, entity is approved with the base value. You can use this parameter when the quarantine cause is `REQUIRES_UPDATE_WITH_BASE_VALUE_APPROVAL`.", "required" : false } ], "responses" : { "200" : { "description" : "The body of the response is XML. The root element is ``. Within that element `` contains a Boolean value indicating the approval of the quarantined entity — `true` for success.\n\nFor a successful approval, the `` element indicates the subsequent creation, updating, or end-dating of a golden record or the creation of a quarantine entry.\n\n**`` Element Attributes:**\n\n- `id`: The entity transaction ID\n- `updatedDate`: The entity approval date\n- `state`: Transaction status:\n- `PROCESSING`: The entity is currently processing in Boomi Data Hub\n- `QUARANTINED`: The entity is quarantined and awaits manual resolution\n- `COMPLETED`: Processing completed, resulting in the creation, updating, or end-dating of a golden record or no operation on a golden record\n- `ERRORED`: Processing ended due to an unexpected error\n- `DELETED`: After quarantining the entity, its entry was manually deleted, thus ending the transaction\n- `stateDetail`: Status detail of the transaction", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/ApprovalResponse" }, "examples" : { "createGoldenRecord" : { "summary" : "Creation of a Golden Record", "description" : "Sample response body for creation of a golden record. Shows state=COMPLETED and stateDetail=CREATED.", "value" : "\n true\n \n" }, "updateGoldenRecord" : { "summary" : "Updating of a Golden Record", "description" : "Sample response body for updating of a golden record. Shows state=COMPLETED and stateDetail=UPDATED.", "value" : "\n true\n \n" }, "endDateGoldenRecord" : { "summary" : "End-dating of a Golden Record", "description" : "Sample response body for end-dating of a golden record. Shows state=COMPLETED and stateDetail=DELETED.", "value" : "\n true\n \n" }, "createQuarantineEntry" : { "summary" : "Creation of a Quarantine Entry", "description" : "Sample response body for creation of a quarantine entry. Shows state=QUARANTINED and stateDetail=INCORPORATE_ERROR.", "value" : "\n true\n \n" } } } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/quarantine/sources/{sourceId}/entities/{entityId}" : { "get" : { "tags" : [ "Quarantine" ], "summary" : "Get Quarantine Entry for Source Entity", "description" : "The Get Quarantine Entry for Source Entity operation retrieves the active quarantine entry corresponding to specified source entity in a universe (domain) under the authenticated account.\n\nField values are masked if model fields contain masking configurations, the request uses JWT authentication, and you do not have permission to view masked data. You can view masked data if you have the MDM Administrator or MDM Privileged Data Steward role, the MDM - Reveal Masked Data privilege, or the Reveal Masked Data entitlement.\n\n**Additional Information:**\n*Note:* You can implement requests for this operation in processes using the [Boomi Data Hub connector's get quarantine entry operation](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/int-BDH_Get_Quarantine_Entry).\n\nAlternatively, you can use the [HTTP Client connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-HTTP_Client_connector_d64af80e-febe-4cd2-89ad-e3d0fc53c502), as demonstrated by example 2 in the sample process [Hub: Get Master Data by Source](https://platform.boomi.com/AtomSphere.html#build;processLibrary=7a24b7d3-a197-410c-aa98-1a2519896ffa), which you can install in your account from the process library in Integration.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the View Quarantine [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "fetchQuarantineEntryForSourceEntity", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID", "required" : false }, { "name" : "entityId", "in" : "path", "description" : "Source entity ID. It must be URL encoded if it contains special characters.", "required" : false }, { "name" : "includeData", "in" : "query", "description" : "Set to `true` (the default) to request entity data in addition to quarantine entry metadata. Set to `false` to request only quarantine entry metadata. Optional.", "required" : false } ], "responses" : { "200" : { "description" : "The body contains the XML representation of the quarantine entry.\n\n**`` Element:**\n\nWithin the root `` element:\n\n- ``: The Query Quarantine Entries filter token corresponding to the category of the reason for quarantining\n- ``: The reason for quarantining\n- `` (optional): A comma-delimited list of fields in the entity requiring approval or containing invalid data. This element is omitted for an entity quarantined due to a parsing failure, an enrichment error, or a matching issue\n- `` (optional): The ordinal of the match rule in the domain model whose application resulted in a matching error and the quarantining of the entity. This element is present only for an entity quarantined due to a matching error\n- `` (optional): The quarantined entity. This element is present only if the query parameter `includeData` in the request is `true` or omitted\n\n**QuarantineEntry Attributes:**\n\n- `transactionId`: Internal ID associated with this entity upon its initial receipt for processing\n- `sourceId`: source ID of the entity\n- `entityId`: Source entity ID of the entity\n- `createdDate`: Time stamp of the quarantining of the entity", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/QuarantineEntry" }, "example" : "\n ENRICH_ERROR\n At data quality step 'boomi-internal-sitest-priv_dev:::AddressVerification': [304] Address Not Found.\n \n \n 2\n jack\n not home\n berwyn\n PA\n 19312\n \n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (QUARANTINE_VIEW)" : [ ] } ] } }, "/universes/{universeId}/quarantine/{transactionId}/delete" : { "post" : { "tags" : [ "Quarantine" ], "summary" : "Delete Quarantined Entry for Transaction", "description" : "The Delete Quarantined Entry for Transaction operation deletes a quarantine entry associated with a specified transaction from a specified universe (domain) under the authenticated account.\n\nIf the quarantined transaction is for a potential duplicate or a record already end-dated error, consider using the [Reject operation](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Reject_Quarantined_Entity_for_Transaction_bf5f4bab-c0c9-4702-ac61-07c94f87af37) instead since it sends a REJECT request to the source.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Delete Quarantine [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "deleteQuarantineEntryByTransactionId", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "transactionId", "in" : "path", "description" : "Transaction ID, which you can obtain from a Query Quarantine Entries operation.", "required" : false } ], "responses" : { "200" : { "description" : "The operation deleted the retrieved quarantine entry, and an update request specifying a delete operation propagated on the channel of the contributing source." }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (QUARANTINE_DELETE)" : [ ] } ] } }, "/universes/{universeId}/quarantine/sources/{sourceId}/entities/{entityId}/delete" : { "post" : { "tags" : [ "Quarantine" ], "summary" : "Delete Quarantined Entry by Source Entity ID", "description" : "The Delete Quarantined Entry by Source Entity ID operation deletes a quarantine entry associated with a specific source entity ID from a specific universe (domain) under the authenticated account.\n\nIf the quarantined entity is for a potential duplicate or a record already end-dated error, consider using the [Reject operation](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Reject_Quarantined_Entity_for_Transaction_bf5f4bab-c0c9-4702-ac61-07c94f87af37) instead since it sends a REJECT request to the source.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Delete Quarantine [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "deleteQuarantineEntryBySourceEntityId", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID", "required" : false }, { "name" : "entityId", "in" : "path", "description" : "Source entity ID associated with the quarantine entry. It must be URL encoded if it contains special characters.", "required" : false } ], "responses" : { "200" : { "description" : "Deleted the retrieved quarantine entry and sent an update request specifying a delete operation propagated on the channel of the contributing source." }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (QUARANTINE_DELETE)" : [ ] } ] } }, "/universes/{universeId}/quarantine/sources/{sourceId}/entities/{entityId}/reject" : { "post" : { "tags" : [ "Quarantine" ], "summary" : "Reject Quarantined Entity by Source Entity ID", "description" : "The Reject Quarantined Entity by Source Entity ID operation resolves a quarantine entry for a potential duplicate error or record already end-dated error by rejecting the quarantined entity. A REJECT update is sent to the source so the source and Hub are in sync. This operation is associated with a specified quarantined entity from a given universe (deployed model) for the authenticated user.\n\n**Additional Information:**\nThis operation resolves a quarantine entry for a potential duplicate error or record already end-dated error by rejecting the quarantined entity. A REJECT update is sent to the source so the source and Hub are in sync.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Reject Quarantine [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "rejectQuarantineEntryBySourceEntityId", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID", "required" : false }, { "name" : "entityId", "in" : "path", "description" : "Source entity ID. It must be URL encoded if it contains special characters.", "required" : false } ], "responses" : { "200" : { "description" : "Deleted the retrieved quarantine entry and an update request specifying a delete operation propagated on the channel of the contributing source." }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (QUARANTINE_REJECT)" : [ ] } ] } }, "/universes/{universeId}/quarantine/{transactionId}/reject" : { "post" : { "tags" : [ "Quarantine" ], "summary" : "Reject Quarantined Entity for Transaction", "description" : "The Reject Quarantined Entity for Transaction operation resolves a quarantine entry for a potential duplicate error or a record already end-dated error. The operation rejects the quarantined entity sends a REJECT update to the source so that the source and Hub are in sync. This operation is associated with a specified quarantine transaction from a given universe (deployed model) for the authenticated user.\n\n**Additional Information:**\nThis operation resolves a quarantine entry for a potential duplicate error or a record already end-dated error. The operation rejects the quarantined entity sends a REJECT update to the source so that the source and Hub are in sync.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Reject Quarantine [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "rejectQuarantineEntryByTransactionId", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "transactionId", "in" : "path", "description" : "Transaction ID, which you can obtain from a Query Quarantine Entries operation. It must be URL encoded if it contains special characters.", "required" : false } ], "responses" : { "200" : { "description" : "The operation deleted the retrieved quarantine entry, and an update request specifying a delete operation propagated on the channel of the contributing source." }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (QUARANTINE_REJECT)" : [ ] } ] } }, "/universes/{universeId}/quarantine/sources/{sourceId}/entities/{entityId}/createDuplicate" : { "post" : { "tags" : [ "Quarantine" ], "summary" : "Create Golden Record from Matching Error Quarantine Entry by Source Entity ID", "description" : "The Create Golden Record from Matching Error Quarantine Entry by Source Entity ID operation creates a golden record from a quarantine entry identified as a potential duplicate record. The operation resolves matching conflicts for the quarantine entry that is associated with a specific source entity ID from a specific universe (domain) under the authenticated account.\n\n**Additional Information:**\nThis operation creates a golden record from a quarantine entry identified as a potential duplicate record and resolves matching conflicts.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Match Quarantine [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "createDuplicateBySourceEntityId", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID", "required" : false }, { "name" : "entityId", "in" : "path", "description" : "Source entity ID associated with the matching error quarantine entry, which you can obtain from a Query Quarantine Entries operation. It must be URL encoded if it contains special characters.", "required" : false } ], "responses" : { "200" : { "description" : "Resolved matching conflicts and created a golden record from the quarantine entry.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/MatchResolveResponse" }, "example" : "true" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (QUARANTINE_MATCH)" : [ ] } ] } }, "/universes/{universeId}/quarantine/{transactionId}/createDuplicate" : { "post" : { "tags" : [ "Quarantine" ], "summary" : "Create Golden Record from Matching Error Quarantine Entry for Transaction", "description" : "The Create Golden Record from Matching Error Quarantine Entry for Transaction operation creates a golden record from a quarantine entry identified as a potential duplicate record. The operation resolves matching conflicts for the quarantine entry that is associated with a specific transaction ID from a specific universe (domain) under the authenticated account.\n\n**Additional Information:**\nThis operation creates a golden record from a quarantine entry identified as a potential duplicate record and resolves matching conflicts.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Match Quarantine [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "createDuplicateByTransactionId", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "transactionId", "in" : "path", "description" : "Transaction ID associated with the matching error, which you can obtain from a Query Quarantine Entries operation.", "required" : false } ], "responses" : { "200" : { "description" : "Resolved matching conflicts and created a golden record from the quarantine entry.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/MatchResolveResponse" }, "example" : "true" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (QUARANTINE_MATCH)" : [ ] } ] } }, "/universes/{universeId}/quarantine/{transactionId}/restore" : { "post" : { "tags" : [ "Quarantine" ], "summary" : "Restore End-dated Golden Record for Transaction", "description" : "The Restore End-dated Golden Record for Transaction operation resolves a quarantine entry for a Record Already End-Dated error. It restores the end-dated golden record and resolves the quarantine error. The quarantine entry is associated with a specific transaction from a universe (domain) under the authenticated account. Restoring the record marks it as active again, removing the end-date status. End-dated records are considered inactive with the intention to delete them permanently through the [purge operation](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Purge_Multiple_Golden_Records_cfca7eea-9530-4b1e-8b51-d59418451491).\n\n**Additional Information:**\nWhen you end-date a record that references another record, if that referenced record is also end-dated, restoring the reference will not make it visible in the end-dated record view. This is because end-dated records are inactive, so any restored references will not show up in those end-dated records.\n\n*Note:* You can implement requests for this operation in processes using the [HTTP Client connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-HTTP_Client_connector_d64af80e-febe-4cd2-89ad-e3d0fc53c502), as demonstrated by example 3 in the sample process [Hub: Restore End-dated Golden Record](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Restore_End-dated_Golden_Record_for_Transaction_a0555bc1-7dd0-4590-83a4-0339f7306c89), which you can install in your account from the process library in Integration.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Restore Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "restoreQuarantineEntryByTransactionId", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "transactionId", "in" : "path", "description" : "Quarantine entry transaction ID, which you can obtain from a Query Quarantine Entries operation.", "required" : false } ], "responses" : { "200" : { "description" : "The body of the response is XML. The root element is ``. Within that element, `` contains a Boolean value indicating the deletion of the retrieved quarantine entry — true for success. For a successful deletion, the `` element indicates that the golden record is restored and the quarantined entity is incorporated into the golden record. Alternatively, a subsequent quarantine cause (stateDetail) may be attached to the quarantined entity and transaction ID associated with the golden record, preventing the incorporation of the quarantined entity. For example, the entity remains quarantined because the record requires approval before updating or because there is a field format error.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/QuarantineRestoreResponse" }, "examples" : { "subsequentQuarantineCause" : { "summary" : "Subsequent Quarantine Cause", "description" : "Sample response body when a restore operation is attempted on a quarantined record, but the restore fails and the entry remains quarantined. Shows state=QUARANTINED and stateDetail=FIELD_FORMAT_ERROR, indicating a subsequent quarantine cause was attached to the entity.", "value" : "\n true\n \n" }, "updateRestoredGoldenRecord" : { "summary" : "Updating of the Restored Golden Record", "description" : "Sample response body for updating of the restored golden record that was previously quarantined. Shows state=COMPLETED and stateDetail=UPDATED.", "value" : "\n true\n \n" } } } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_RESTORE)" : [ ] } ] } }, "/universes/{universeId}/records/enddated" : { "post" : { "tags" : [ "Records" ], "summary" : "Query End-dated Golden Records", "description" : "The Query End-dated Golden Records operation sends a query of end-dated golden records in a specific universe (domain) under the authenticated account. This operation does not support filtering. Querying end-dated records lets you review the records marked for deletion before you permanently delete them since you cannot restore a purged record.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the View Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "queryEndDatedRecords", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "limit", "in" : "query", "description" : "Maximum number of query results. 200 is the maximum meaningful value and the default.", "required" : false, "example" : "200" }, { "name" : "offsetToken", "in" : "query", "description" : "Used for paging. Refer to the offsetToken returned from a previous Query End-dated Golden Records request.", "required" : false, "example" : "MjAw" } ], "responses" : { "200" : { "description" : "The body contains the XML representation of the query results. It returns a maximum of 200 results per request unless the limit query parameter for a given request specifies a lower maximum number of results. The root element `` has a `resultCount` attribute that specifies the number of end-dated golden records returned and a `totalCount` attribute that specifies the total number of end-dated records. You can use the returned `offsetToken` attribute value in a subsequent Query End-dated Golden Records request to get the next \"page\" of results.\n\nEach `` element represents an end-dated golden record. The `recordId` attribute value is the golden record ID.\n\n`` has the child element ``. Within ``, the root element has the same name as the root element name in the universe. That element's child elements correspond to the fields in the universe's model. Each such element contains the field value.\n\nField values are masked if model fields contain masking configurations, the user cannot view masked data, and the request uses JWT authentication. Masking is not applied with basic authentication.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/RecordQueryResponse" }, "example" : "\n \n \n Dynamic field content - structure varies by universe schema\n \n \n \n \n Dynamic field content - structure varies by universe schema\n \n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_VIEW)" : [ ] } ] } }, "/universes/{universeId}/records/{recordId}/purge" : { "post" : { "tags" : [ "Records" ], "summary" : "Purge Single Golden Record", "description" : "The Purge Single Golden Record operation purges (permanently deletes) a specified end-dated golden record. [End-dated records](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-End-date_Multiple_Golden_Records_d1b7055a-5e18-45c9-97e0-47bd725146f7) are records marked as inactive for review before they are permanently deleted since you can restore an end-dated record to active status.\n\n**Additional Information:**\n*Note:* You can implement requests for this operation in Integration processes using the [HTTP Client connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-HTTP_Client_connector_d64af80e-febe-4cd2-89ad-e3d0fc53c502), as demonstrated by example 1 in the sample process [Hub: Purge Golden Record](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Purge_Single_Golden_Record_4083f5bd-c1e5-4852-9a90-e2a00230a334), which you can install in your account from the process library in Integration.\n\n**Warning:** This operation permanently deletes the record and cannot be undone. Only end-dated records can be purged.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Purge Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "purgeEndDatedRecord", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "recordId", "in" : "path", "description" : "Record ID", "required" : false, "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887" } ], "responses" : { "200" : { "description" : "In the response body, the root element is ``. That element contains a `` element.\n\nIn the `` element, recordID specifies the recordID parameter value and `` indicates whether a purge operation on an end-dated golden record with that ID was successful.\n\nIf `` contains true, it purged the end-dated golden record with the specified ID.\n\nIf `` contains false, it did not purge an end-dated golden record with the specified ID. An additional element, ``, indicates the reason the operation was unsuccessful.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/RecordPurgeResponse" }, "example" : "\n \n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n true\n Message element will appear only if the success is false\n \n \n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n true\n Message element will appear only if the success is false\n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_DELETE)" : [ ] } ] } }, "/universes/{universeId}/records/enddated/purge" : { "post" : { "tags" : [ "Records" ], "summary" : "Purge Multiple Golden Records", "description" : "The Purge Multiple Golden Records operation purges (permanently deletes) 1–100 specified end-dated golden records. [End-dated records](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-End-date_Multiple_Golden_Records_d1b7055a-5e18-45c9-97e0-47bd725146f7) are records marked as inactive for review before they are permanently deleted since you can restore an end-dated record to active status.\n\n**Additional Information:**\n**Warning:** This operation permanently deletes multiple records and cannot be undone. Only end-dated records can be purged. **Limit:** Maximum of 100 records can be purged in a single request.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship Management\n OR\n - MDM - Stewardship with the Purge Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n\n **Without Advanced Security:**\n - MDM - Stewardship Management\n OR\n - MDM - Stewardship", "operationId" : "purgeEndDatedRecords", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" } ], "requestBody" : { "description" : "In the request body, the root element is ``. Within that element, each `` element specifies an end-dated golden record to purge by its ID.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/RecordPurgeRequest" }, "example" : "\n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n" } }, "required" : true }, "responses" : { "200" : { "description" : "In the response body, the root element is ``. Within that element, a `` element corresponds to each golden record ID in the request body.\n\nIn each `` element, `` specifies a golden record ID in the request body and `` indicates whether a purge operation on an end-dated golden record with that ID was successful. If `` contains true, it purged an end-dated golden record with that ID.\n\nIf `` contains false, it did not purge an end-dated golden record with the specified ID. An additional element, ``, indicates the reason the operation was unsuccessful. Failure occurs in the following cases:\n\n- An end-dated golden record with the specified ID does not exist.\n\n- A golden record with the specified ID is active.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/RecordPurgeResponse" }, "example" : "\n \n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n true\n Message element will appear only if the success is false\n \n \n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n true\n Message element will appear only if the success is false\n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_DELETE)" : [ ] } ] } }, "/universes/{universeId}/records/{recordId}" : { "get" : { "tags" : [ "Records" ], "summary" : "Get Golden Record", "description" : "The Get Golden Record operation retrieves the entity corresponding to a specified golden record in a specified universe (domain) under the authenticated account.\n\n**Additional Information:**\n*Note:* You can implement requests for this operation in processes using the [Boomi Data Hub connector's get golden record operation](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/int-BDH_Get_Golden_Record). You can also implement requests using the [HTTP Client connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-HTTP_Client_connector_d64af80e-febe-4cd2-89ad-e3d0fc53c502), as demonstrated by example 1 in the sample process [Hub: Get Golden Record Information](https://platform.boomi.com/AtomSphere.html#build;processLibrary=7a24b7d3-a197-410c-aa98-1a2519896ffa), which you can install in your account from the process library in Integration.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the View Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "getRecord", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "recordId", "in" : "path", "description" : "Record ID", "required" : false, "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887" }, { "name" : "includeReferenceTitle", "in" : "query", "description" : "Record title for the reference record. Boolean. True adds the recordTitle attribute for the reference record in the reference field. The recordTitle attribute shows for the reference fields when the reference value is resolved and the reference universe has the title format defined.", "required" : false, "example" : "false" } ], "responses" : { "200" : { "description" : "In the returned entity, the root element name is the universe name. The child elements correspond to the fields in the represented golden record; each element contains the corresponding field value.\n\nIf the returned entity represents an active golden record, the root element's attributes are as follows:\n\n**createddate** — timestamp of the creation of the golden record.\n\n**grid** — ID of the golden record.\n\n**updateddate** — timestamp of the most recent update of the golden record.\n\n**source** — ID of the source whose entity contribution resulted in the golden record's creation.\n\n**recordTitle** — record title format (included if configured). If query parameter `includeReferenceTitle` is set to true and record contains a reference with a title format, record title for the reference is included.", "content" : { "application/xml" : { "schema" : { "title" : "Golden Record XML", "type" : "object", "properties" : { "createddate" : { "type" : "string", "description" : "Creation timestamp of the record", "example" : "2023-01-01T00:00:00Z", "xml" : { "attribute" : true } }, "grid" : { "type" : "string", "description" : "Golden record ID (UUID)", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "attribute" : true } }, "updateddate" : { "type" : "string", "description" : "Last update timestamp of the record", "example" : "2023-01-01T00:00:00Z", "xml" : { "attribute" : true } }, "source" : { "type" : "string", "description" : "Source system identifier", "example" : "CRM_SYSTEM", "xml" : { "attribute" : true } } }, "additionalProperties" : { "type" : "object", "description" : "Record field data - varies based on universe schema", "example" : "Field values as XML elements" }, "example" : "\n\n 3fccb7ed-7b36-4a2b-bf96-7d6ed220e2f8\n John Doe\n john.doe@example.com\n", "xml" : { "name" : "record" } }, "example" : "\n\n 3fccb7ed-7b36-4a2b-bf96-7d6ed220e2f8\n John Doe\n john.doe@example.com\n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_VIEW)" : [ ] } ] } }, "/universes/{universeId}/records/{recordId}/meta" : { "get" : { "tags" : [ "Records" ], "summary" : "Get Golden Record's Metadata", "description" : "The Get Golden Record's Metadata operation retrieves the metadata for a golden record in a universe (domain) under the authenticated account. The metadata includes the record ID, end date (if applicable), and source link information, including the source name, entity ID, and link date.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the View Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "getRecordMeta", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "recordId", "in" : "path", "description" : "Record ID", "required" : false, "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887" } ], "responses" : { "200" : { "description" : "In the retrieved representation of the specified golden record's metadata, the root element **Record** has the following attributes:\n\n**recordId** — ID of the golden record.\n\n**endDate** — if you end-date the golden record, it includes this attribute, and its value is the golden record's end-date time stamp.\n\nThe **links** element represents the golden record's established links to source entities, each of which is represented by a **link** element which has the following attributes:\n\n**source** — source's user-specified unique ID in Boomi Data Hub.\n\n**entityId** — source entity ID.\n\n**establishedDate** — time stamp of the establishment of the link.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/Record" }, "example" : "\n \n \n \n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_VIEW)" : [ ] } ] } }, "/universes/{universeId}/records/query" : { "post" : { "tags" : [ "Records" ], "summary" : "Query Golden Records", "description" : "The Query Golden Records operation sends a query of golden records in a specified universe (domain) under the authenticated account. The operation can retrieve active golden records only.\n\n**Performance Enhancement:**\nYou can activate Accelerated Query when you have 100,000 or more golden records in a deployed model (universe). This feature improves query performance significantly for large datasets.\n\n**Additional Information:**\n*Note:* You can implement requests for this operation in processes using the [Boomi Data Hub connector's query golden records operation](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/int-BDH_Query_Golden_Records).\n\nFor information on activating Accelerated Query, see: https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Stewardship/hub-accelerated_query\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the View Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "queryRecords", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "includeReferenceTitle", "in" : "query", "description" : "Record title for the reference record. Boolean. True adds the recordTitle attribute for the reference record in the reference field. The recordTitle attribute shows for the reference fields when the reference value is resolved and the reference universe has the title format defined.", "required" : false, "example" : "false" } ], "requestBody" : { "description" : "The body of the request has the following structure:\n\n**RecordQueryRequest attributes:**\n\n- **limit** (optional) — Maximum number of golden records to return. The user might, depending on its configuration, apply a more restrictive limit than that requested. The maximum record limit for repositories hosted in Hub Clouds is typically 200.\n\n- **includeSourceLinks** (optional) — If set to true, requests the return of golden record metadata in addition to data. The returned metadata includes the entity ID, name, and established date of each source linked to the record.\n\n- **offsetToken** (optional) — Use for paging. Refer to the offsetToken returned from a previous Query Golden Records request.\n\n**view** (optional) — Specifies one or more fields to return. Each such field is represented by a `` element, which contains the field ID. If you omit view, it returns all fields that contain values.\n\n**sort** (optional) — Specifies which fields or metadata to sort in the returned golden records. The order of the `` elements determines the relative sorting priority. In each `` element: The `` element specifies either a field ID for sorting by field value or one of: `@createdDate` (sorting by date and time of golden record creation), `@updatedDate` (sorting by date and time of last golden record update). The `` element specifies the sort order, either ASC for ascending or DESC for descending. It is not possible to sort by the value of reference, collection (repeatable), or collection item fields. Changing the sort criteria and attempting to use an offset token from a previous sort will produce unpredictable results. If you omit sort, it sorts golden records by their creation date in ascending order.\n\n**filter** — Sets query filter parameters and the query operator. The optional `op` attribute specifies the query operator: AND (all criteria) or OR (any criterion). Default is AND. The order in which you specify filter parameters is insignificant.\n\n- **createdDate** — Filter by date and time of golden record creation. `` and `` set the range's starting and ending date and time. Format for both: yyyy-MM-dd'T'HH:mm:ss'Z' (e.g., 2013-03-01T15:32:00Z). Omitting from filters golden records created before the to date; omitting to filters golden records created after the from date.\n\n- **updatedDate** — Filter by date and time of last golden record update. Same `` and `` format and omission rules as createdDate.\n\n- **recordIds** — Filter by 1–100 golden record IDs, each specified by ``. If set, other filters in the request are disregarded.\n\n- **fieldValue** — Filter by golden record field value. Multiple fieldValue sections allowed. Filter \"Op\" attribute: AND or OR. `` specifies the field ID. `` specifies the operator (valid values depend on field type). **All types:** EQUALS. **All except Reference and collection (repeatable)/collection item:** NOT_EQUALS, IS_NOT_NULL, IS_NULL. **Text and Long Text only:** CONTAINS, ENDS_WITH, STARTS_WITH. **Integer and Float only:** GREATER_THAN, GREATER_THAN_EQUAL, LESS_THAN, LESS_THAN_EQUAL. **Date, Date and Time, Time only:** BETWEEN. **Enumeration only:** IS_INVALID. A `` element specifies a value. One value per operator except: BETWEEN requires two values (range); EQUALS with Enumeration allows multiple values; IS_INVALID, IS_NOT_NULL, IS_NULL do not use value. Boolean values: true, false.\n\n- **tags** — Filter by one or more tags, each specified by ``. A golden record having any one of the specified tags meets the tag criteria.\n\n- **creatingSourceId** — Filter by creating source specified by its source ID.\n\n- **sourceLink** — Filter by presence or absence of links to a source. `` specifies the source by ID. `` is LINKED (presence) or NOT_LINKED (absence). *Note:* If the universe has one or more attached sources configured to allow multiple links to golden records, processing time for requests using the sourceLink filter may be significantly longer.\n\n- **unresolvedReference** — Filter by presence of unresolved reference field data. `` specifies the reference field by ID. `` is a source ID or `@all` (limits results to golden records for which all source contributions are unresolved). *Note:* A field's ID is on the model page's Fields tab in Boomi Data Hub; a source's ID is on the Sources page in Boomi Data Hub.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/RecordQueryRequest" }, "example" : "\n \n FIRST_NAME\n \n \n \n FIRST_NAME\n ASC\n \n \n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n \n FIRST_NAME\n EQUALS\n Sample Value\n \n \n SFDC\n LINKED\n \n SFDC\n \n VIP_CUSTOMER\n \n \n SFDC\n FIRST_NAME\n \n \n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n \n FIRST_NAME:John AND STATUS:ACTIVE\n \n" } }, "required" : true }, "responses" : { "200" : { "description" : "The body contains the XML representation of the query results. The root element `` has a **resultCount** attribute that specifies the number of golden records returned and a **totalCount** attribute that specifies the total number of records that meet the filter criteria. You can use the returned **offsetToken** attribute value in a subsequent Query Golden Records request to get the next \"page\" of results.\n\n*Note:* For reference fields, record title is not a part of the record query response.\n\nEach `` element represents a golden record. The **recordId** attribute value is the golden record ID. The **createdDate** attribute value is the time stamp of the creation of the golden record. The **updatedDate** attribute value is the time stamp of the last update of the golden record.\n\n`` has the child element ``. If in `` the **includeSourceLinks** attribute value was true, `` has an additional child element ``.\n\nWithin ``, the root element has the same name as the root element name in the universe. That element's child elements correspond to the fields in the universe's model. Each such element contains the field value.\n\nField values are masked if model fields contain masking configurations, the user cannot view masked data, and the request uses JWT authentication. Masking is not applied with basic authentication.\n\n**recordTitle** — record title format (included if configured). If query parameter `includeReferenceTitle` is set to true and record contains a reference with a title format, record title for the reference is included.\n\nIf `` is present, it represents the golden record's established links to sources, each one represented by a `` element which has the following attributes:\n\n**source** — source's user-specified unique ID in Boomi Data Hub.\n\n**entityId** — source entity ID.\n\n**establishedDate** — time stamp of the establishment of the link.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/RecordQueryResponse" }, "example" : "\n \n \n Dynamic field content - structure varies by universe schema\n \n \n \n \n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_VIEW)" : [ ] } ] } }, "/universes/{universeId}/records/{recordId}/enddate" : { "post" : { "tags" : [ "Records" ], "summary" : "End-date Single Golden Record", "description" : "The End-date Single Golden Record operation allows you to set a specific golden record as inactive. By end-dating a record, you can mark it for deletion and review it before permanently deleting it since you cannot restore a purged record.\n\n**Additional Information:**\n*Note:* When you end-date a record that references another record, if that referenced record is also end-dated, restoring the reference will not make it visible in the end-dated record view. This is because end-dated records are inactive, so any restored references will not show up in those end-dated records.\n\n*Note:* You can implement requests for this operation in processes using the [HTTP Client connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-HTTP_Client_connector_d64af80e-febe-4cd2-89ad-e3d0fc53c502), as demonstrated by example 1 in the sample process [Hub: End-date Golden Record](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-End-date_Single_Golden_Record_4ee27a09-1966-4d59-bafb-565d72593f0f), which you can install in your account from the process library in Integration.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the End-date Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "endDateRecord", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "recordId", "in" : "path", "description" : "Record ID", "required" : false, "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887" } ], "responses" : { "200" : { "description" : "In the response body, the root element is ``. That element contains a `` element.\n\nIn the `` element, `` specifies the recordID parameter value and `` indicates whether an end-date operation on an active golden record with that ID was successful.\n\nIf `` contains true, it end-dated the golden record with the specified ID, and a source record update request specifying a delete operation was propagated to each linked source.\n\nIf `` contains false, a golden record with the specified ID was not end-dated. An additional element, ``, indicates the reason the operation was unsuccessful.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/RecordEndDateResponse" }, "example" : "\n \n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n true\n Message element will appear only if the success is false\n \n \n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n true\n Message element will appear only if the success is false\n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_ENDDATE)" : [ ] } ] } }, "/universes/{universeId}/records/enddate" : { "post" : { "tags" : [ "Records" ], "summary" : "End-date Multiple Golden Records", "description" : "The End-date Multiple Golden Records operation allows you to set specific golden records as inactive. By end-dating records, you can mark them for deletion and review them before permanently deleting them since you cannot restore a purged record.\n\n**Additional Information:**\n*Note:* When you end-date a record that references another record, if that referenced record is also end-dated, restoring the reference will not make it visible in the end-dated record view. This is because end-dated records are inactive, so any restored references will not show up in those end-dated records.\n\n*Note:* You can implement requests for this operation in processes using the [HTTP Client connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-HTTP_Client_connector_d64af80e-febe-4cd2-89ad-e3d0fc53c502), as demonstrated by example 1 in the sample process [Hub: End-date Golden Record](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-End-date_Single_Golden_Record_4ee27a09-1966-4d59-bafb-565d72593f0f), which you can install in your account from the process library in Integration.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the End-date Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "endDateRecords", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" } ], "requestBody" : { "description" : "Requests for this operation must specify golden records to end-date either by their IDs or by applying a filter.\n\n**End-date by Record IDs (Synchronous):** If you specify golden records by their IDs, processing is synchronous. In the request body, the root element is ``. Within that element, each `` (optional) — a maximum of 100 — specifies a golden record to end-date by its ID.\n\n**End-date by Filter (Asynchronous):** If you specify golden records by applying a filter, it creates a bulk processing request — processing is asynchronous.\n\n**filter** — Sets query filter parameters and the query operator. The optional `op` attribute specifies the query operator: AND (all criteria) or OR (any criterion). Default is AND. The order in which you specify filter parameters is insignificant.\n\n- **createdDate** — Filter by date and time of golden record creation. `` and `` set the range's starting and ending date and time. Format for both: yyyy-MM-dd'T'HH:mm:ss'Z' (e.g., 2013-03-01T15:32:00Z). Omitting from filters golden records created before the to date; omitting to filters golden records created after the from date.\n\n- **updatedDate** — Filter by date and time of last golden record update. Same `` and `` format and omission rules as createdDate.\n\n- **fieldValue** — Filter by golden record field value. `` specifies the field ID. `` specifies the operator (valid values depend on field type). **All types:** EQUALS. **All except Reference and collection (repeatable)/collection item:** NOT_EQUALS, IS_NOT_NULL, IS_NULL. **Text and Long Text only:** CONTAINS, ENDS_WITH, STARTS_WITH. **Integer and Float only:** GREATER_THAN, GREATER_THAN_EQUAL, LESS_THAN, LESS_THAN_EQUAL. **Date, Date and Time, Time only:** BETWEEN. **Enumeration only:** IS_INVALID. A `` element specifies a value. One value per operator except: BETWEEN requires two values (Date and Time: yyyy-MM-dd'T'HH:mm:ss'Z'; Date: yyyy-MM-dd; Time: HH:mm:ss); EQUALS with Enumeration allows multiple values; IS_INVALID, IS_NOT_NULL, IS_NULL do not use value. Boolean values: true, false.\n\n- **tags** — Filter by one or more tags, each specified by ``. A golden record having any one of the specified tags meets the tag criteria.\n\n- **creatingSourceId** — Filter by creating source specified by its source ID.\n\n- **sourceLink** — Filter by presence or absence of links to a source. `` specifies the source by ID. `` is LINKED (presence) or NOT_LINKED (absence). *Note:* If the universe has one or more attached sources configured to allow multiple links to golden records, processing time for requests using the sourceLink filter may be significantly longer.\n\n- **unresolvedReference** — Filter by presence of unresolved reference field data. `` specifies the reference field by ID. `` is a source ID or `@all` (limits results to golden records for which all source contributions are unresolved). *Note:* A field's ID is on the model page's Fields tab in Boomi Data Hub; a source's ID is on the Sources page in Boomi Data Hub.\n\n*Note:* If a request includes both `` elements and ``, it disregards ``.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/RecordEndDateRequest" }, "examples" : { "filter" : { "summary" : "End-date by Filter (Asynchronous)", "description" : "Specify golden records by applying a filter. Creates a bulk processing request - processing is asynchronous.", "value" : "\n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n \n FIRST_NAME\n EQUALS\n Sample Value\n Sample Value\n \n \n FIRST_NAME\n EQUALS\n Sample Value\n Sample Value\n \n \n SFDC\n LINKED\n \n SFDC\n \n VIP_CUSTOMER\n VIP_CUSTOMER\n \n \n SFDC\n FIRST_NAME\n \n \n" }, "recordIds" : { "summary" : "End-date by Record IDs (Synchronous)", "description" : "Specify golden records by their IDs. Processing is synchronous. Maximum 100 record IDs.", "value" : "\n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n" } } } }, "required" : true }, "responses" : { "200" : { "description" : "The request body specified one or more `` elements. In the response body, the root element is ``. Within that element, a `` element corresponds to each golden record ID in the request body.\n\nIn each `` element, `` specifies a golden record ID in the request body and `` indicates whether an end-date operation on an active golden record with that ID was successful. If `` contains true, it end-dated an active golden record with that ID.\n\nIf `` contains false, it did not end-date an active golden record with the specified ID. An additional element, ``, indicates the reason the operation was unsuccessful. Failure occurs in the following cases:\n\n- An active golden record with the specified ID does not exist.\n\n- A golden record with the specified ID is already end-dated.\n\n- A golden record with the specified ID is referenced by another golden record.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/RecordEndDateResponse" }, "example" : "\n \n 0fc4eb6d-f12c-4cdd-ba37-5475caed4887\n true\n Message element will appear only if the success is false\n \n" } } }, "202" : { "description" : "The request body specified the `` element and did not specify `` elements. The repository accepted the end-dating request for processing. The response body is empty." }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_ENDDATE)" : [ ] } ] } }, "/universes/{universeId}/records/sources/{sourceId}/entities/{entityId}/restore" : { "post" : { "tags" : [ "Records" ], "summary" : "Restore End-dated Golden Record for Source Entity", "description" : "The Restore End-dated Golden Record for Source Entity operation restores the end-dated golden record linked to a source entity in a universe (domain) under the authenticated account. Restoring the record marks it as active again, removing the end-date status. End-dated records are considered inactive with the intention to delete them permanently through the [purge operation](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Purge_Multiple_Golden_Records_cfca7eea-9530-4b1e-8b51-d59418451491).\n\nIf an entity is quarantined because it refers to an end-dated golden record, Boomi Data Hub automatically resubmits the quarantine entity after you restore the record. Resubmitting automatically helps you easily resolve Reference Unknown and Matching Reference Unknown errors.\n\n**Additional Information:**\n*Note:* When you end-date a record that references another record, if that referenced record is also end-dated, restoring the reference will not make it visible in the end-dated record view. This is because end-dated records are inactive, so any restored references will not show up in those end-dated records.\n\n*Note:* You can implement requests for this operation in processes using the [HTTP Client connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-HTTP_Client_connector_d64af80e-febe-4cd2-89ad-e3d0fc53c502), as demonstrated by example 1 in the sample process [Hub: Restore End-dated Golden Record](https://platform.boomi.com/AtomSphere.html#build;processLibrary=7a24b7d3-a197-410c-aa98-1a2519896ffa), which you can install in your account from the process library in Integration.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship Management\n OR\n - MDM - Stewardship with the Restore Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n\n **Without Advanced Security:**\n - MDM - Stewardship Management\n OR\n - MDM - Stewardship", "operationId" : "restoreRecord", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" }, { "name" : "entityId", "in" : "path", "description" : "ID of the source entity. Must be URL encoded if it contains special characters.", "required" : false, "example" : "CUST_12345" } ], "responses" : { "200" : { "description" : "Restored the golden record linked to the source entity. The response body is empty." }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_RESTORE)" : [ ] } ] } }, "/universes/{universeId}/records/{recordId}/history" : { "get" : { "tags" : [ "Records" ], "summary" : "Get Golden Record History", "description" : "The Get Golden Record History operation retrieves the version history of a golden record in a universe (domain) under the authenticated account. The historical data about the golden record versions includes the version ID, creation date/time, contributing source, and transaction ID.\n\n**Additional Information:**\n${api.getRecordHistory.notes}\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the View Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "getRecordHistory", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "recordId", "in" : "path", "description" : "Record ID", "required" : false, "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887" }, { "name" : "latestFirst", "in" : "query", "description" : "Set to true to request versions in descending order, false (default) for ascending order", "required" : false, "example" : "false" }, { "name" : "limit", "in" : "query", "description" : "Maximum number of versions to return per page. Boomi Data Hub enforces a maximum of 200 versions per page regardless of the limit value.", "required" : false, "example" : "50" }, { "name" : "offsetToken", "in" : "query", "description" : "Corresponds to the offsetToken value returned from a previous Get Golden Record History request", "required" : false, "example" : "MjAw" }, { "name" : "includeReferenceTitle", "in" : "query", "description" : "Record title for the reference record. Boolean. True adds the recordTitle attribute for the reference record in the reference field. The recordTitle attribute shows for the reference fields when the reference value is resolved and the reference universe has the title format defined.", "required" : false, "example" : "false" } ], "responses" : { "200" : { "description" : "The body contains the XML representation of the golden record history, version by version. The golden record ID is the **grid** attribute value of the root element ``. This element also has a **totalCount** attribute that specifies the total number of versions and a **resultCount** attribute which specifies the number of versions returned on this \"page\" of results. The **offsetToken** attribute is returned only if there are additional versions to retrieve. You can use the returned token in a subsequent Get Golden Record History request to get the next \"page\" of versions.\n\nFor each version, the root element is the universe name. The element's attributes are version metadata:\n\n**grid** — golden record ID.\n\n**version** — unique version ID.\n\n**source** — ID of the source that contributed this version.\n\n**startdate** — creation date and time of this version.\n\n**enddate** — date and time of the end-dating of this version. Omit this attribute for current versions of active golden records.\n\n**enddatesource** — source that requested end-dating of the golden record or superseded this version with an update. Omit this attribute for current versions of active golden records.\n\n**transactionId** — transaction ID for the contribution of this version.\n\nThe child elements correspond to the data fields in the historical golden record version.\n\n**recordTitle** — record title format (included if configured). If query parameter `includeReferenceTitle` is set to true and record contains a reference with a title format, record title for the reference is included.", "content" : { "application/xml" : { "schema" : { "title" : "RecordHistoryResponse", "type" : "object", "properties" : { "grid" : { "type" : "string", "description" : "Golden record ID (UUID)", "example" : "recordid", "xml" : { "attribute" : true } }, "totalCount" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "attribute" : true } }, "resultCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "attribute" : true } }, "offsetToken" : { "type" : "string", "description" : "Returned only if there are additional versions to retrieve. Use this token in a subsequent Get Golden Record History request to get the next page of versions.", "example" : "MjAw", "xml" : { "attribute" : true } }, "versions" : { "type" : "array", "xml" : { "wrapped" : false }, "items" : { "type" : "object", "properties" : { "grid" : { "type" : "string", "description" : "Golden record ID (UUID)", "example" : "d5742c16-5318-4ba7-8815-3267a7a55358", "xml" : { "attribute" : true } }, "version" : { "type" : "string", "description" : "Unique version ID", "example" : "801", "xml" : { "attribute" : true } }, "source" : { "type" : "string", "description" : "ID of the source that contributed this version", "example" : "SF", "xml" : { "attribute" : true } }, "startdate" : { "type" : "string", "description" : "Creation date and time of this version", "example" : "02-07-2015T08:36:37.000-0400", "xml" : { "attribute" : true } }, "enddate" : { "type" : "string", "description" : "Date and time of the end-dating of this version. Omitted for current versions of active records.", "example" : "02-08-2015T14:17:06.000-0400", "xml" : { "attribute" : true } }, "enddatesource" : { "type" : "string", "description" : "Source that requested end-dating or superseded this version. Omitted for current versions of active records.", "example" : "SF", "xml" : { "attribute" : true } }, "transactionId" : { "type" : "string", "description" : "Transaction ID for the contribution of this version", "example" : "12345678-9abc-def0-1234-56789abcdef0", "xml" : { "attribute" : true } }, "id" : { "type" : "string", "description" : "Record ID field (example - actual field names vary by universe)", "example" : "d5742c16-5318-4ba7-8815-3267a7a55358", "xml" : { "name" : "id" } }, "name" : { "type" : "string", "description" : "Name field (example - actual field names vary by universe)", "example" : "bob", "xml" : { "name" : "name" } }, "city" : { "type" : "string", "description" : "City field (example - actual field names vary by universe)", "example" : "malvern", "xml" : { "name" : "city" } }, "email" : { "type" : "string", "description" : "Email field (example - actual field names vary by universe)", "example" : "bob@gmail.com", "xml" : { "name" : "email" } } }, "description" : "A historical version of the golden record. The element name varies by universe (determined by the Layout model name at runtime). Examples: , , , . Child elements correspond to the fields in the universe's model. Each element contains the field value.", "xml" : { "name" : "contact" } } } }, "xml" : { "name" : "RecordHistoryResponse" } }, "example" : "\n \n d5742c16-5318-4ba7-8815-3267a7a55358\n bob\n malvern\n bob@gmail.com\n \n \n d5742c16-5318-4ba7-8815-3267a7a55358\n bob\n berwyn\n bob@gmail.com\n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_VIEW)" : [ ] } ] } }, "/universes/{universeId}/records/{recordId}/sources/{sourceId}/unlink" : { "delete" : { "tags" : [ "Records" ], "summary" : "Unlink Golden Record From Source", "description" : "The Unlink Golden Record From Source operation unlinks a golden record from a specific source or source entity in a universe (domain) under the authenticated account. Suppose you do not specify a source entity with the optional entityId query parameter in the request. In that case, the request applies to all source entities linked to the specific golden record.\n\n**Additional Information:**\nIf you remove a source entity for a source that accepts channel updates, a Pending link indicates that the source could receive a channel update for the golden record but currently, it is not linked. A Pending status does not indicate there is an action waiting to be performed.\n\nYou cannot unlink the source entity if it is the only contributing source linked to a golden record. Before removing the source entity, configure another source to contribute data.\n\n**Note:** It is not possible to remove links to non-contributing sources, pending links, or a golden record's sole established link.\n\n*Note:* You can implement requests for this operation in processes using the [HTTP Client connector](https://help.boomi.com/docs/Atomsphere/Integration/Connectors/r-atm-HTTP_Client_connector_d64af80e-febe-4cd2-89ad-e3d0fc53c502), as demonstrated by the sample process [Hub: Unlink Golden Record From Source](https://platform.boomi.com/AtomSphere.html#build;processLibrary=7a24b7d3-a197-410c-aa98-1a2519896ffa), which you can install in your account from the process library in Integration.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Source Management and MDM - Stewardship\n OR\n - MDM - Source Management and MDM - Stewardship Management", "operationId" : "unlinkSourceFromRecord", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "recordId", "in" : "path", "description" : "Record ID", "required" : false, "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" }, { "name" : "entityId", "in" : "query", "description" : "ID of the source entity for which you request unlinking. Case-sensitive. If omitted, applies to all source entities linked to the golden record. Must be URL encoded if it contains special characters.", "required" : false, "example" : "CUST_12345" } ], "responses" : { "200" : { "description" : "Suppose you configure the specified source to prevent delivery of update requests, creating operations on the source's channel for all golden records or a specific golden record given its tags. In that case, it removes each implicitly or explicitly specified link. Otherwise, it changes each implicitly or explicitly set link's state to Pending. The response body is empty." }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/sources/{sourceId}/entities/{originalEntityId}/swap/{newEntityId}" : { "post" : { "tags" : [ "Records" ], "summary" : "Swap Entity ID", "description" : "The Swap Entity ID operation replaces a golden record's current source entity ID for a given source with a new entity ID.\n\n**Additional Information:**\n**Important:** Both originalEntityId and newEntityId must be URL encoded if they contain special characters. This operation updates the entity identifier while maintaining the link to the same golden record.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Stewardship Management\n OR\n - MDM - Stewardship", "operationId" : "swapEntityId", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" }, { "name" : "originalEntityId", "in" : "path", "description" : "ID of the source entity associated with the golden record. Must be URL encoded if it contains special characters.", "required" : false, "example" : "CUST_12345" }, { "name" : "newEntityId", "in" : "path", "description" : "ID of the source entity to replace the original entity ID. Must be URL encoded if it contains special characters.", "required" : false, "example" : "CUST_67890" } ], "responses" : { "200" : { "description" : "Source is linked to the golden record with the new entity ID.", "content" : { "application/xml" : { "schema" : { "type" : "string", "example" : "string", "xml" : { "name" : "response" } }, "example" : "string" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/records/{recordId}/resetAgreements" : { "post" : { "tags" : [ "Records" ], "summary" : "Post Reset Agreements", "description" : "The Post Reset Agreements operation deletes field-level source agreements for individual records. This operation is used to unblock updates when records are stuck due to prior ranking exceptions, removed sources, or stale agreement data.\n\nBy default, the operation resets all agreements for a record. You can optionally limit the scope of the reset to a specific source, a specific field, or a specific field and source combination.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Edit Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - Stewardship Management", "operationId" : "resetAgreements", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "recordId", "in" : "path", "description" : "Record ID", "required" : false, "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887" }, { "name" : "sourceId", "in" : "query", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" }, { "name" : "fieldUniqueId", "in" : "query", "description" : "uniqueId of the field.", "required" : false, "example" : "FIRST_NAME" } ], "responses" : { "200" : { "description" : "Agreements reset." }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_EDIT)" : [ ] } ] } }, "/universes/{universeId}/records/sources/{sourceId}/entities/{entityId}" : { "get" : { "tags" : [ "Records" ], "summary" : "Get Golden Record for Source Entity", "description" : "The Get Golden Record for Source Entity operation retrieves the entity corresponding to the golden record linked to a source entity in a universe (domain) under the authenticated account.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the View Records [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "fetchRecordForSourceEntity", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" }, { "name" : "entityId", "in" : "path", "description" : "ID of the source entity. Must be URL encoded if it contains special characters.", "required" : false, "example" : "CUST_12345" } ], "responses" : { "200" : { "description" : "In the returned entity, the root element name is the universe name. The child elements correspond to the fields in the represented golden record; each element contains the corresponding field value.\n\nIf the returned entity represents an active golden record, the root element's attributes are as follows:\n\n- `createddate` — timestamp of the creation of the golden record.\n\n- `grid` — ID of the golden record.\n\n- `updateddate` — timestamp of the most recent update of the golden record.\n\n- `source` — ID of the source whose entity contribution resulted in the golden record's creation.\n\nIf the returned entity represents an end-dated golden record, the root element's additional attributes are as follows:\n\n- `enddate` (in lieu of createddate and updateddate) — time stamp of the end-dating of the golden record.\n\n- `enddatesource` — source that requested end-dating of the golden record. A value of *MDM* indicates the end-dating request was a user action within Boomi Data Hub.\n\n- `startdate` — time stamp of the creation of the end-dated version of the golden record.\n\n- `version` — unique ID of the end-dated version.\n\n- `transactionId` — transaction ID for the contribution of the end-dated version.", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "createddate" : { "type" : "string", "description" : "Creation timestamp of the record", "example" : "2023-01-01T00:00:00Z", "xml" : { "attribute" : true } }, "grid" : { "type" : "string", "description" : "Golden record ID (UUID)", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "attribute" : true } }, "updateddate" : { "type" : "string", "description" : "Last update timestamp of the record", "example" : "2023-01-01T00:00:00Z", "xml" : { "attribute" : true } }, "source" : { "type" : "string", "description" : "Source system identifier", "example" : "CRM_SYSTEM", "xml" : { "attribute" : true } } }, "additionalProperties" : { "type" : "object", "description" : "Record field data - varies based on universe schema", "example" : "Field values as XML elements" }, "example" : "\n\n 3fccb7ed-7b36-4a2b-bf96-7d6ed220e2f8\n John Doe\n john.doe@example.com\n", "xml" : { "name" : "record" } }, "example" : "\n\n 3fccb7ed-7b36-4a2b-bf96-7d6ed220e2f8\n John Doe\n john.doe@example.com\n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (RECORD_VIEW)" : [ ] } ] } }, "/universes/{universeId}/staging" : { "post" : { "tags" : [ "Staging" ], "summary" : "Query Staged Entities", "description" : "The Query Staged Entities operation returns staged entities from a designated staging area. This request is associated with a particular source in a given universe (deployed model) for the authenticated user.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the View Staged Data [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "queryStagedEntities", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" } ], "requestBody" : { "description" : "Request body containing the staging query request. The root element is `` with the following optional attributes:\n\n- **includeSummary** (optional) - Adds the `` section to the response, detailing the number of records for each entity `` result in the response.\n\n- **includeRecords** (optional) - Includes or removes the records returned in the response. Value is boolean.\n\n- **offsetToken** (optional) - Sets the starting point to retrieve records which allows you to skip a specific number records. For example, in a set of 20 records, 10 skips the first 10 records and queries the remaining 10.\n\n- **limit** (optional) - Sets the maximum number of query results to return. 200 is the maximum value and the default.\n\nThe following elements specify the source and staging area to query:\n\n- **sourceId** - source ID (required).\n\n- **stagingAreaId** - staging area ID (required). The ID can be obtained from the Query Staged Entities endpoint.\n\n**Filters (wrapped in `` tag):**\n\nYou must have at least one filter in the request. Optionally, you can specify the filter operation with the `op=\"\"` attribute to be AND or OR. By default the operator is AND when no operator is specified:\n\n- **state** (optional) - sets a filter by staging result status. This element can repeat - one token per occurrence. Valid tokens include:\n- COMPLETED.* - entities that, if contributed when staged, would not be quarantined.\n- COMPLETED.CREATED - entities that, if contributed when staged, result in the creation of a golden record.\n- COMPLETED.UPDATED - entities that, if contributed when staged, result in updating a golden record.\n- COMPLETED.DELETED - entities that, if contributed when staged, result in the end-dating of a golden record.\n- COMPLETED.LINKED - entities that, if contributed when staged, result in the linking of a golden record to the source entity.\n- COMPLETED.LINKED_WITH_UPDATE - entities that, if contributed when staged, result in the linking of a golden record to the source entity and the updating of that golden record.\n- COMPLETED.NOOP - entities that, if contributed when staged, would not create, update, end-date, or link a golden record.\n- QUARANTINED.* - entities that, if contributed when staged, would quarantine.\n- QUARANTINED.AMBIGUOUS_MATCH - entities that quarantine due to their matching 10 or more golden records.\n- QUARANTINED.DUPLICATE_KEY - entities that quarantine because they contain multiple collection items with the same key values.\n- QUARANTINED.ENRICH_ERROR - entities that quarantine due to a data quality step failure.\n- QUARANTINED.FIELD_FORMAT_ERROR - entities that quarantine because they contain data not in conformance with field type or validation options.\n- QUARANTINED.INCORPORATE_ERROR - entities causing errors other than unresolvable references during the staging of incorporation.\n- QUARANTINED.MATCH_REFERENCE_UNKNOWN - entities that quarantine due to their having a value in a reference field specified for matching that does not resolve to a golden record.\n- QUARANTINED.MULTIPLE_MATCHES - entities that quarantine due to their matching multiple golden records not yet linked to a record in the source.\n- QUARANTINED.PARSE_FAILURE - entities that quarantine due to their failure to structurally conform with the field layout specified in the domain model.\n- QUARANTINED.POSSIBLE_DUPLICATE - entities that quarantine due to their matching golden records linked to a record in the source.\n- QUARANTINED.RECORD_ALREADY_ENDDATED - entities that quarantine due to the existence of a link from an end-dated golden record.\n- QUARANTINED.REFERENCE_UNKNOWN - entities that quarantine due to their having unresolvable references.\n- QUARANTINED.REQUIRED_FIELD - entities that quarantine due to their omission of fields specified as required or as key fields for collections.\n- QUARANTINED.REQUIRES_APPROVAL - entities that quarantine due to their satisfying conditions configured for their source requiring manual approval.\n- QUARANTINED.REQUIRES_END_DATE_APPROVAL - entities that quarantine due to their configured sources requiring manual approval of contributed entities that would end-date matching golden records.\n- QUARANTINED.REQUIRES_UPDATE_APPROVAL - entities that quarantine due to their satisfying conditions configured for their source requiring the manual approval of contributed entities that update matching golden records.\n- QUARANTINED.REQUIRES_UPDATE_WITH_BASE_VALUE_APPROVAL - entities that quarantine because there is a pending link from the matching golden record to the contributing source and the entity has a field with a base value.\n\n- **createDateRelative** (optional) - Use one of the following date filters. If value is present, createdDate is ignored. Values: PAST_HOUR, PAST_24_HOURS, PAST_WEEK.\n\n- **createdDate** (optional) - The date the entity was created in the staging area. This tag wraps the `to` and `from` tags:\n- **from**: The start date for filtering entities by created date. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n- **to**: The end date for filtering entities by created date. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n\n- **sourceEntityIds** (optional) - Sets a filter by source entities. This tag wraps specific source entity Ids.\n- **sourceEntityId** (optional) - The specific source entity ID. The ID can be obtained from the Query Staged Entities endpoint or from the Staged Entities list in the UI.\n\n- **stagedEntryIds** (optional) - Sets a filter for staged entry Ids. This tag wraps the stagedEntryId tags.\n- **stagedEntryId** (optional) - The specific staged Entry ID. The ID can be obtained from the Query Staged Entities endpoint.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/StagingQueryRequest" }, "example" : "\n SFDC\n sa\n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n PAST_HOUR\n \n sg-4\n sg-1\n \n QUARANTINED.FIELD_FORMAT_ERROR\n \n" } }, "required" : true }, "responses" : { "200" : { "description" : "The body contains the XML representation of the query results. It returns a maximum of 200 results per request unless the limit query parameter for a given request specifies a lower maximum number of results.\n\nEach `` element represents a staged entity. The element has the following attributes:\n\n- **Id** - staged entity Id.\n\n- **sourceEntityId** - source entity Id.\n\n- **createdDate** - date the staged entity was created.\n\n- **state** - staging result status which indicates if the entity would be quarantined after being submitted as an entity in the repository.\n\n- **title** - record title for the record associated with the entity.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/StagingQueryResponse" }, "example" : "\n \n \n \n Williams\n Fiction\n CA\n \n \n \n \n \n \n Williams 2\n Fiction 2\n WA\n \n \n \n \n \n \n Williams\n Fiction\n CA\n \n \n \n \n \n \n Williams 2\n Fiction 2\n WA\n \n \n \n \n \n \n Williams\n Fiction\n CA\n \n \n \n \n \n \n \n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (STAGING_VIEW)" : [ ] } ] } }, "/universes/{universeId}/staging/resubmit" : { "post" : { "tags" : [ "Staging" ], "summary" : "Resubmit Staged Entities", "description" : "The Resubmit Staged Entities operation allows the authenticated user to resubmit specific entities to a designated staging area. This request is associated with a particular source in a given universe (deployed model).\n\nResubmitting entities lets you resend an entity to the staging area after you've made changes to the model so you can see how the entity would be incorporated. For example, you can change the model's match rules, re-deploy the model, and resubmit the entity to staging to see the effect.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Resubmit Staged Data [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "resubmitStagedEntities", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" } ], "requestBody" : { "description" : "Request body containing the staging action request. The root element is `` with the following required elements:\n\n- **sourceId** - source ID (required).\n\n- **stagingAreaId** - staging area ID (required). The ID can be obtained from the Query Staged Entities endpoint.\n\n**Filters (wrapped in `` tag):**\n\nYou must have at least one filter in the request. Optionally, you can specify the filter operation with the `op=\"\"` attribute to be AND or OR. By default the operator is AND when no operator is specified:\n\n- **state** (optional) - sets a filter by staging result status. This element can repeat - one token per occurrence. Valid tokens include:\n- COMPLETED.* - entities that, if contributed when staged, would not be quarantined.\n- COMPLETED.CREATED - entities that, if contributed when staged, result in the creation of a golden record.\n- COMPLETED.UPDATED - entities that, if contributed when staged, result in updating a golden record.\n- COMPLETED.DELETED - entities that, if contributed when staged, result in the end-dating of a golden record.\n- COMPLETED.LINKED - entities that, if contributed when staged, result in the linking of a golden record to the source entity.\n- COMPLETED.LINKED_WITH_UPDATE - entities that, if contributed when staged, result in the linking of a golden record to the source entity and the updating of that golden record.\n- COMPLETED.NOOP - entities that, if contributed when staged, would not create, update, end-date, or link a golden record.\n- QUARANTINED.* - entities that, if contributed when staged, would quarantine.\n- QUARANTINED.AMBIGUOUS_MATCH - entities that quarantine due to their matching 10 or more golden records.\n- QUARANTINED.DUPLICATE_KEY - entities that quarantine because they contain multiple collection items with the same key values.\n- QUARANTINED.ENRICH_ERROR - entities that quarantine due to a data quality step failure.\n- QUARANTINED.FIELD_FORMAT_ERROR - entities that quarantine because they contain data not in conformance with field type or validation options.\n- QUARANTINED.INCORPORATE_ERROR - entities causing errors other than unresolvable references during the staging of incorporation.\n- QUARANTINED.MATCH_REFERENCE_UNKNOWN - entities that quarantine due to their having a value in a reference field specified for matching that does not resolve to a golden record.\n- QUARANTINED.MULTIPLE_MATCHES - entities that quarantine due to their matching multiple golden records not yet linked to a record in the source.\n- QUARANTINED.PARSE_FAILURE - entities that quarantine due to their failure to structurally conform with the field layout specified in the domain model.\n- QUARANTINED.POSSIBLE_DUPLICATE - entities that quarantine due to their matching golden records linked to a record in the source.\n- QUARANTINED.RECORD_ALREADY_ENDDATED - entities that quarantine due to the existence of a link from an end-dated golden record.\n- QUARANTINED.REFERENCE_UNKNOWN - entities that quarantine due to their having unresolvable references.\n- QUARANTINED.REQUIRED_FIELD - entities that quarantine due to their omission of fields specified as required or as key fields for collections.\n- QUARANTINED.REQUIRES_APPROVAL - entities that quarantine due to their satisfying conditions configured for their source requiring manual approval.\n- QUARANTINED.REQUIRES_END_DATE_APPROVAL - entities that quarantine due to their configured sources requiring manual approval of contributed entities that would end-date matching golden records.\n- QUARANTINED.REQUIRES_UPDATE_APPROVAL - entities that quarantine due to their satisfying conditions configured for their source requiring the manual approval of contributed entities that update matching golden records.\n- QUARANTINED.REQUIRES_UPDATE_WITH_BASE_VALUE_APPROVAL - entities that quarantine because there is a pending link from the matching golden record to the contributing source and the entity has a field with a base value.\n\n- **createDateRelative** (optional) - Use one of the following date filters. If value is present, createdDate is ignored. Values: PAST_HOUR, PAST_24_HOURS, PAST_WEEK.\n\n- **createdDate** (optional) - The date the entity was created in the staging area. This tag wraps the `to` and `from` tags:\n- **from**: The start date for filtering entities by created date. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n- **to**: The end date for filtering entities by created date. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n\n- **sourceEntityIds** (optional) - Sets a filter by source entities. This tag wraps specific source entity Ids.\n- **sourceEntityId** (optional) - The specific source entity ID. The ID can be obtained from the [Query Staged Entities](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Query_Staged_Entities) endpoint or from the Staged Entities list in the UI.\n\n- **stagedEntryIds** (optional) - Sets a filter for staged entry Ids. This tag wraps the stagedEntryId tags.\n- **stagedEntryId** (optional) - The specific staged Entry ID. The ID can be obtained from the [Query Staged Entities](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Query_Staged_Entities) endpoint.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/StagingActionRequest" }, "example" : "\n SFDC\n 12345\n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n PAST_HOUR\n \n sg-4\n sg-1\n \n \n 82\n 83\n 85\n \n QUARANTINED.FIELD_FORMAT_ERROR\n \n" } }, "required" : true }, "responses" : { "200" : { "description" : "The body contains the XML representation of the action response indicating the number of entities that were resubmitted.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/MdmActionResponse" }, "example" : "" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (STAGING_REPLAY)" : [ ] } ] } }, "/universes/{universeId}/staging/commit" : { "post" : { "tags" : [ "Staging" ], "summary" : "Commit Staged Entities", "description" : "The Commit Staged Entities operation allows the authenticated user to submit a request for specific entities from a designated staging area to update or create golden records in the repository. This request is associated with a particular source in a given universe (deployed model).\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Commit Staged Data [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "commitStagedEntities", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" } ], "requestBody" : { "description" : "Request body containing the staging action request. The root element is `` with the following required elements:\n\n- **sourceId** - source ID (required).\n\n- **stagingAreaId** - staging area ID (required). The ID can be obtained from the [Query Staged Entities](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Query_Staged_Entities) endpoint.\n\n**Filters (wrapped in `` tag):**\n\nYou must have at least one filter in the request. Optionally, you can specify the filter operation with the `op=\"\"` attribute to be AND or OR. By default the operator is AND when no operator is specified:\n\n- **state** (optional) - sets a filter by staging result status. This element can repeat - one token per occurrence. Valid tokens include:\n- COMPLETED.* - entities that, if contributed when staged, would not be quarantined.\n- COMPLETED.CREATED - entities that, if contributed when staged, result in the creation of a golden record.\n- COMPLETED.UPDATED - entities that, if contributed when staged, result in updating a golden record.\n- COMPLETED.DELETED - entities that, if contributed when staged, result in the end-dating of a golden record.\n- COMPLETED.LINKED - entities that, if contributed when staged, result in the linking of a golden record to the source entity.\n- COMPLETED.LINKED_WITH_UPDATE - entities that, if contributed when staged, result in the linking of a golden record to the source entity and the updating of that golden record.\n- COMPLETED.NOOP - entities that, if contributed when staged, would not create, update, end-date, or link a golden record.\n- QUARANTINED.* - entities that, if contributed when staged, would quarantine.\n- QUARANTINED.AMBIGUOUS_MATCH - entities that quarantine due to their matching 10 or more golden records.\n- QUARANTINED.DUPLICATE_KEY - entities that quarantine because they contain multiple collection items with the same key values.\n- QUARANTINED.ENRICH_ERROR - entities that quarantine due to a data quality step failure.\n- QUARANTINED.FIELD_FORMAT_ERROR - entities that quarantine because they contain data not in conformance with field type or validation options.\n- QUARANTINED.INCORPORATE_ERROR - entities causing errors other than unresolvable references during the staging of incorporation.\n- QUARANTINED.MATCH_REFERENCE_UNKNOWN - entities that quarantine due to their having a value in a reference field specified for matching that does not resolve to a golden record.\n- QUARANTINED.MULTIPLE_MATCHES - entities that quarantine due to their matching multiple golden records not yet linked to a record in the source.\n- QUARANTINED.PARSE_FAILURE - entities that quarantine due to their failure to structurally conform with the field layout specified in the domain model.\n- QUARANTINED.POSSIBLE_DUPLICATE - entities that quarantine due to their matching golden records linked to a record in the source.\n- QUARANTINED.RECORD_ALREADY_ENDDATED - entities that quarantine due to the existence of a link from an end-dated golden record.\n- QUARANTINED.REFERENCE_UNKNOWN - entities that quarantine due to their having unresolvable references.\n- QUARANTINED.REQUIRED_FIELD - entities that quarantine due to their omission of fields specified as required or as key fields for collections.\n- QUARANTINED.REQUIRES_APPROVAL - entities that quarantine due to their satisfying conditions configured for their source requiring manual approval.\n- QUARANTINED.REQUIRES_END_DATE_APPROVAL - entities that quarantine due to their configured sources requiring manual approval of contributed entities that would end-date matching golden records.\n- QUARANTINED.REQUIRES_UPDATE_APPROVAL - entities that quarantine due to their satisfying conditions configured for their source requiring the manual approval of contributed entities that update matching golden records.\n- QUARANTINED.REQUIRES_UPDATE_WITH_BASE_VALUE_APPROVAL - entities that quarantine because there is a pending link from the matching golden record to the contributing source and the entity has a field with a base value.\n\n- **createDateRelative** (optional) - Use one of the following date filters. If value is present, createdDate is ignored. Values: PAST_HOUR, PAST_24_HOURS, PAST_WEEK.\n\n- **createdDate** (optional) - The date the entity was created in the staging area. This tag wraps the `to` and `from` tags:\n- **from**: The start date for filtering entities by created date. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n- **to**: The end date for filtering entities by created date. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n\n- **sourceEntityIds** (optional) - Sets a filter by source entities. This tag wraps specific source entity Ids.\n- **sourceEntityId** (optional) - The specific source entity ID. The ID can be obtained from the [Query Staged Entities](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Query_Staged_Entities) endpoint or from the Staged Entities list in the UI.\n\n- **stagedEntryIds** (optional) - Sets a filter for staged entry Ids. This tag wraps the stagedEntryId tags.\n- **stagedEntryId** (optional) - The specific staged Entry ID. The ID can be obtained from the [Query Staged Entities](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Query_Staged_Entities) endpoint.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/StagingActionRequest" }, "example" : "\n SFDC\n 12345\n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n PAST_HOUR\n \n sg-4\n sg-1\n \n \n 82\n 83\n 85\n \n QUARANTINED.FIELD_FORMAT_ERROR\n \n" } }, "required" : true }, "responses" : { "200" : { "description" : "The body of the response is XML. The root element is ``. Within that element resultCount contains the count of committed entities, some of which may be quarantined.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/MdmActionResponse" }, "example" : "" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (STAGING_COMMIT)" : [ ] } ] } }, "/universes/{universeId}/staging/delete" : { "post" : { "tags" : [ "Staging" ], "summary" : "Delete Staged Entities", "description" : "The Delete Staged Entities operation allows the authenticated user to delete specific entities in a designated staging area. This request is associated with a particular source in a given universe (deployed model).\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the Delete Staged Data [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "deleteStagedEntities", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" } ], "requestBody" : { "description" : "Request body containing the staging action request. The root element is `` with the following required elements:\n\n- **sourceId** - source ID (required).\n\n- **stagingAreaId** - staging area ID (required). The ID can be obtained from the [Query Staged Entities](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Query_Staged_Entities) endpoint.\n\n**Filters (wrapped in `` tag):**\n\nYou must have at least one filter in the request. Optionally, you can specify the filter operation with the `op=\"\"` attribute to be AND or OR. By default the operator is AND when no operator is specified:\n\n- **state** (optional) - sets a filter by staging result status. This element can repeat - one token per occurrence. Valid tokens include:\n- COMPLETED.* - entities that, if contributed when staged, would not be quarantined.\n- COMPLETED.CREATED - entities that, if contributed when staged, result in the creation of a golden record.\n- COMPLETED.UPDATED - entities that, if contributed when staged, result in updating a golden record.\n- COMPLETED.DELETED - entities that, if contributed when staged, result in the end-dating of a golden record.\n- COMPLETED.LINKED - entities that, if contributed when staged, result in the linking of a golden record to the source entity.\n- COMPLETED.LINKED_WITH_UPDATE - entities that, if contributed when staged, result in the linking of a golden record to the source entity and the updating of that golden record.\n- COMPLETED.NOOP - entities that, if contributed when staged, would not create, update, end-date, or link a golden record.\n- QUARANTINED.* - entities that, if contributed when staged, would quarantine.\n- QUARANTINED.AMBIGUOUS_MATCH - entities that quarantine due to their matching 10 or more golden records.\n- QUARANTINED.DUPLICATE_KEY - entities that quarantine because they contain multiple collection items with the same key values.\n- QUARANTINED.ENRICH_ERROR - entities that quarantine due to a data quality step failure.\n- QUARANTINED.FIELD_FORMAT_ERROR - entities that quarantine because they contain data not in conformance with field type or validation options.\n- QUARANTINED.INCORPORATE_ERROR - entities causing errors other than unresolvable references during the staging of incorporation.\n- QUARANTINED.MATCH_REFERENCE_UNKNOWN - entities that quarantine due to their having a value in a reference field specified for matching that does not resolve to a golden record.\n- QUARANTINED.MULTIPLE_MATCHES - entities that quarantine due to their matching multiple golden records not yet linked to a record in the source.\n- QUARANTINED.PARSE_FAILURE - entities that quarantine due to their failure to structurally conform with the field layout specified in the domain model.\n- QUARANTINED.POSSIBLE_DUPLICATE - entities that quarantine due to their matching golden records linked to a record in the source.\n- QUARANTINED.RECORD_ALREADY_ENDDATED - entities that quarantine due to the existence of a link from an end-dated golden record.\n- QUARANTINED.REFERENCE_UNKNOWN - entities that quarantine due to their having unresolvable references.\n- QUARANTINED.REQUIRED_FIELD - entities that quarantine due to their omission of fields specified as required or as key fields for collections.\n- QUARANTINED.REQUIRES_APPROVAL - entities that quarantine due to their satisfying conditions configured for their source requiring manual approval.\n- QUARANTINED.REQUIRES_END_DATE_APPROVAL - entities that quarantine due to their configured sources requiring manual approval of contributed entities that would end-date matching golden records.\n- QUARANTINED.REQUIRES_UPDATE_APPROVAL - entities that quarantine due to their satisfying conditions configured for their source requiring the manual approval of contributed entities that update matching golden records.\n- QUARANTINED.REQUIRES_UPDATE_WITH_BASE_VALUE_APPROVAL - entities that quarantine because there is a pending link from the matching golden record to the contributing source and the entity has a field with a base value.\n\n- **createDateRelative** (optional) - Use one of the following date filters. If value is present, createdDate is ignored. Values: PAST_HOUR, PAST_24_HOURS, PAST_WEEK.\n\n- **createdDate** (optional) - The date the entity was created in the staging area. This tag wraps the `to` and `from` tags:\n- **from**: The start date for filtering entities by created date. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n- **to**: The end date for filtering entities by created date. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n\n- **sourceEntityIds** (optional) - Sets a filter by source entities. This tag wraps specific source entity Ids.\n- **sourceEntityId** (optional) - The specific source entity ID. The ID can be obtained from the [Query Staged Entities](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Query_Staged_Entities) endpoint or from the Staged Entities list in the UI.\n\n- **stagedEntryIds** (optional) - Sets a filter for staged entry Ids. This tag wraps the stagedEntryId tags.\n- **stagedEntryId** (optional) - The specific staged Entry ID. The ID can be obtained from the [Query Staged Entities](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Query_Staged_Entities) endpoint.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/StagingActionRequest" }, "example" : "\n SFDC\n 12345\n \n \n 2023-01-01T00:00:00Z\n 2023-12-31T23:59:59Z\n \n PAST_HOUR\n \n sg-4\n sg-1\n \n \n 82\n 83\n 85\n \n QUARANTINED.FIELD_FORMAT_ERROR\n \n" } }, "required" : true }, "responses" : { "200" : { "description" : "The body of the response is XML. The root element is ``. Within that element the attribute resultCount contains the count of deleted staged entities.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/MdmActionResponse" }, "example" : "" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (STAGING_DELETE)" : [ ] } ] } }, "/universes/{universeId}/sources/{sourceId}/staging/{stagingAreaId}/{stagedEntityId}" : { "get" : { "tags" : [ "Staging" ], "summary" : "Get Staged Entity", "description" : "The Get Staged Entity operation allows the authenticated user to retrieve a single staged entity from a designated staging area in a repository. This request is associated with a particular source in a given universe (deployed model).\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **With the Advanced Security feature on your account:**\n - MDM - Stewardship with the View Staged Data [Hub role entitlement](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/Getting%20started/t-hub-Creating_Hub_Role_Entitlements_06d21275-b0c6-4854-abef-5782326aa85b) for the queried repository\n OR\n - MDM - Stewardship Management\n\n **Without Advanced Security:**\n - MDM - Stewardship\n OR\n - MDM - View Data\n OR\n - MDM - Stewardship Management", "operationId" : "getStagedEntity", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" }, { "name" : "sourceId", "in" : "path", "description" : "Source ID. The source ID is listed on the Sources page in the user interface.", "required" : false, "example" : "CRM_SYSTEM" }, { "name" : "stagingAreaId", "in" : "path", "description" : "Staging area ID. Obtain the ID from the deployed model's Source's tab or the [Query Staged Entities](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Query_Staged_Entities) endpoint. Case sensitive.", "required" : false }, { "name" : "stagedEntityId", "in" : "path", "description" : "The staged entity ID which is assigned when the source contributes the entity. This is a different ID than the source entity ID. Obtain the ID from the [Query Staged Entities](https://help.boomi.com/docs/Atomsphere/Master%20Data%20Hub/REST%20APIs/hub-Query_Staged_Entities) endpoint.", "required" : false } ], "responses" : { "200" : { "description" : "The body of the response is XML. The root element is ``. The element has the following attributes:\n\n- **Id** - staged entity Id\n\n- **sourceEntityId** - source entity Id\n\n- **createdDate** - date the staged entity was created\n\n- **state** - staging result status. It indicates if the entity would be quarantined after being committed to the repository\n\nThe entity has the following elements:\n\n- **message** - details the quarantine reason if entity would result in a quarantine. If entity would not be quarantined, no message displays.\n\n- **entity** - details the fields and values for the contributed source entity.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/StagedEntity" }, "example" : "\n The entity is potentially a duplicate of a golden record(s) already linked to an entity in the source system.\n \n \n William\n Fiction\n CA\n \n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] }, { "mdmEntitlement (STAGING_VIEW)" : [ ] } ] } }, "/universes/{universeId}/transactions" : { "post" : { "tags" : [ "Transactions" ], "summary" : "Query Transactions", "description" : "The Query Transactions operation lets you query all the entity transactions in a deployed model using your filter criteria. The response includes deleted, incorporated, and quarantined entities and entities still processing. The response also includes any entity transactions that resulted in an unexpected error.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - View Data", "operationId" : "queryTransactions", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" } ], "requestBody" : { "description" : "Request body containing the transaction query request. The root element is `` with the following optional attributes:\n\n- **offsetToken** (optional) - Sets the starting point to retrieve records which allows you to skip a specific number of records. For example, in a set of 20 records, 10 skips the first 10 records and queries the remaining 10.\n\n- **limit** (optional) - Sets the maximum number of query results to return. 200 is the maximum value and the default.\n\n- **includeEvents** (optional) - If set to true, it includes individual transaction events in the response. It provides details about the event. For example, if it is a quarantine event, it provides the error message. If it is a record creation event, it provides the golden record ID. The default is false.\n\nYou can use the following filter criteria for your query:\n\n- **sourceEntityId** (optional) - Sets the filter to show transactions associated with the specified source entity. It must be URL encoded if it contains special characters.\n\n- **sourceId** (optional) - Sets the filter to show all transactions contributed by the specified source.\n\n- **startFromDate** (optional) - Sets the filter to show all transactions starting from the specified event start date/time of processing. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string. The specified times are UTC.\n\n- **startToDate** (optional) - Sets the filter to show all transactions occurring before the specified event start date/time of processing. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string. The specified times are UTC.\n\n- **endFromDate** (optional) - Sets the filter to show all transactions starting from the specified event end date/time of processing. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string. The specified times are UTC.\n\n- **endToDate** (optional) - Sets the filter to show all transactions occurring before the specified event end date/time of processing. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string. The specified times are UTC.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/TransactionQueryRequest" }, "example" : "\n SFDC\n S1-1234\n 2023-06-11T07:28:32Z\n 2024-05-11T07:28:32Z\n 2023-06-11T07:28:32Z\n 2024-05-11T07:28:32Z\n" } }, "required" : true }, "responses" : { "200" : { "description" : "The body contains the XML representation of the query results. It returns a maximum of 200 results per request unless the limit query parameter for a given request specifies a lower maximum number of results.\n\nEach `` element represents a contributing source entity transaction. The elements are sorted by the startDate time stamp attribute value, from oldest to newest. `` elements are sorted by the eventDate time stamp attribute value, from oldest to newest. The element has the following attributes:\n\n- **Id** - transaction Id\n\n- **sourceId** - source Id of the contributed entity. Indicates the source associated with the transaction\n\n- **sourceEntityId** - source entity ID of the contributed entity\n\n- **startDate** - time stamp of the start of this transaction\n\n- **endDate** - time stamp of the completion of this transaction\n\n- **state** - transaction status:\n- PROCESSING - The entity is currently processing in Boomi Data Hub.\n- QUARANTINED - The entity is quarantined and awaits manual resolution.\n- COMPLETED - Processing completed, resulting in the creation, updating, or end-dating of a golden record or no operation on a golden record.\n- ERRORED - Processing ended due to an unexpected error.\n- DELETED - After quarantining the entity, its entry was manually deleted, thus ending the transaction.\n\n- **stateDetail** - detailed transaction status.\n\nIf you set the IncludeEvents attribute in the request to true, it includes `` elements within `` for each retrieved transaction. Within each `` element:\n\n- **** is the event description.\n\nThe attributes of the `` element are as follows:\n\n- **eventType** - event type\n\n- **eventDate** - time stamp of the event", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/TransactionQueryResponse" }, "example" : "\n \n \n PARSE_FAILURE\n The given record does not conform to the universe layout's schema definition: cvc-complex-type.2.4.d: Invalid content was found starting with element 'email'. No child element is expected at this point.\n \n \n S1\n \n \n \n \n CREATED\n 322f86fd-6205-48fc-9643-11976ac394c4\n \n \n 9f62433e-c005-403a-8030-ac202fbc9767\n 1234\n \n \n \n \n AS-USER:13528\n \n \n POSSIBLE_DUPLICATE\n The entity is potentially a duplicate of a golden record(s) already linked to an entity in the source system.\n \n \n 9f62433e-c005-403a-8030-ac202fbc9767\n 5678\n \n \n \n \n FIELD_FORMAT_ERROR\n The record's {account number} field value '2578298198728' is not in a valid INTEGER format.\n \n \n 9f62433e-c005-403a-8030-ac202fbc9767\n 34587\n \n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}" : { "get" : { "tags" : [ "Universes" ], "summary" : "Get Deployed Universe", "description" : "The Get Deployed Universe operation retrieves the XML representation of a specified universe (domain and model configuration) under the authenticated account.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - View Repositories\n OR\n - MDM - Stewardship Management", "operationId" : "getUniverse", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" } ], "responses" : { "200" : { "description" : "The response body contains the XML representation of the specified universe. The universe includes its configuration, statistics, sources, layout, match configuration, and data quality settings.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/UniverseDescription" }, "example" : "\n 1d969a54-49e5-4f75-974a-85869280873d\n 836e6d2d-47c7-457b-94f1-54ae07492d2f\n employees\n \n \n \n \n \n \n \n \n \n \n \n \n 1d969a54-49e5-4f75-974a-85869280873d\n \n \n \n \n \n \n \n \n \n \n home\n work\n away\n unknown\n \n \n \n \n \n \n \n \n ]]>\n \n \n \n \n \n TYPE\n \n \n \n \n TYPE_1\n \n \n work\n away\n home\n unknown\n \n \n \n \n 1d969a54-49e5-4f75-974a-85869280873d\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes" : { "get" : { "tags" : [ "Universes" ], "summary" : "Get List of Deployed Universes", "description" : "The Get List of Deployed Universes operation retrieves the XML representation of all deployed universes (domain and model configurations) under the authenticated account.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - View Repositories\n OR\n - MDM - Stewardship Management", "operationId" : "getAllUniverses", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false } ], "responses" : { "200" : { "description" : "The response body contains the XML representation of all deployed universes. Each universe includes its configuration, statistics, sources, layout, match configuration, and data quality settings.", "content" : { "application/xml" : { "schema" : { "type" : "array", "xml" : { "name" : "universes" }, "items" : { "$ref" : "#/components/schemas/UniverseDescription" } }, "example" : "\n \n 1d969a54-49e5-4f75-974a-85869280873d\n 836e6d2d-47c7-457b-94f1-54ae07492d2f\n employees\n \n \n \n \n \n \n \n \n \n \n \n \n 1d969a54-49e5-4f75-974a-85869280873d\n \n \n \n \n \n \n \n \n \n \n home\n work\n away\n unknown\n \n \n \n \n \n \n \n \n ]]>\n \n \n \n \n \n TYPE\n \n \n \n \n TYPE_1\n \n \n work\n away\n home\n unknown\n \n \n \n \n 1d969a54-49e5-4f75-974a-85869280873d\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n 04ea04cc-9df8-4004-bc00-a21b7dede1bb\n bb072194-2279-42b3-84c1-2f1b2a38c71e\n accounts\n \n \n \n \n \n \n \n \n \n \n \n ACCOUNT_NAME\n WEBSITE\n \n \n \n \n \n \n 04ea04cc-9df8-4004-bc00-a21b7dede1bb\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n ]]>\n \n \n \n \n \n \n \n \n \n \n \n 04ea04cc-9df8-4004-bc00-a21b7dede1bb\n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } }, "/universes/{universeId}/bulk/query" : { "post" : { "tags" : [ "Universes" ], "summary" : "Query Bulk Processing Requests", "description" : "The Query Bulk Processing Requests API endpoint lets you programmatically retrieve the status of bulk processing requests for golden records, including end-dating and purging records, as well as sending update requests to target sources. The API endpoint returns request data for a universe (deployed model). The data aligns with information you can access in the user interface on the **Reporting** > **Bulk Processing Requests** screen.\n\n**Additional Information:**\nThe request body contains query parameters and filter criteria. The root element is `` with optional `offsetToken` and `limit` parameters, and an optional `` element containing query filter parameters.\n\n**Query Filter Parameters (wrapped in `` tag):**\n\n- **type** - Filters by request type. String. Optional. Values are: END_DATE, PURGE, SEND_UPDATES.\n\n- **status** - Filters by request status. String. Optional. Values are: ALL, PROCESSING, ERRORED, SUCCESSFUL, SUBMITTED, RETRIED, CANCELED.\n\n- **sourceId** - Filters by a specific target source ID. Applies only to SEND_UPDATES requests. String. Optional.\n\n- **startTime** - Filter by date and time the request was submitted for processing. Datetime. Optional. This tag wraps the `to` and `from` tags:\n - **from**: The start datetime for filtering requests. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n - **to**: The end datetime for filtering requests. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n If `startTimeRelative` filter is specified, it overrides this filter.\n\n- **startTimeRelative** - Filters by a request processing start time frame relative to the current date and time. String. Optional. Values are: PAST_HOUR, PAST_24_HOURS, PAST_WEEK.\n\n- **endTime** - Filter by date and time the request finished processing. Datetime. Optional. This tag wraps the `to` and `from` tags:\n - **from**: The start datetime for filtering requests. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n - **to**: The end datetime for filtering requests. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.\n If `endTimeRelative` filter is specified, it overrides this filter.\n\n- **endTimeRelative** - Filters by a request processing end time frame relative to the current date and time. String. Optional. Values are: PAST_HOUR, PAST_24_HOURS, PAST_WEEK.\n\n**Security Requirements:**\nYou must have one of the following MDM privileges:\n\n **Without Advanced Security:**\n - MDM - Source Management", "operationId" : "bulkQuery", "parameters" : [ { "name" : "repositoryId", "in" : "query", "description" : "Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.", "required" : false }, { "name" : "universeId", "in" : "path", "description" : "Universe ID. Listed in the Repositories UI URL.", "required" : false, "example" : "851a6a64-6a88-4916-a5b7-d6a974d54318" } ], "requestBody" : { "description" : "Request body containing query parameters and filter criteria. The root element is `` with optional `offsetToken` and `limit` parameters, and an optional `` element containing query filter parameters for type, status, sourceId, startTime, startTimeRelative, endTime, and endTimeRelative.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/BulkProcessingQueryRequest" }, "examples" : { "withLimitAndStartTime" : { "summary" : "Query with Limit and Start Time Filter", "description" : "Example showing a query with a limit parameter and filter containing type and startTime. Use this to retrieve the first page of results filtered by request type and submission time range.", "value" : "\n \n SEND_UPDATES\n \n 2025-02-17T15:07:00Z\n 2025-02-17T15:07:59Z\n \n \n" }, "withOffsetTokenAndStatus" : { "summary" : "Query with Offset Token and Status Filter", "description" : "Example showing a query with an offsetToken parameter (for pagination) and filter containing type and status. Use this to retrieve subsequent pages of results or filter by request status.", "value" : "\n \n SEND_UPDATES\n SUCCESSFUL\n \n" } } } }, "required" : true }, "responses" : { "200" : { "description" : "The response body contains the XML representation of the query results. It returns a maximum of 200 results per request unless the limit parameter for a given request specifies a lower maximum number of results. Each result includes request details such as ID, source ID, status, type, record counts, completion percentage, and timing information.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/BulkProcessingQueryResponse" }, "example" : "\n \n 176\n \n \n 13\n 13\n 0\n 100\n 2025-02-17T15:12:00Z\n 2025-02-17T15:12:00Z\n 0\n \n \n 175\n \n \n 15\n 16\n 0\n 100\n 2025-02-17T15:12:00Z\n 2025-02-17T15:12:00Z\n 5\n \n" } } }, "400" : { "description" : "Bad Request: Invalid request parameters or format", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Invalid request parameters or format", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Invalid request parameters or format\n" } } }, "401" : { "description" : "Unauthorized: Authentication credentials are invalid or expired", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Authentication credentials are invalid or expired", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Authentication credentials are invalid or expired\n" } } }, "403" : { "description" : "Forbidden: Access denied due to insufficient permissions", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Access denied due to insufficient permissions", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Access denied due to insufficient permissions\n" } } }, "404" : { "description" : "Not Found: Requested resource could not be found", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Requested resource could not be found", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Requested resource could not be found\n" } } }, "500" : { "description" : "Internal Server Error: An unexpected error occurred", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "An unexpected error occurred", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n An unexpected error occurred\n" } } }, "503" : { "description" : "Service Unavailable: Service is temporarily unavailable", "content" : { "application/xml" : { "schema" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Service is temporarily unavailable", "xml" : { "name" : "message" } } }, "xml" : { "name" : "error" } }, "example" : "\n\n Service is temporarily unavailable\n" } } } }, "security" : [ { "basicAuth" : [ ] }, { "bearerAuth" : [ ] } ] } } }, "components" : { "schemas" : { "RecordEndDateRequest" : { "title" : "RecordEndDateRequest", "type" : "object", "properties" : { "recordId" : { "type" : "array", "xml" : { "name" : "recordId" }, "items" : { "type" : "string", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "name" : "recordId" } } }, "filter" : { "title" : "RecordQueryFilter", "type" : "object", "properties" : { "createdDate" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "createdDate" } }, "updatedDate" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "updatedDate" } }, "fieldValue" : { "type" : "array", "xml" : { "name" : "fieldValue" }, "items" : { "title" : "FieldValueCondition", "type" : "object", "properties" : { "fieldId" : { "type" : "string", "example" : "FIRST_NAME", "xml" : { "name" : "fieldId" } }, "operator" : { "type" : "string", "example" : "EQUALS", "xml" : { "name" : "operator" } }, "value" : { "type" : "array", "xml" : { "name" : "value" }, "items" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value" } } } }, "xml" : { "name" : "fieldValue" } } }, "sourceLink" : { "title" : "SourceLinkCondition", "type" : "object", "properties" : { "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "linkType" : { "type" : "string", "example" : "LINKED", "xml" : { "name" : "linkType" } } }, "xml" : { "name" : "sourceLink" } }, "creatingSourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "creatingSourceId" } }, "tags" : { "title" : "Tags", "type" : "object", "properties" : { "tagName" : { "type" : "array", "xml" : { "name" : "tagName" }, "items" : { "type" : "string", "example" : "VIP_CUSTOMER", "xml" : { "name" : "tagName" } } } }, "xml" : { "name" : "tags" } }, "unresolvedReference" : { "title" : "UnresolvedReferencesCondition", "type" : "object", "properties" : { "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "fieldId" : { "type" : "string", "example" : "FIRST_NAME", "xml" : { "name" : "fieldId" } } }, "xml" : { "name" : "unresolvedReference" } }, "op" : { "type" : "string", "example" : "AND", "xml" : { "name" : "op", "attribute" : true }, "default" : "AND", "enum" : [ "AND", "OR" ] } }, "xml" : { "name" : "filter" } } }, "xml" : { "name" : "RecordEndDateRequest" } }, "BatchHistoryQuery" : { "title" : "BatchHistoryQuery", "type" : "object", "properties" : { "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "fromDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "fromDate" } }, "toDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "toDate" } }, "states" : { "type" : "array", "xml" : { "name" : "state" }, "items" : { "type" : "string", "example" : "string", "xml" : { "name" : "state" } } }, "offsetToken" : { "type" : "string", "example" : "MjAw", "xml" : { "name" : "offsetToken", "attribute" : true } }, "limit" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "limit", "attribute" : true } } }, "xml" : { "name" : "BatchHistoryQuery" } }, "OutboundActivityResponse" : { "title" : "OutboundActivityResponse", "type" : "object", "properties" : { "outboundActivities" : { "type" : "array", "xml" : { "name" : "OutboundActivity" }, "items" : { "title" : "OutboundActivity", "type" : "object", "properties" : { "id" : { "type" : "string", "example" : "12345", "xml" : { "name" : "id" } }, "grid" : { "type" : "string", "example" : "12345", "xml" : { "name" : "grid" } }, "title" : { "type" : "string", "example" : "Customer Record", "xml" : { "name" : "title" } }, "opType" : { "type" : "string", "example" : "CREATE", "xml" : { "name" : "opType" } }, "createdAt" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "createdAt" } } }, "xml" : { "name" : "OutboundActivity" } } }, "resultCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "resultCount", "attribute" : true } }, "totalCount" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "totalCount", "attribute" : true } } }, "xml" : { "name" : "OutboundActivityResponse" } }, "TransactionQueryRequest" : { "title" : "TransactionQueryRequest", "type" : "object", "properties" : { "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId" } }, "startFromDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "startFromDate" } }, "startToDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "startToDate" } }, "endFromDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "endFromDate" } }, "endToDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "endToDate" } }, "offsetToken" : { "type" : "string", "example" : "MjAw", "xml" : { "name" : "offsetToken", "attribute" : true } }, "limit" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "limit", "attribute" : true } }, "includeEvents" : { "type" : "boolean", "xml" : { "name" : "includeEvents", "attribute" : true } } }, "xml" : { "name" : "TransactionQueryRequest" } }, "String" : { "title" : "Response", "type" : "string", "xml" : { "name" : "response" } }, "StagingActionRequest" : { "title" : "StagingActionRequest", "type" : "object", "properties" : { "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "stagingAreaId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "stagingAreaId" } }, "filter" : { "title" : "StagedEntityFilter", "type" : "object", "properties" : { "createdDate" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "createdDate" } }, "createDateRelative" : { "title" : "RelativeTimePeriod", "type" : "object", "xml" : { "name" : "createDateRelative" } }, "sourceEntityIds" : { "title" : "SourceEntityIds", "type" : "object", "properties" : { }, "xml" : { "name" : "sourceEntityIds" } }, "stagedEntryIds" : { "title" : "StagedEntryIds", "type" : "object", "properties" : { "stagedEntryId" : { "type" : "array", "xml" : { "name" : "stagedEntryId" }, "items" : { "type" : "string", "example" : "12345", "xml" : { "name" : "stagedEntryId" } } } }, "xml" : { "name" : "stagedEntryIds" } }, "states" : { "type" : "array", "xml" : { "name" : "state" }, "items" : { "type" : "string", "example" : "string", "xml" : { "name" : "state" } } }, "op" : { "type" : "string", "example" : "AND", "xml" : { "name" : "op", "attribute" : true }, "default" : "AND", "enum" : [ "AND", "OR" ] } }, "xml" : { "name" : "filter" } } }, "xml" : { "name" : "StagingActionRequest" } }, "RecordQueryResponse" : { "title" : "RecordQueryResponse", "type" : "object", "properties" : { "records" : { "type" : "array", "xml" : { "name" : "Record" }, "items" : { "title" : "Record", "type" : "object", "properties" : { "fields" : { "title" : "Fields", "type" : "object", "properties" : { "fields" : { "type" : "string", "example" : "Dynamic field content - structure varies by universe schema", "xml" : { "name" : "fields" } } }, "xml" : { "name" : "Fields" } }, "recordId" : { "type" : "string", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "name" : "recordId", "attribute" : true } } }, "xml" : { "name" : "Record" } } }, "resultCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "resultCount", "attribute" : true } }, "totalCount" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "totalCount", "attribute" : true } }, "offsetToken" : { "type" : "string", "example" : "MjAw", "xml" : { "name" : "offsetToken", "attribute" : true } } }, "xml" : { "name" : "RecordQueryResponse" } }, "BulkProcessingQueryRequest" : { "title" : "BulkProcessingQueryRequest", "type" : "object", "properties" : { "filter" : { "title" : "BulkProcessingQueryFilter", "type" : "object", "properties" : { "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "type" : { "title" : "BulkProcessingType", "type" : "object", "xml" : { "name" : "type" } }, "status" : { "title" : "BulkProcessingStatus", "type" : "object", "xml" : { "name" : "status" } }, "startTimeRelative" : { "title" : "RelativeTimePeriod", "type" : "object", "xml" : { "name" : "startTimeRelative" } }, "startTime" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "startTime" } }, "endTimeRelative" : { "title" : "RelativeTimePeriod", "type" : "object", "xml" : { "name" : "endTimeRelative" } }, "endTime" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "endTime" } } }, "xml" : { "name" : "filter" } }, "offsetToken" : { "type" : "string", "example" : "MjAw", "xml" : { "name" : "offsetToken", "attribute" : true } }, "limit" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "limit", "attribute" : true } } }, "xml" : { "name" : "BulkProcessingQueryRequest" } }, "RecordPurgeRequest" : { "title" : "RecordPurgeRequest", "type" : "object", "properties" : { "recordId" : { "type" : "array", "xml" : { "name" : "recordId" }, "items" : { "type" : "string", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "name" : "recordId" } } } }, "xml" : { "name" : "RecordPurgeRequest" } }, "StagedEntity" : { "title" : "StagedEntity", "type" : "object", "properties" : { "message" : { "type" : "string", "example" : "Message element will appear only if the success is false", "xml" : { "name" : "message" } }, "unparsedData" : { "type" : "string", "example" : "string", "xml" : { "name" : "unparsedData" } }, "workingData" : { "title" : "MdmDataRepresentation", "type" : "object", "properties" : { "fields" : { "type" : "array", "xml" : { "name" : "field" }, "items" : { "title" : "MdmDataField", "type" : "object", "properties" : { "reps" : { "type" : "array", "xml" : { "name" : "rep" }, "items" : { "type" : "string", "description" : "Circular reference to MdmDataRepresentation", "xml" : { "name" : "rep" } } }, "uniqueId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "uniqueId", "attribute" : true } }, "value" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value", "attribute" : true } } }, "xml" : { "name" : "field" } } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId", "attribute" : true } }, "opType" : { "type" : "string", "example" : "CREATE", "xml" : { "name" : "opType", "attribute" : true } } }, "xml" : { "name" : "workingData" } }, "fullData" : { "title" : "MdmDataRepresentation", "type" : "object", "properties" : { "fields" : { "type" : "array", "xml" : { "name" : "field" }, "items" : { "title" : "MdmDataField", "type" : "object", "properties" : { "reps" : { "type" : "array", "xml" : { "name" : "rep" }, "items" : { "type" : "string", "description" : "Circular reference to MdmDataRepresentation", "xml" : { "name" : "rep" } } }, "uniqueId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "uniqueId", "attribute" : true } }, "value" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value", "attribute" : true } } }, "xml" : { "name" : "field" } } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId", "attribute" : true } }, "opType" : { "type" : "string", "example" : "CREATE", "xml" : { "name" : "opType", "attribute" : true } } }, "xml" : { "name" : "fullData" } }, "entity" : { "title" : "Entity", "type" : "object", "properties" : { "data" : { "type" : "string", "example" : "string", "xml" : { "name" : "data" } } }, "xml" : { "name" : "entity" } }, "id" : { "type" : "string", "example" : "12345", "xml" : { "name" : "id", "attribute" : true } }, "batchEntityId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "batchEntityId", "attribute" : true } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId", "attribute" : true } }, "createdDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "createdDate", "attribute" : true } }, "state" : { "type" : "string", "example" : "string", "xml" : { "name" : "state", "attribute" : true } } }, "xml" : { "name" : "StagedEntity" } }, "UniverseDescription" : { "title" : "UniverseDescription", "type" : "object", "properties" : { "_id" : { "type" : "string", "example" : "12345", "xml" : { "name" : "id" } }, "_version" : { "type" : "string", "example" : "string", "xml" : { "name" : "version" } }, "_name" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "name" } }, "_stats" : { "title" : "UniverseStatistics", "type" : "object", "properties" : { "sourceStatsCollection" : { "type" : "array", "xml" : { "name" : "sourceStats" }, "items" : { "title" : "SourceStatistics", "type" : "object", "properties" : { "sourceCode" : { "type" : "string", "example" : "string", "xml" : { "name" : "sourceCode", "attribute" : true } }, "pendingBatchUpdates" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "pendingBatchUpdates", "attribute" : true } }, "pendingBatchRecords" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "pendingBatchRecords", "attribute" : true } }, "pendingChannelDeliveries" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "pendingChannelDeliveries", "attribute" : true } }, "undeliverableChannelDeliveries" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "undeliverableChannelDeliveries", "attribute" : true } } }, "xml" : { "name" : "sourceStats" } } }, "activeRecords" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "activeRecords", "attribute" : true } }, "enddatedRecords" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "enddatedRecords", "attribute" : true } }, "quarantinedRecords" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "quarantinedRecords", "attribute" : true } }, "asOf" : { "type" : "string", "example" : "string", "xml" : { "name" : "asOf", "attribute" : true } } }, "xml" : { "name" : "stats" } }, "_sources" : { "type" : "array", "xml" : { "name" : "source" }, "items" : { "title" : "Source", "type" : "object", "properties" : { "channels" : { "type" : "array", "xml" : { "name" : "channel" }, "items" : { "title" : "Channel", "type" : "object", "properties" : { "id" : { "type" : "string", "example" : "12345", "xml" : { "name" : "id", "attribute" : true } }, "updateType" : { "title" : "ChannelUpdateType", "type" : "object", "xml" : { "name" : "updateType", "attribute" : true } }, "outboundType" : { "title" : "OutboundType", "type" : "object", "xml" : { "name" : "outboundType", "attribute" : true } }, "state" : { "title" : "SourceChannelState", "type" : "object", "xml" : { "name" : "state", "attribute" : true } }, "primary" : { "type" : "boolean", "xml" : { "name" : "primary", "attribute" : true } } }, "xml" : { "name" : "channel" } } }, "code" : { "type" : "string", "example" : "string", "xml" : { "name" : "code", "attribute" : true } }, "componentId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "componentId", "attribute" : true } }, "state" : { "title" : "SourceChannelState", "type" : "object", "xml" : { "name" : "state", "attribute" : true } }, "allowContribute" : { "type" : "boolean", "xml" : { "name" : "allowContribute", "attribute" : true } }, "_default" : { "type" : "boolean", "xml" : { "name" : "default", "attribute" : true } } }, "xml" : { "name" : "source" } } }, "_layoutId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "layoutid" } }, "_layout" : { "title" : "Layout", "type" : "object", "properties" : { "model" : { "title" : "LayoutModel", "type" : "object", "properties" : { "element" : { "type" : "array", "xml" : { "name" : "element" }, "items" : { "title" : "LayoutElement", "type" : "object", "properties" : { "element" : { "type" : "array", "xml" : { "name" : "element" }, "items" : { "type" : "string", "description" : "Circular reference to LayoutElement", "xml" : { "name" : "element" } } }, "values" : { "type" : "array", "xml" : { "name" : "value" }, "items" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value" } } }, "uniqueId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "uniqueId", "attribute" : true } }, "name" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "name", "attribute" : true } }, "prettyName" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "prettyName", "attribute" : true } }, "type" : { "title" : "LayoutElementType", "type" : "object", "xml" : { "name" : "type", "attribute" : true } }, "required" : { "type" : "boolean", "xml" : { "name" : "required", "attribute" : true } }, "masked" : { "title" : "LayoutMaskType", "type" : "object", "properties" : { "value" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value" } } }, "xml" : { "name" : "masked", "attribute" : true } }, "firstMaskCharsCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "firstMaskCharsCount", "attribute" : true } }, "lastMaskCharsCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "lastMaskCharsCount", "attribute" : true } }, "referenceUniverseId" : { "type" : "string", "example" : "ad24b692-ac74-4e1d-a671-282f4f9ffdbd", "xml" : { "name" : "referenceUniverseId", "attribute" : true } }, "enforceIntegrity" : { "type" : "boolean", "xml" : { "name" : "enforceIntegrity", "attribute" : true } }, "incomingReferenceIntegrity" : { "type" : "boolean", "xml" : { "name" : "incomingReferenceIntegrity", "attribute" : true } }, "titleField" : { "type" : "boolean", "xml" : { "name" : "titleField", "attribute" : true } }, "minLength" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "minLength", "attribute" : true } }, "maxLength" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "maxLength", "attribute" : true } }, "truncateLength" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "truncateLength", "attribute" : true } }, "regex" : { "type" : "string", "example" : "string", "xml" : { "name" : "regex", "attribute" : true } }, "repeatable" : { "type" : "boolean", "xml" : { "name" : "repeatable", "attribute" : true } }, "collectionMatchType" : { "title" : "CollectionMatchType", "type" : "object", "xml" : { "name" : "collectionMatchType", "attribute" : true } }, "collectionMatchKeys" : { "type" : "string", "example" : "string", "xml" : { "name" : "collectionMatchKeys", "attribute" : true } }, "collectionPrettyName" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "collectionPrettyName", "attribute" : true } }, "collectionTag" : { "type" : "string", "example" : "string", "xml" : { "name" : "collectionTag", "attribute" : true } }, "collectionUniqueId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "collectionUniqueId", "attribute" : true } }, "parentCollectionId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "parentCollectionId", "attribute" : true } } }, "xml" : { "name" : "element" } } }, "name" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "name", "attribute" : true } } }, "xml" : { "name" : "model" } }, "deletedElements" : { "title" : "LayoutDeletedElements", "type" : "object", "properties" : { "element" : { "type" : "array", "xml" : { "name" : "element" }, "items" : { "title" : "LayoutElement", "type" : "object", "properties" : { "element" : { "type" : "array", "xml" : { "name" : "element" }, "items" : { "type" : "string", "description" : "Circular reference to LayoutElement", "xml" : { "name" : "element" } } }, "values" : { "type" : "array", "xml" : { "name" : "value" }, "items" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value" } } }, "uniqueId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "uniqueId", "attribute" : true } }, "name" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "name", "attribute" : true } }, "prettyName" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "prettyName", "attribute" : true } }, "type" : { "title" : "LayoutElementType", "type" : "object", "xml" : { "name" : "type", "attribute" : true } }, "required" : { "type" : "boolean", "xml" : { "name" : "required", "attribute" : true } }, "masked" : { "title" : "LayoutMaskType", "type" : "object", "properties" : { "value" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value" } } }, "xml" : { "name" : "masked", "attribute" : true } }, "firstMaskCharsCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "firstMaskCharsCount", "attribute" : true } }, "lastMaskCharsCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "lastMaskCharsCount", "attribute" : true } }, "referenceUniverseId" : { "type" : "string", "example" : "ad24b692-ac74-4e1d-a671-282f4f9ffdbd", "xml" : { "name" : "referenceUniverseId", "attribute" : true } }, "enforceIntegrity" : { "type" : "boolean", "xml" : { "name" : "enforceIntegrity", "attribute" : true } }, "incomingReferenceIntegrity" : { "type" : "boolean", "xml" : { "name" : "incomingReferenceIntegrity", "attribute" : true } }, "titleField" : { "type" : "boolean", "xml" : { "name" : "titleField", "attribute" : true } }, "minLength" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "minLength", "attribute" : true } }, "maxLength" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "maxLength", "attribute" : true } }, "truncateLength" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "truncateLength", "attribute" : true } }, "regex" : { "type" : "string", "example" : "string", "xml" : { "name" : "regex", "attribute" : true } }, "repeatable" : { "type" : "boolean", "xml" : { "name" : "repeatable", "attribute" : true } }, "collectionMatchType" : { "title" : "CollectionMatchType", "type" : "object", "xml" : { "name" : "collectionMatchType", "attribute" : true } }, "collectionMatchKeys" : { "type" : "string", "example" : "string", "xml" : { "name" : "collectionMatchKeys", "attribute" : true } }, "collectionPrettyName" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "collectionPrettyName", "attribute" : true } }, "collectionTag" : { "type" : "string", "example" : "string", "xml" : { "name" : "collectionTag", "attribute" : true } }, "collectionUniqueId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "collectionUniqueId", "attribute" : true } }, "parentCollectionId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "parentCollectionId", "attribute" : true } } }, "xml" : { "name" : "element" } } }, "name" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "name", "attribute" : true } } }, "xml" : { "name" : "deletedElements" } }, "xsd" : { "type" : "string", "example" : "string", "xml" : { "name" : "xsd" } }, "layoutFields" : { "type" : "array", "xml" : { "name" : "field" }, "items" : { "title" : "LayoutField", "type" : "object", "properties" : { "values" : { "type" : "array", "xml" : { "name" : "value" }, "items" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value" } } }, "matchKeys" : { "type" : "array", "xml" : { "name" : "matchKey" }, "items" : { "type" : "string", "example" : "string", "xml" : { "name" : "matchKey" } } }, "uniqueId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "uniqueId", "attribute" : true } }, "xpath" : { "type" : "string", "example" : "string", "xml" : { "name" : "xpath", "attribute" : true } }, "type" : { "title" : "LayoutFieldType", "type" : "object", "xml" : { "name" : "type", "attribute" : true } }, "prettyName" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "prettyName", "attribute" : true } }, "required" : { "type" : "boolean", "xml" : { "name" : "required", "attribute" : true } }, "masked" : { "title" : "LayoutMaskType", "type" : "object", "properties" : { "value" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value" } } }, "xml" : { "name" : "masked", "attribute" : true } }, "firstMaskCharsCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "firstMaskCharsCount", "attribute" : true } }, "lastMaskCharsCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "lastMaskCharsCount", "attribute" : true } }, "referenceUniverseId" : { "type" : "string", "example" : "ad24b692-ac74-4e1d-a671-282f4f9ffdbd", "xml" : { "name" : "referenceUniverseId", "attribute" : true } }, "enforceIntegrity" : { "type" : "boolean", "xml" : { "name" : "enforceIntegrity", "attribute" : true } }, "incomingReferenceIntegrity" : { "type" : "boolean", "xml" : { "name" : "incomingReferenceIntegrity", "attribute" : true } }, "titleField" : { "type" : "boolean", "xml" : { "name" : "titleField", "attribute" : true } }, "minLength" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "minLength", "attribute" : true } }, "maxLength" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "maxLength", "attribute" : true } }, "truncateLength" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "truncateLength", "attribute" : true } }, "regex" : { "type" : "string", "example" : "string", "xml" : { "name" : "regex", "attribute" : true } }, "collectionId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "collectionId", "attribute" : true } }, "collectionMatchType" : { "title" : "CollectionMatchType", "type" : "object", "xml" : { "name" : "collectionMatchType", "attribute" : true } } }, "xml" : { "name" : "field" } } }, "titleField" : { "title" : "TitleParameters", "type" : "object", "properties" : { "parameter" : { "type" : "array", "xml" : { "name" : "parameter" }, "items" : { "title" : "TitleParameter", "type" : "object", "properties" : { "value" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value" } }, "type" : { "title" : "TitleParameterType", "type" : "object", "xml" : { "name" : "type", "attribute" : true } } }, "xml" : { "name" : "parameter" } } } }, "xml" : { "name" : "TitleField" } }, "idXPath" : { "type" : "string", "example" : "12345", "xml" : { "name" : "idXPath", "attribute" : true } } }, "xml" : { "name" : "layout" } }, "_matchConfigId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "matchid" } }, "_matchConfig" : { "title" : "MatchConfig", "type" : "object", "properties" : { "rounds" : { "type" : "array", "xml" : { "name" : "round" }, "items" : { "title" : "Round", "type" : "object", "properties" : { "matchrule" : { "title" : "MatchRule", "type" : "object", "xml" : { "name" : "matchrule" } } }, "xml" : { "name" : "round" } } } }, "xml" : { "name" : "matchconfig" } }, "_dataQuality" : { "title" : "DataQuality", "type" : "object", "properties" : { "steps" : { "type" : "array", "xml" : { "name" : "step" }, "items" : { "title" : "DataQualityStep", "type" : "object", "properties" : { "businessrules" : { "type" : "string", "example" : "string", "xml" : { "name" : "businessrules" } }, "fields" : { "type" : "array", "xml" : { "name" : "field" }, "items" : { "title" : "DataQualityField", "type" : "object", "properties" : { "id" : { "type" : "string", "example" : "12345", "xml" : { "name" : "id", "attribute" : true } }, "type" : { "type" : "string", "example" : "string", "xml" : { "name" : "type", "attribute" : true } }, "value" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value", "attribute" : true } } }, "xml" : { "name" : "field" } } }, "cookieValue" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "cookieValue" } }, "inputs" : { "type" : "array", "xml" : { "name" : "input" }, "items" : { "title" : "DataQualityInput", "type" : "object", "properties" : { "id" : { "type" : "string", "example" : "12345", "xml" : { "name" : "id", "attribute" : true } }, "uniqueId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "uniqueId", "attribute" : true } }, "xpath" : { "type" : "string", "example" : "string", "xml" : { "name" : "xpath", "attribute" : true } } }, "xml" : { "name" : "input" } } }, "outputs" : { "type" : "array", "xml" : { "name" : "output" }, "items" : { "title" : "DataQualityOutput", "type" : "object", "properties" : { "id" : { "type" : "string", "example" : "12345", "xml" : { "name" : "id", "attribute" : true } }, "uniqueId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "uniqueId", "attribute" : true } }, "xpath" : { "type" : "string", "example" : "string", "xml" : { "name" : "xpath", "attribute" : true } } }, "xml" : { "name" : "output" } } }, "diffFields" : { "type" : "array", "xml" : { "name" : "diffField" }, "items" : { "type" : "string", "example" : "string", "xml" : { "name" : "diffField" } } }, "serviceConfig" : { "title" : "ServiceConfig", "type" : "object", "properties" : { "connectionConfig" : { "type" : "string", "example" : "string", "xml" : { "name" : "connectionConfig" } } }, "xml" : { "name" : "serviceConfig" } }, "sources" : { "title" : "DQSources", "type" : "object", "properties" : { "sources" : { "type" : "array", "xml" : { "name" : "sourceId" }, "items" : { "type" : "string", "example" : "string", "xml" : { "name" : "sourceId" } } } }, "xml" : { "name" : "sources" } }, "id" : { "type" : "string", "example" : "12345", "xml" : { "name" : "id", "attribute" : true } }, "name" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "name", "attribute" : true } }, "templateId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "templateId", "attribute" : true } }, "templateName" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "templateName", "attribute" : true } }, "serviceType" : { "type" : "string", "example" : "string", "xml" : { "name" : "serviceType", "attribute" : true } }, "operationType" : { "type" : "string", "example" : "string", "xml" : { "name" : "operationType", "attribute" : true } }, "objectTypeId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "objectTypeId", "attribute" : true } }, "connectionId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "connectionId", "attribute" : true } }, "processId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "processId", "attribute" : true } }, "callFrequency" : { "title" : "CallFrequency", "type" : "object", "xml" : { "name" : "callFrequency", "attribute" : true } }, "stepType" : { "title" : "DataQualityStepType", "type" : "object", "xml" : { "name" : "stepType", "attribute" : true } } }, "xml" : { "name" : "step" } } } }, "xml" : { "name" : "dataquality" } } }, "xml" : { "name" : "universe" } }, "RecordQueryRequest" : { "title" : "RecordQueryRequest", "type" : "object", "properties" : { "view" : { "title" : "RecordQueryView", "type" : "object", "properties" : { "fieldId" : { "type" : "array", "xml" : { "name" : "fieldId" }, "items" : { "type" : "string", "example" : "FIRST_NAME", "xml" : { "name" : "fieldId" } } } }, "xml" : { "name" : "view" } }, "sort" : { "title" : "RecordQuerySort", "type" : "object", "properties" : { "sortField" : { "type" : "array", "xml" : { "name" : "sortField" }, "items" : { "title" : "RecordQuerySortField", "type" : "object", "properties" : { "fieldId" : { "type" : "string", "example" : "FIRST_NAME", "xml" : { "name" : "fieldId" } }, "direction" : { "type" : "string", "example" : "ASC", "xml" : { "name" : "direction" } } }, "xml" : { "name" : "sortField" } } } }, "xml" : { "name" : "sort" } }, "filter" : { "title" : "RecordQueryFilter", "type" : "object", "properties" : { "createdDate" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "createdDate" } }, "updatedDate" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "updatedDate" } }, "fieldValue" : { "type" : "array", "xml" : { "name" : "fieldValue" }, "items" : { "title" : "FieldValueCondition", "type" : "object", "properties" : { "fieldId" : { "type" : "string", "example" : "FIRST_NAME", "xml" : { "name" : "fieldId" } }, "operator" : { "type" : "string", "example" : "EQUALS", "xml" : { "name" : "operator" } }, "value" : { "type" : "array", "xml" : { "name" : "value" }, "items" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value" } } } }, "xml" : { "name" : "fieldValue" } } }, "sourceLink" : { "title" : "SourceLinkCondition", "type" : "object", "properties" : { "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "linkType" : { "type" : "string", "example" : "LINKED", "xml" : { "name" : "linkType" } } }, "xml" : { "name" : "sourceLink" } }, "creatingSourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "creatingSourceId" } }, "tags" : { "title" : "Tags", "type" : "object", "properties" : { "tagName" : { "type" : "array", "xml" : { "name" : "tagName" }, "items" : { "type" : "string", "example" : "VIP_CUSTOMER", "xml" : { "name" : "tagName" } } } }, "xml" : { "name" : "tags" } }, "unresolvedReference" : { "title" : "UnresolvedReferencesCondition", "type" : "object", "properties" : { "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "fieldId" : { "type" : "string", "example" : "FIRST_NAME", "xml" : { "name" : "fieldId" } } }, "xml" : { "name" : "unresolvedReference" } }, "recordIds" : { "title" : "RecordIds", "type" : "object", "properties" : { "recordId" : { "type" : "array", "xml" : { "name" : "recordId" }, "items" : { "type" : "string", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "name" : "recordId" } } } }, "xml" : { "name" : "recordIds" } }, "queryString" : { "type" : "string", "example" : "FIRST_NAME:John AND STATUS:ACTIVE", "xml" : { "name" : "queryString" } }, "op" : { "type" : "string", "example" : "AND", "xml" : { "name" : "op", "attribute" : true }, "default" : "AND", "enum" : [ "AND", "OR" ] } }, "xml" : { "name" : "filter" } }, "offsetToken" : { "type" : "string", "example" : "MjAw", "xml" : { "name" : "offsetToken", "attribute" : true } }, "limit" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "limit", "attribute" : true } }, "includeSourceLinks" : { "type" : "boolean", "xml" : { "name" : "includeSourceLinks", "attribute" : true } } }, "xml" : { "name" : "RecordQueryRequest" } }, "ApprovalResponse" : { "title" : "ApprovalResponse", "type" : "object", "properties" : { "resolution" : { "title" : "QuarantineResolutionType", "type" : "object", "xml" : { "name" : "resolution", "attribute" : true } } }, "xml" : { "name" : "ApprovalResponse" } }, "RecordPurgeResponse" : { "title" : "RecordPurgeResponse", "type" : "object", "properties" : { "result" : { "type" : "array", "xml" : { "name" : "result" }, "items" : { "title" : "Result", "type" : "object", "properties" : { "recordId" : { "type" : "string", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "name" : "recordId" } }, "success" : { "type" : "boolean", "xml" : { "name" : "success" } }, "message" : { "type" : "string", "example" : "Message element will appear only if the success is false", "xml" : { "name" : "message" } } }, "xml" : { "name" : "result" } } } }, "xml" : { "name" : "RecordPurgeResponse" } }, "Record" : { "title" : "Record", "type" : "object", "properties" : { "links" : { "title" : "Links", "type" : "object", "properties" : { "links" : { "type" : "array", "xml" : { "name" : "link" }, "items" : { "title" : "Link", "type" : "object", "properties" : { "source" : { "type" : "string", "example" : "CRM_SYSTEM", "xml" : { "name" : "source", "attribute" : true } }, "entityId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "entityId", "attribute" : true } }, "establishedDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "establishedDate", "attribute" : true } } }, "xml" : { "name" : "link" } } } }, "xml" : { "name" : "links" } }, "recordId" : { "type" : "string", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "name" : "recordId", "attribute" : true } }, "endDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "endDate", "attribute" : true } } }, "xml" : { "name" : "Record" } }, "MdmActionResponse" : { "title" : "MdmActionResponse", "type" : "object", "properties" : { "resultCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "resultCount", "attribute" : true } } }, "xml" : { "name" : "MdmActionResponse" } }, "QuarantineQueryResponse" : { "title" : "QuarantineQueryResponse", "type" : "object", "properties" : { "quarantineEntry" : { "type" : "array", "xml" : { "name" : "QuarantineEntry" }, "items" : { "title" : "QuarantineEntry", "type" : "object", "properties" : { "cause" : { "type" : "string", "example" : "POSSIBLE_DUPLICATE", "xml" : { "name" : "cause" } }, "reason" : { "type" : "string", "example" : "string", "xml" : { "name" : "reason" } }, "matchRule" : { "type" : "string", "example" : "string", "xml" : { "name" : "matchRule" } }, "resolution" : { "type" : "string", "example" : "USER_APPROVED", "xml" : { "name" : "resolution" } }, "fields" : { "type" : "string", "example" : "Dynamic field content - structure varies by universe schema", "xml" : { "name" : "fields" } }, "entity" : { "title" : "Entity", "type" : "object", "properties" : { "data" : { "type" : "string", "example" : "string", "xml" : { "name" : "data" } } }, "xml" : { "name" : "entity" } }, "createdDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "createdDate", "attribute" : true } }, "endDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "endDate", "attribute" : true } }, "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId", "attribute" : true } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId", "attribute" : true } }, "transactionId" : { "type" : "string", "example" : "d1684e83-5e78-4fbe-99f0-32f08e507288", "xml" : { "name" : "transactionId", "attribute" : true } } }, "xml" : { "name" : "QuarantineEntry" } } }, "resultCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "resultCount", "attribute" : true } }, "totalCount" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "totalCount", "attribute" : true } }, "offsetToken" : { "type" : "string", "example" : "MjAw", "xml" : { "name" : "offsetToken", "attribute" : true } } }, "xml" : { "name" : "QuarantineQueryResponse" } }, "BatchHistoryResponse" : { "title" : "BatchHistoryResponse", "type" : "object", "properties" : { "batches" : { "type" : "array", "xml" : { "name" : "batch" }, "items" : { "title" : "BatchMetaData", "type" : "object", "properties" : { "batchId" : { "type" : "string", "example" : "42", "xml" : { "name" : "batchId" } }, "source" : { "type" : "string", "example" : "CRM_SYSTEM", "xml" : { "name" : "source" } }, "state" : { "type" : "string", "example" : "COMPLETED", "xml" : { "name" : "state" } }, "createdAt" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "createdAt" } }, "endedAt" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "endedAt" } } }, "xml" : { "name" : "batch" } } }, "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId", "attribute" : true } }, "offsetToken" : { "type" : "string", "example" : "MjAw", "xml" : { "name" : "offsetToken", "attribute" : true } }, "resultCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "resultCount", "attribute" : true } }, "totalCount" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "totalCount", "attribute" : true } } }, "xml" : { "name" : "BatchHistoryResponse" } }, "BulkProcessingQueryResponse" : { "title" : "BulkProcessingQueryResponse", "type" : "object", "properties" : { "request" : { "type" : "array", "xml" : { "name" : "request" }, "items" : { "title" : "BulkProcessingRequest", "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "id" } }, "type" : { "title" : "BulkProcessingType", "type" : "object", "xml" : { "name" : "type" } }, "status" : { "title" : "BulkProcessingStatus", "type" : "object", "xml" : { "name" : "status" } }, "recordsTotal" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "recordsTotal" } }, "recordsSuccess" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "recordsSuccess" } }, "recordsError" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "recordsError" } }, "completePercentage" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "completePercentage" } }, "startTime" : { "type" : "string", "example" : "string", "xml" : { "name" : "startTime" } }, "endTime" : { "type" : "string", "example" : "string", "xml" : { "name" : "endTime" } }, "timeElapsed" : { "type" : "integer", "format" : "int64", "example" : 1770303818225, "xml" : { "name" : "timeElapsed" } } }, "xml" : { "name" : "request" } } }, "resultCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "resultCount", "attribute" : true } }, "totalCount" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "totalCount", "attribute" : true } }, "offsetToken" : { "type" : "string", "example" : "MjAw", "xml" : { "name" : "offsetToken", "attribute" : true } } }, "xml" : { "name" : "BulkProcessingQueryResponse" } }, "QuarantineEntry" : { "title" : "QuarantineEntry", "type" : "object", "properties" : { "cause" : { "type" : "string", "example" : "POSSIBLE_DUPLICATE", "xml" : { "name" : "cause" } }, "reason" : { "type" : "string", "example" : "string", "xml" : { "name" : "reason" } }, "matchRule" : { "type" : "string", "example" : "string", "xml" : { "name" : "matchRule" } }, "resolution" : { "type" : "string", "example" : "USER_APPROVED", "xml" : { "name" : "resolution" } }, "fields" : { "type" : "string", "example" : "Dynamic field content - structure varies by universe schema", "xml" : { "name" : "fields" } }, "entity" : { "title" : "Entity", "type" : "object", "properties" : { "data" : { "type" : "string", "example" : "string", "xml" : { "name" : "data" } } }, "xml" : { "name" : "entity" } }, "createdDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "createdDate", "attribute" : true } }, "endDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "endDate", "attribute" : true } }, "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId", "attribute" : true } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId", "attribute" : true } }, "transactionId" : { "type" : "string", "example" : "d1684e83-5e78-4fbe-99f0-32f08e507288", "xml" : { "name" : "transactionId", "attribute" : true } } }, "xml" : { "name" : "QuarantineEntry" } }, "InputStream" : { "title" : "XML Data", "type" : "string", "description" : "XML request data", "xml" : { "name" : "data" } }, "BatchMetaData" : { "title" : "BatchMetaData", "type" : "object", "properties" : { "batchId" : { "type" : "string", "example" : "42", "xml" : { "name" : "batchId" } }, "source" : { "type" : "string", "example" : "CRM_SYSTEM", "xml" : { "name" : "source" } }, "instance" : { "type" : "string", "example" : "string", "xml" : { "name" : "instance" } }, "lockedBy" : { "type" : "string", "example" : "string", "xml" : { "name" : "lockedBy" } }, "createdByType" : { "title" : "BatchCreatedByType", "type" : "object", "xml" : { "name" : "createdByType" } }, "trackback" : { "type" : "string", "example" : "string", "xml" : { "name" : "trackback" } }, "state" : { "type" : "string", "example" : "COMPLETED", "xml" : { "name" : "state" } }, "createdAt" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "createdAt" } }, "updatedAt" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "updatedAt" } }, "parseStart" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "parseStart" } }, "parseEnd" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "parseEnd" } }, "enrichStart" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "enrichStart" } }, "enrichEnd" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "enrichEnd" } }, "incorporateStart" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "incorporateStart" } }, "incorporateEnd" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "incorporateEnd" } }, "endedAt" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "endedAt" } }, "entityCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "entityCount" } }, "quarantinedCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "quarantinedCount" } }, "createdCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "createdCount" } }, "deletedCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "deletedCount" } }, "updatedCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "updatedCount" } }, "entities" : { "title" : "BatchEntities", "type" : "object", "properties" : { "entities" : { "type" : "array", "xml" : { "name" : "entity" }, "items" : { "title" : "EntityMetaData", "type" : "object", "properties" : { "createdAt" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "createdAt" } }, "updatedAt" : { "type" : "string", "example" : "2016-10-31T15:12:21Z", "xml" : { "name" : "updatedAt" } }, "state" : { "type" : "string", "example" : "COMPLETED", "xml" : { "name" : "state" } }, "stateDetail" : { "type" : "string", "example" : "CREATED", "xml" : { "name" : "stateDetail" } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId" } }, "recordId" : { "type" : "string", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "name" : "recordId" } }, "transactionId" : { "type" : "string", "example" : "d1684e83-5e78-4fbe-99f0-32f08e507288", "xml" : { "name" : "transactionId" } }, "id" : { "type" : "string", "example" : "12345", "xml" : { "name" : "id", "attribute" : true } } }, "xml" : { "name" : "entity" } } } }, "xml" : { "name" : "entities" } } }, "xml" : { "name" : "batch" } }, "StagingQueryResponse" : { "title" : "StagingQueryResponse", "type" : "object", "properties" : { "offsetToken" : { "type" : "string", "example" : "MjAw", "xml" : { "name" : "offsetToken" } }, "stagedEntity" : { "type" : "array", "xml" : { "name" : "StagedEntity" }, "items" : { "title" : "StagedEntity", "type" : "object", "properties" : { "message" : { "type" : "string", "example" : "Message element will appear only if the success is false", "xml" : { "name" : "message" } }, "unparsedData" : { "type" : "string", "example" : "string", "xml" : { "name" : "unparsedData" } }, "workingData" : { "title" : "MdmDataRepresentation", "type" : "object", "properties" : { "fields" : { "type" : "array", "xml" : { "name" : "field" }, "items" : { "title" : "MdmDataField", "type" : "object", "properties" : { "reps" : { "type" : "array", "xml" : { "name" : "rep" }, "items" : { "type" : "string", "description" : "Circular reference to MdmDataRepresentation", "xml" : { "name" : "rep" } } }, "uniqueId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "uniqueId", "attribute" : true } }, "value" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value", "attribute" : true } }, "title" : { "type" : "string", "example" : "Customer Record", "xml" : { "name" : "title", "attribute" : true } } }, "xml" : { "name" : "field" } } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId", "attribute" : true } }, "opType" : { "type" : "string", "example" : "CREATE", "xml" : { "name" : "opType", "attribute" : true } } }, "xml" : { "name" : "workingData" } }, "fullData" : { "title" : "MdmDataRepresentation", "type" : "object", "properties" : { "fields" : { "type" : "array", "xml" : { "name" : "field" }, "items" : { "title" : "MdmDataField", "type" : "object", "properties" : { "reps" : { "type" : "array", "xml" : { "name" : "rep" }, "items" : { "type" : "string", "description" : "Circular reference to MdmDataRepresentation", "xml" : { "name" : "rep" } } }, "uniqueId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "uniqueId", "attribute" : true } }, "value" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value", "attribute" : true } }, "title" : { "type" : "string", "example" : "Customer Record", "xml" : { "name" : "title", "attribute" : true } } }, "xml" : { "name" : "field" } } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId", "attribute" : true } }, "opType" : { "type" : "string", "example" : "CREATE", "xml" : { "name" : "opType", "attribute" : true } } }, "xml" : { "name" : "fullData" } }, "entity" : { "title" : "Entity", "type" : "object", "properties" : { "data" : { "type" : "string", "example" : "string", "xml" : { "name" : "data" } } }, "xml" : { "name" : "entity" } }, "id" : { "type" : "string", "example" : "12345", "xml" : { "name" : "id", "attribute" : true } }, "batchEntityId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "batchEntityId", "attribute" : true } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId", "attribute" : true } }, "createdDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "createdDate", "attribute" : true } }, "state" : { "type" : "string", "example" : "string", "xml" : { "name" : "state", "attribute" : true } }, "matchId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "matchId", "attribute" : true } }, "matchType" : { "type" : "string", "example" : "string", "xml" : { "name" : "matchType", "attribute" : true } }, "title" : { "type" : "string", "example" : "Customer Record", "xml" : { "name" : "title", "attribute" : true } } }, "xml" : { "name" : "StagedEntity" } } }, "stagingAreaSummary" : { "title" : "StagingAreaSummary", "type" : "object", "properties" : { "entityResultSummary" : { "type" : "array", "xml" : { "name" : "entityResultSummary" }, "items" : { "title" : "EntityResultSummary", "type" : "object", "properties" : { "name" : { "type" : "string", "example" : "Sample Name", "xml" : { "name" : "name", "attribute" : true } }, "count" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "count", "attribute" : true } } }, "xml" : { "name" : "entityResultSummary" } } } }, "xml" : { "name" : "StagingAreaSummary" } }, "resultCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "resultCount", "attribute" : true } }, "totalCount" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "totalCount", "attribute" : true } }, "titleFieldName" : { "type" : "string", "example" : "Customer Record", "xml" : { "name" : "titleFieldName", "attribute" : true } } }, "xml" : { "name" : "StagingQueryResponse" } }, "StagingQueryRequest" : { "title" : "StagingQueryRequest", "type" : "object", "properties" : { "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "stagingAreaId" : { "type" : "string", "example" : "12345", "xml" : { "name" : "stagingAreaId" } }, "filter" : { "title" : "StagedEntityFilter", "type" : "object", "properties" : { "createdDate" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "createdDate" } }, "createDateRelative" : { "title" : "RelativeTimePeriod", "type" : "object", "xml" : { "name" : "createDateRelative" } }, "sourceEntityIds" : { "title" : "SourceEntityIds", "type" : "object", "properties" : { }, "xml" : { "name" : "sourceEntityIds" } }, "states" : { "type" : "array", "xml" : { "name" : "state" }, "items" : { "type" : "string", "example" : "string", "xml" : { "name" : "state" } } }, "op" : { "type" : "string", "example" : "AND", "xml" : { "name" : "op", "attribute" : true }, "default" : "AND", "enum" : [ "AND", "OR" ] } }, "xml" : { "name" : "filter" } }, "offsetToken" : { "type" : "string", "example" : "MjAw", "xml" : { "name" : "offsetToken", "attribute" : true } }, "limit" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "limit", "attribute" : true } } }, "xml" : { "name" : "StagingQueryRequest" } }, "TransactionQueryResponse" : { "title" : "TransactionQueryResponse", "type" : "object", "properties" : { "transactions" : { "type" : "array", "xml" : { "name" : "Transaction" }, "items" : { "title" : "Transaction", "type" : "object", "properties" : { "events" : { "type" : "array", "xml" : { "name" : "event" }, "items" : { "title" : "TransactionEvent", "type" : "object", "properties" : { "user" : { "type" : "string", "example" : "string", "xml" : { "name" : "user" } }, "data1" : { "type" : "string", "example" : "string", "xml" : { "name" : "data1" } }, "data2" : { "type" : "string", "example" : "string", "xml" : { "name" : "data2" } }, "eventDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "eventDate", "attribute" : true } }, "eventType" : { "title" : "TransactionEventType", "type" : "object", "xml" : { "name" : "eventType", "attribute" : true } } }, "xml" : { "name" : "event" } } }, "id" : { "type" : "string", "example" : "12345", "xml" : { "name" : "id", "attribute" : true } }, "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId", "attribute" : true } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId", "attribute" : true } }, "startDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "startDate", "attribute" : true } }, "endDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "endDate", "attribute" : true } }, "state" : { "title" : "TransactionState", "type" : "object", "xml" : { "name" : "state", "attribute" : true } }, "stateDetail" : { "type" : "string", "example" : "string", "xml" : { "name" : "stateDetail", "attribute" : true } } }, "xml" : { "name" : "Transaction" } } }, "resultCount" : { "type" : "integer", "format" : "int32", "example" : 5, "xml" : { "name" : "resultCount", "attribute" : true } }, "totalCount" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "totalCount", "attribute" : true } } }, "xml" : { "name" : "TransactionQueryResponse" } }, "QuarantineQueryRequest" : { "title" : "QuarantineQueryRequest", "type" : "object", "properties" : { "filter" : { "title" : "QuarantineQueryFilter", "type" : "object", "properties" : { "createdDate" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "createdDate" } }, "endDate" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "endDate" } }, "sourceEntityId" : { "type" : "string", "example" : "6f78f990-dbb9-4d97-94ff-64f7d31bc66f", "xml" : { "name" : "sourceEntityId" } }, "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "causes" : { "type" : "array", "xml" : { "name" : "cause" }, "items" : { "type" : "string", "example" : "string", "xml" : { "name" : "cause" } } }, "resolutions" : { "type" : "array", "xml" : { "name" : "resolution" }, "items" : { "type" : "string", "example" : "string", "xml" : { "name" : "resolution" } } }, "fields" : { "type" : "array", "xml" : { "name" : "field" }, "items" : { "title" : "FilterField", "type" : "object", "properties" : { "value" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value", "attribute" : true } } }, "xml" : { "name" : "field" } } }, "op" : { "type" : "string", "example" : "AND", "xml" : { "name" : "op", "attribute" : true }, "default" : "AND", "enum" : [ "AND", "OR" ] } }, "xml" : { "name" : "filter" } }, "offsetToken" : { "type" : "string", "example" : "MjAw", "xml" : { "name" : "offsetToken", "attribute" : true } }, "limit" : { "type" : "integer", "format" : "int32", "example" : 100, "xml" : { "name" : "limit", "attribute" : true } }, "includeData" : { "type" : "boolean", "xml" : { "name" : "includeData", "attribute" : true } }, "type" : { "title" : "ApiQuarantineType", "type" : "object", "xml" : { "name" : "type", "attribute" : true } } }, "xml" : { "name" : "QuarantineQueryRequest" } }, "RecordEndDateResponse" : { "title" : "RecordEndDateResponse", "type" : "object", "properties" : { "result" : { "type" : "array", "xml" : { "name" : "result" }, "items" : { "title" : "Result", "type" : "object", "properties" : { "recordId" : { "type" : "string", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "name" : "recordId" } }, "success" : { "type" : "boolean", "xml" : { "name" : "success" } }, "message" : { "type" : "string", "example" : "Message element will appear only if the success is false", "xml" : { "name" : "message" } } }, "xml" : { "name" : "result" } } } }, "xml" : { "name" : "RecordEndDateResponse" } }, "RecordSourceUpdateRequest" : { "title" : "RecordSourceUpdateRequest", "type" : "object", "properties" : { "recordId" : { "type" : "array", "xml" : { "name" : "recordId" }, "items" : { "type" : "string", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "name" : "recordId" } } }, "filter" : { "title" : "RecordQueryFilter", "type" : "object", "properties" : { "createdDate" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "createdDate" } }, "updatedDate" : { "title" : "DateRange", "type" : "object", "properties" : { "from" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "from" } }, "to" : { "type" : "string", "example" : "2023-12-31T23:59:59Z", "xml" : { "name" : "to" } } }, "xml" : { "name" : "updatedDate" } }, "fieldValue" : { "type" : "array", "xml" : { "name" : "fieldValue" }, "items" : { "title" : "FieldValueCondition", "type" : "object", "properties" : { "fieldId" : { "type" : "string", "example" : "FIRST_NAME", "xml" : { "name" : "fieldId" } }, "operator" : { "type" : "string", "example" : "EQUALS", "xml" : { "name" : "operator" } }, "value" : { "type" : "array", "xml" : { "name" : "value" }, "items" : { "type" : "string", "example" : "Sample Value", "xml" : { "name" : "value" } } } }, "xml" : { "name" : "fieldValue" } } }, "sourceLink" : { "title" : "SourceLinkCondition", "type" : "object", "properties" : { "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "linkType" : { "type" : "string", "example" : "LINKED", "xml" : { "name" : "linkType" } } }, "xml" : { "name" : "sourceLink" } }, "creatingSourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "creatingSourceId" } }, "tags" : { "title" : "Tags", "type" : "object", "properties" : { "tagName" : { "type" : "array", "xml" : { "name" : "tagName" }, "items" : { "type" : "string", "example" : "VIP_CUSTOMER", "xml" : { "name" : "tagName" } } } }, "xml" : { "name" : "tags" } }, "unresolvedReference" : { "title" : "UnresolvedReferencesCondition", "type" : "object", "properties" : { "sourceId" : { "type" : "string", "example" : "SFDC", "xml" : { "name" : "sourceId" } }, "fieldId" : { "type" : "string", "example" : "FIRST_NAME", "xml" : { "name" : "fieldId" } } }, "xml" : { "name" : "unresolvedReference" } }, "recordIds" : { "title" : "RecordIds", "type" : "object", "properties" : { "recordId" : { "type" : "array", "xml" : { "name" : "recordId" }, "items" : { "type" : "string", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "name" : "recordId" } } } }, "xml" : { "name" : "recordIds" } }, "queryString" : { "type" : "string", "example" : "FIRST_NAME:John AND STATUS:ACTIVE", "xml" : { "name" : "queryString" } }, "op" : { "type" : "string", "example" : "AND", "xml" : { "name" : "op", "attribute" : true }, "default" : "AND", "enum" : [ "AND", "OR" ] } }, "xml" : { "name" : "filter" } }, "recordStatus" : { "title" : "RecordStatus", "type" : "object", "xml" : { "name" : "recordStatus", "attribute" : true } } }, "xml" : { "name" : "RecordSourceUpdateRequest" } }, "MatchResolveResponse" : { "title" : "MatchResolveResponse", "type" : "object", "xml" : { "name" : "MatchResolveResponse" } }, "ChannelUpdatesStatus" : { "title" : "ChannelUpdatesStatus", "type" : "object", "properties" : { "startDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "startDate" } }, "endDate" : { "type" : "string", "example" : "2023-01-01T00:00:00Z", "xml" : { "name" : "endDate" } }, "status" : { "type" : "string", "example" : "ACTIVE", "xml" : { "name" : "status" } }, "erroredUpdates" : { "title" : "RecordIds", "type" : "object", "properties" : { "recordId" : { "type" : "array", "xml" : { "name" : "recordId" }, "items" : { "type" : "string", "example" : "0fc4eb6d-f12c-4cdd-ba37-5475caed4887", "xml" : { "name" : "recordId" } } } }, "xml" : { "name" : "erroredUpdates" } }, "totalCount" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "totalCount", "attribute" : true } }, "successCount" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "successCount", "attribute" : true } }, "errorCount" : { "type" : "integer", "format" : "int64", "example" : 1000, "xml" : { "name" : "errorCount", "attribute" : true } } }, "xml" : { "name" : "ChannelUpdatesStatus" } }, "MatchEntitiesResponse" : { "title" : "MatchEntitiesResponse", "type" : "object", "properties" : { "matchResults" : { "type" : "array", "xml" : { "name" : "MatchResult" }, "items" : { "title" : "MatchResult", "type" : "object", "xml" : { "name" : "MatchResult" } } } }, "xml" : { "name" : "MatchEntitiesResponse" } }, "OutboundActivityRequest" : { "title" : "OutboundActivityRequest", "type" : "object", "properties" : { "queryType" : { "title" : "ChannelQueryType", "type" : "object", "xml" : { "name" : "queryType" } }, "filter" : { "title" : "OutboundActivityFilter", "type" : "object", "properties" : { "opType" : { "type" : "string", "example" : "CREATE", "xml" : { "name" : "opType" } } }, "xml" : { "name" : "filter" } }, "sortBy" : { "type" : "string", "example" : "createdDate", "xml" : { "name" : "sortBy", "attribute" : true } }, "sortAsc" : { "type" : "boolean", "xml" : { "name" : "sortAsc", "attribute" : true } } }, "xml" : { "name" : "OutboundActivityRequest" } }, "QuarantineRestoreResponse" : { "title" : "QuarantineRestoreResponse", "type" : "object", "xml" : { "name" : "QuarantineRestoreResponse" } } }, "securitySchemes" : { "basicAuth" : { "type" : "http", "description" : "Basic Authentication using username and password.", "scheme" : "basic" }, "bearerAuth" : { "type" : "http", "description" : "JWT Bearer token authentication.", "scheme" : "bearer", "bearerFormat" : "JWT" }, "mdmEntitlement (RECORD_VIEW)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (QUARANTINE_VIEW)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (QUARANTINE_DELETE)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (QUARANTINE_REJECT)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (QUARANTINE_MATCH)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (RECORD_RESTORE)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (RECORD_DELETE)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (RECORD_ENDDATE)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (RECORD_EDIT)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (STAGING_VIEW)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (STAGING_REPLAY)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (STAGING_COMMIT)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" }, "mdmEntitlement (STAGING_DELETE)" : { "type" : "apiKey", "description" : "Required header. Set the value to the action entitlement required for this operation.", "name" : "X-MDM-Entitlement", "in" : "header" } } } }