Skip to main content
Feedback

Restore End-dated Golden Record for Source Entity

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.

If 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.

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.

Basic authentication

To perform this operation using Basic auth, send an HTTP POST request with an empty request body to:

https://<base URL>/mdm/universes/<universeID>/records/sources/<sourceID>/entities/<entityID>/restore

where base URL is the URL for your Hub cloud that hosts your repository.

JWT authentication

To perform this operation using JSON Web Token (JWT) auth, send an HTTP POST request with an empty request body to:

https://<base URL>/mdm/universes/<universeID>/records/sources/<sourceID>/entities/<entityID>/restore?repositoryId=<repository ID>

You must have the following MDM privileges:

  • With the Advanced Security feature on your account:

    • MDM - Stewardship with the Restore Records Hub role entitlement for the queried repository
      or
    • MDM - Stewardship Management

  • Without Advanced Security:

    • MDM - Stewardship
note

You can implement requests for this operation in processes using the HTTP Client connector, as demonstrated by example 1 in the sample process Hub: Restore End-dated Golden Record, which you can install in your account from the process library in Integration. The availability of sample processes in the Process Library varies by Platform region.

Path parameters

base URL
The base URL for your Platform instance.
api.boomi.com for North American Platform users
api.platform.gb.boomi.com for European Platform users

universeID
ID of the universe

sourceID
ID of the source

entityID
ID of the source entity. It must be URL encoded if it contains special characters.

Query parameters

repositoryId
ID of the repository. 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.

Responses

  • 200 (OK) Restored the golden record linked to the source entity. The response body is empty.

  • 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) A golden record in the specified universe is linked to the specified source entity, but the record is not end-dated. Sample response body:

    <error>
      <message>The record with id '1dc9f488-c1d3-4718-9a2c-79f5d6f8b4ea' is not end-dated.</message>
    </error>

  • 404 (Not Found) universeID does not identify a universe under the authenticated account. Sample response body:

    <error>
      <message>A universe with id 'ac11cc59-c77a-4afe-8c92-ed86a7daabec' does not exist.</message>
      <message>Universe definition with id 'ac11cc59-c77a-4afe-8c92-ed86a7daabec' could not be loaded from plugin component directory 'plugins/mdm/bundles/ac11cc59-c77a-4afe-8c92-ed86a7daabec'.</message>
    </error>

  • 404 (Not Found) sourceID does not identify a source attached to the specified universe. Sample response body:

    <error>
      <message>Source with code 'FOO' does not exist under universe '851a6a64-6a88-4916-a5b7-d6a974d54318'.</message>
    </error>

  • 404 (Not Found) sourceID and entityID do not identify a source entity to which a golden record in the universe is linked. Sample response body:

    <error>
       <message>The entity id '100' for source 'SF' does 
         not contribute to a golden record in universe '851a6a64-6a88-4916-a5b7-d6a974d54318'.</message>
    </error>

  • 401 (Invalid Credentials) JWT auth token is expired. Sample response body:

    <body>
    <h2>HTTP ERROR 401</h2>
       <p>Problem accessing /mdm/universes. Reason:
       <pre>Invalid credentials.</pre>
    </p>
    </body>

  • 403 (You do not have permissions to access this resource) User does not have the required MDM privilege to perform the action. Applicable to JWT auth only. Sample response body:

    <error><message>You do not have permissions to access this resource.</message></error>
On this Page