API Reference > Manage data access assets > Precedence tier API
  

Precedence tier API

Use the precedence tier API to create, update, delete, or retrieve precedence tiers.
Precedence tiers are ordered groupings of data de-identification policies that determine the priority and sequence of data de-identification policies and data protections. You assign data de-identification policies to a precedence tier.
For more information on precedence tiers, see Creating precedence tiers in the Data Governance and Catalog help.

Retrieve precedence tier assets

Send a GET request to retrieve the details of precedence tiers. The prefix, indicated by <prefix>, for each endpoint is /data360/dam/api/v1/.

Endpoints

The following table describes methods and endpoints for the precedence tier API:
Method
Endpoint
Description
GET
<baseApiUrl><prefix>/precedence-tiers
Retrieve the list of all published precedence tiers.
GET
<baseApiUrl><prefix>/precedence-tiers/{ID}
Retrieve the draft or published version of a specified precedence tier.

Request parameters

The following table describes the parameters that you can specify in the endpoint of the request:
Parameter
Type
Description
offset
Integer
Optional. Specify the record number from which to begin returning assets. The default value is zero.
limit
Integer
Optional. Specify the total number of records to return. The default value is 500.
fetchDraft
Boolean
Optional. Retrieve the draft version of a specified precedence tier. When using the <baseApiUrl><prefix>/precedence-tiers/{ID} endpoint, use fetchDraft=true.The default value is false.
Note:
To retrieve the draft version of all precedence tiers, see Retrieve assets in the catalog.

Create precedence tier assets

Send a POST request to create precedence tiers. The prefix, indicated by <prefix>, for each endpoint is /data360/dam/api/v1/.

Endpoints

The following table describes method and endpoint for the precedence tier API:
Method
Endpoint
Description
POST
<baseApiUrl><prefix>/precedence-tiers
Create new precedence tiers.

Request parameters

The following table describes the parameters that you can specify in the endpoint of the request:
Parameter
Type
Description
name
String
Required. Specify the name of the asset.
externalId
String
Optional. Specify the external identifier of the asset.
description
String
Optional. Specify the description of the asset.
rank
Integer
Required. Specify the rank of the asset. An error occurs if an asset exists with the same rank.
stakeholders
Object
Optional. Specify the following attributes to add a stakeholder to the asset.
stakeholderId: The internal ID of the stakeholder. You can find this ID by looking at the URL of the stakeholder page in Data Governance and Catalog.
roleId: The internal ID of the role for the stakeholder. You can find this ID in the role details in Administrator. Navigate to the User Roles page, open the user role, and copy the ID at the end of the URL.
stakeholderType: Specify whether the stakeholder is a USER or GROUP.

Request body

In the body of the request, specify the parameters in the following format:
{

"name": "Precedence Tier Unit 1",

"externalId": "Precedence Tier Unit 1",

"description": "Precedence Tier for policies in unit #1",

"rank": 5000,

"stakeholders": [

{

"stakeholderId":"9p5CFWeemQXfj5IOg2C6Io",

"roleId": "9SKimMiBWHvendjzxdP6iv",

"stakeholderType": "USER"

}

]

}

Modify precedence tier assets

Send a PUT request to replace a specific precedence tier. Send a PATCH request to modify the details of a specific precedence tier. The prefix, indicated by <prefix>, for each endpoint is /data360/dam/api/v1/.

Endpoints

The following table describes methods and endpoints for the precedence tier API:
Method
Endpoint
Description
PUT
<baseApiUrl><prefix>/precedence-tiers/{ID}
Replace a specified precedence tier.
PATCH
<baseApiUrl><prefix>/precedence-tiers/{ID}
Modify the details of a specified precedence tier.

Request parameters

The following table describes the parameters that you can specify in the endpoint of the request:
Parameter
Type
Description
name
String
Required. Specify the name of the asset.
externalId
String
Optional. Specify the external identifier of the asset.
description
String
Optional. Specify the description of the asset.
rank
Integer
Required. Specify the rank of the asset. An error occurs if an asset exists with the same rank.
stakeholders
Object
Optional. Specify the following attributes to add a stakeholder to the asset.
stakeholderId: The internal ID of the stakeholder. You can find this ID by looking at the URL of the stakeholder page in Data Governance and Catalog.
roleId: The internal ID of the role for the stakeholder. You can find this ID in the role details in Administrator. Navigate to the User Roles page, open the user role, and copy the ID at the end of the URL.
stakeholderType: Specify whether the stakeholder is a USER or GROUP.

Request body for the PATCH method

In the body of the request, specify the parameters in the following format:
{

"description": "Precedence Tier, updated description",

"rank": 5001

}
This example request body uses the PATCH method to modify only the precedence tier's description and rank.

Delete precedence tier assets

Send a DELETE request to delete a precedence tier. The prefix, indicated by <prefix>, for each endpoint is /data360/dam/api/v1/.

Endpoints

The following table describes method and endpoint for the precedence tier API:
Method
Endpoint
Description
DELETE
<baseApiUrl><prefix>/precedence-tiers/{ID}
Delete a specified precedence tier.

Request body

This endpoint has no request body.