Skip to main content
Feedback

Purge Single Golden Record

The Purge Single Golden Record operation purges (permanently deletes) a specified end-dated golden record. End-dated records are records marked as inactive for review before they are permanently deleted since you can restore an end-date record to active status.

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/<recordID>/purge

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/<recordID>/purge?repositoryId=<repository ID>

You must have the following MDM privileges:

  • With the Advanced Security feature on your account:

    • MDM - Stewardship with the Purge 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 Integration processes using the HTTP Client connector, as demonstrated by example 1 in the sample process Hub: Purge Golden Record, which you can install in your account from the process library in Integration.

Path parameters

universeID
ID of the universe

recordID
ID of the golden record

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) In the response body, the root element is <RecordPurgeResponse>. That element contains a <result> element.

    In the <result> element, recordID specifies the recordID parameter value and <success> indicates whether a purge operation on an end-dated golden record with that ID was successful.

    • If <success> contains true, it purged the end-dated golden record with the specified ID. Sample response body:

      <RecordPurgeResponse>
        <result>
          <recordId>f9acda54-8d89-425c-8f05-b22b82f2a641</recordId>
          <success>true</success>
        </result>    
      </RecordPurgeResponse>

    • If <success> contains false, it did not purge an end-dated golden record with the specified ID. An additional element, <message>, indicates the reason the operation was unsuccessful. Failure occurs in the following cases:

      • An end-dated golden record with the specified ID does not exist. Sample response body:

        <RecordPurgeResponse>
          <result>
            <recordId>5076fa51-e045-4557-a7b3-894c3b274fb4</recordId>
            <success>false</success>
            <message>A record with id '5076fa51-e045-4557-a7b3-894c3b274fb4' does 
            not exist.</message>
          </result>
        </RecordPurgeResponse>

      • A golden record with the specified ID is active. Sample response body:

        <RecordPurgeResponse>
          <result>
            <recordId>1cdf15e0-91c3-4082-b6b1-90823a59ef9b</recordId>
            <success>false</success>
            <message>The selected record with ID '1cdf15e0-91c3-4082-b6b1-90823a59ef9b' 
            is active and therefore cannot be purged.</message>
          </result>
        </RecordPurgeResponse>

  • 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) The recordID parameter value contains only space characters. Sample response body:

    <error>
      <message>The given record id is blank.</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>

  • 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