API Reference > Manage data access assets > Data de-identification API
  

Data de-identification API

Use the data de-identification API to create, update, delete, or retrieve data de-identification policies and data de-identification rules.
Data de-identification policies transform data in ways that you specify to de-identify sensitive data. Data de-identification policies can tokenize data to maintain the original format, generalize dates to a common year or month, or truncate data to keep only minimal contents visible. These de-identifications protect the data and make the data useful for analysis.
For more information on data de-identification rules, see Creating data de-identification rules in the Data Governance and Catalog help.

Retrieve data de-identification assets

Send a GET request to retrieve the details of data de-identification policies and data de-identification rules. The prefix, indicated by <prefix>, for each endpoint is /data360/dam/api/v1/.

Methods and endpoints

The following table describes retrieval methods and associated endpoints for the data de-identification API:
Method
Endpoint
Description
GET
<baseApiUrl><prefix>/data-deidentifications
Retrieve the list of all published data de-identification policies.
GET
<baseApiUrl><prefix>/data-deidentifications/{ID}
Retrieve the draft or published version of a specified data de-identification policy.

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 data de-identification policy. When using the <baseApiUrl><prefix>/data-deidentifications/{ID} endpoint, use fetchDraft=true.The default value is false.
Note:
To retrieve the draft version of all data de-identification policies, see Retrieve assets in the catalog.

Create data de-identification assets

Send a POST request to create data de-identification policies. The prefix, indicated by <prefix>, for each endpoint is /data360/dam/api/v1/.

Method and endpoint

The following table describes the creation method and associated endpoint for the data de-identification API:
Method
Endpoint
Description
POST
<baseApiUrl><prefix>/data-deidentifications
Create new data de-identification policies.

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.
enabled
Boolean
Optional. Specify the status of the asset: true|false.
effectiveDate
String
Optional. Specify the start date of the asset in the format yyyy-mm-dd.
endDate
String
Optional. Specify the end date of the asset in the format yyyy-mm-dd.
precedenceTier
Reference
Required. Specify the internal ID of the precedence tier in which to create the policy.
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.
dataDeIdentificationRules
Object
Optional. Define one or more data de-identification rules.
ruleName: String. Name of the rule.
ruleDescription: String. Description of the rule.
enabled: Boolean. Status of the rule.
rank: Integer. Ranking of the rule within the policy.
condition: Object. Set of conditions for the rule.
fieldLevelProtections: Object. The list of data protections to apply to a data element classification.
cellLevelProtections: Object. The cell-level condition and list of protections to apply to a data element classification.

Request body

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

"name": "Data Privacy Protection Policy",

"description": "General usage data privacy policy.",

"externalId": "Data Privacy Protection Policy",

"effectiveDate": "2000-01-01",

"enabled": true,

"precedenceTier": "95b3021d-3945-4de5-bc7e-30cc3c94cbb3",

"dataDeIdentificationRules": [

{

"ruleName": "Data Privacy Protection Rule",

"ruleDescription": "General data privacy enforcements.",

"enabled": true,

"rank": 1,

"condition": { "dialect": "structured-predicate",

"version": "1.0",

"predicate": { "and": [ { "isAnyOf": [ {

"path": "context::request.usage"

}, { "constant": "{{Data-Access-Management}}" } ] }

] } },

"fieldLevelProtections": [ {

"dataProtectionInternalId": "",

"fieldLocatorQuery": { "dialect": "basic-object-locator",

"query": {

"path": "cdgc::dataelement.classifications[*].id",

"value": "{{DAM - Customer Number}}"

}, "version": "1.0" } } ],

"cellLevelProtections": [ { "fieldValuePredicate": {

"dialect": "structured-predicate",

"version": "1.0",

"predicate": { "or": [ { "isNotNull": [ {

"fieldValue": { "fieldLocatorQuery": {"dialect": "basic-object-locator", "version": "1.0", "query": {

"path": "cdgc::dataelement.classifications[*].id",

"value": "{{DAM - Customer Status}}" } }, "type": "STRING"

} } ] } ] } }, "fieldProtections": [ {

"dataProtectionInternalId": "",

"fieldLocatorQuery": { "dialect": "basic-object-locator", "query": {"path": "cdgc::dataelement.classifications[*].id", "value": "{{DAM - Customer Status}}" }, "version": "1.0" } } ] }

} ] }

]

}

Modify data de-identification assets

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

Methods and endpoints

The following table describes modification methods and associated endpoints for the data de-identification API:
Method
Endpoint
Description
PUT
<baseApiUrl><prefix>/data-deidentifications/{ID}
Replace a specified data de-identification policy.
PATCH
<baseApiUrl><prefix>/data-deidentifications/{ID}
Modify the details of a specified data de-identification policy.

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.
enabled
Boolean
Optional. Specify the status of the asset: true|false.
effectiveDate
String
Optional. Specify the start date of the asset in the format yyyy-mm-dd.
endDate
String
Optional. Specify the end date of the asset in the format yyyy-mm-dd.
precedenceTier
Reference
Required. Specify the internal ID of the precedence tier in which to create the policy.
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.
dataDeIdentificationRules
Object
Optional. Define one or more data de-identification rules.
ruleName: String. Name of the rule.
ruleDescription: String. Description of the rule.
enabled: Boolean. Status of the rule.
rank: Integer. Ranking of the rule within the policy.
condition: Object. Set of conditions for the rule.
fieldLevelProtections: Object. The list of data protections to apply to a data element classification.
cellLevelProtections: Object. The cell-level condition and list of protections to apply to a data element classification.

Request body

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

"description": "General usage data privacy policy. [Updated]",

"precedenceTier": "95b3021d-3945-4de5-bc7e-30cc3c94cbb3"

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

Delete data de-identification assets

Send a DELETE request to delete a data de-identification policy. The prefix, indicated by <prefix>, for each endpoint is /data360/dam/api/v1/.

Method and endpoint

The following table describes the deletion method and associated endpoint for the data de-identification API:
Method
Endpoint
Description
DELETE
<baseApiUrl><prefix>/data-deidentifications/{ID}
Delete a specified data de-identification policy.

Request body

This endpoint has no request body.