Skip to main content
Feedback

Approve Quarantined Entity for Transaction

The Approve Quarantined Entity for Transaction operation approves the quarantined entity associated with a specified transaction from a specified universe (domain) hosted in a specified repository under limited account access to the authenticating user, provided the user is entitled to approve the entity.

note

Retrieval of the associated quarantine entry is subject to access restrictions imposed by the authenticating user’s tag-based entitlements.

To perform this operation, send an HTTP POST request to

https://api.boomi.com/mdm/api/rest/v1/<accountID>/repositories/<repositoryID>/universes/<universeID>/quarantine/<transactionID>/approve

note

This operation requires the authenticating user to have the API Access privilege and the Approve Creates and Approve Updates entitlements.

You can implement requests for this operation in processes using the HTTP Client connector, as demonstrated by example 2 in the sample process Hub: Approve Quarantined Entities, which you can install in your account from the process library i Integration.

Path parameters

accountID
ID of the account

repositoryID
ID of the repository

universeID
ID of the universe

transactionID ID of the transaction, which you can obtain from a Query Quarantine Entries operation.

Responses

  • 200 (OK) The body of the response is XML. The root element is <mdm:ApproveResponse>. Within that element <mdm:success>contains a Boolean value indicating the deletion of the retrieved quarantine entry — true for success. For a successful deletion, the <mdm:transaction> element indicates the subsequect creation, updating, or end-dating of a golden record or the creation of a quarantine entry.

    Sample response body for creation of a golden record:

    <mdm:ApproveResponse xmlns:mdm="http://mdm.api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <mdm:success>true</mdm:success>
      <mdm:transaction stateDetail="CREATED" state="COMPLETED" updatedDate="2016-12-13T14:51:39.201Z" id="39cf510e-460b-4857-b615-70b63844e84e"/>
    </mdm:ApproveResponse>

    Sample response body for updating of a golden record:

    <mdm:ApproveResponse xmlns:mdm="http://mdm.api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <mdm:success>true</mdm:success>
      <mdm:transaction stateDetail="UPDATE" state="COMPLETED" updatedDate="2017-02-03T04:15:24.819Z" id="85c6b81f-71a4-46d5-879a-08db316479f9"/>
    </mdm:ApproveResponse>

    Sample response body for end-dating of a golden record:

    <mdm:ApproveResponse xmlns:mdm="http://mdm.api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <mdm:success>true</mdm:success>
      <mdm:transaction stateDetail="DELETE" state="COMPLETED" updatedDate="2017-02-03T04:15:24.819Z" id="85c6b81f-71a4-46d5-879a-08db316479f9"/>
    </mdm:ApproveResponse>

    Sample response body for creation of a quarantine entry:

    <mdm:ApproveResponse xmlns:mdm="http://mdm.api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <mdm:success>true</mdm:success>
      <mdm:transaction id="6dcec710-63f9-48db-9b1b-0409237b6858" updatedDate="2016-12-08T18:39:25.178Z" state="QUARANTINED" stateDetail="INCORPORATE_ERROR"/>
    </mdm:ApproveResponse>

  • 400 (Bad Request) The authenticating user does not have the API Access privilege and the Approve Creates and Approve Updates entitlements required for this operation. Sample response body:

    <error>
      <message>The authenticated user does not have access rights to this functionality</message>
    </error>

  • 400 (Bad Request) The universeID parameter value contains only space characters. Sample response body:

    <error>
      <message>The given universe id is blank.</message>
    </error>

  • 400 (Bad Request) repositoryID does not identify a repository under the specified account. Sample response body:

    <error>
      <message>Could not find containerAccount for container id 
        dbe797ff-6d6f-44e9-acd9-d77494a44b15 and account id account-123456</message>
    </error>

  • 403 (Forbidden) Authentication failure. Sample response body:

    <UserMessage id="error.user.login" type="error">
      <Data>Incorrect user name and password combination.</Data>
    </UserMessage>

  • 403 (Forbidden) One or more path parameter values are omitted. Sample response body:

    <UserMessage id="error.user.login" type="error">
      <Data>Incorrect user name and password combination.</Data>
    </UserMessage>

  • 403 (Forbidden) accountID does not identify an account accessible to the authenticating user. Sample response body:

    <UserMessage id="error.user.login" type="error">
      <Data>Incorrect user name and password combination.</Data>
    </UserMessage>

  • 404 (Not Found) universeID does not identify a universe hosted in the specified repository. Sample response body:

    <error>
      <message>A universe with id 'ac11cc59-c77a-4afe-8c92-ed86a7daabec' does not exist.</message>
    </error>

  • 404 (Not Found) transactionID does not identify a quarantine entry in the specified universe. Sample response body:

  • <error>
      <message>A quarantined entity version with id '42dbadd8-d226-4c4d-abe3-1dae8636e77a' does not exist.</message>
    </error>
On this Page