After signing in, you can create credentials that can be used to call the Platform APIs.
Download OpenAPI specification:Download
Use the several endpoints provided by The Dataset Service API to manage data usage labels for existing datasets within the Data Lake. Data usage labels are part of Adobe Experience Platform Data Governance, which allows you to manage customer data and ensure compliance with regulations, restrictions, and policies applicable to data use. Dataset Service is separate from Catalog Service, which manages other dataset metadata.
Related documentation:
Visualize API calls with Postman (a free, third-party software):
API paths:
Required headers:
Authorization, x-gw-ims-org-id, and x-api-key. For more information on how to obtain these values, see the authentication tutorial.x-sandbox-name whose value is the all-lowercase name of the sandbox the operation will take place in (for example, "prod"). See the sandboxes overview for more information.Content-Type with a value of application/json.API error handling:
You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your authentication credentials and use the Try it functionality in the right rail. Note that by using this functionality, you are making real API calls. Keep this in mind when you interact with production sandboxes.
A dataset is a storage and management construct for a collection of data, typically a table, that contains a schema (columns) and fields (rows). Data usage labels can be applied to entire datasets or individual fields within those datasets in order to enforce usage restrictions.
You can use this endpoint to retrieve data usage labels for a specified dataset.
NOTE: See the tutorial on managing labels for datasets using APIs for more information on using this endpoint.
| DATASET_ID required | string The ID of an existing dataset. Dataset IDs can be retrieved using the Catalog Service API. |
| Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial. |
| x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial. |
| x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial. |
| x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Data usage labels retrieved
Labels entity not found
{- "labels": [
- ""
], - "optionalLabels": [
- {
- "option": {
- "contentType": "application/vnd.adobe.xed-full+json;version=1",
- "schemaPath": "/properties/repositoryCreatedBy"
}, - "labels": [
- ""
]
}
]
}You can use this endpoint to update the data usage labels for a specified dataset or fields.
NOTE: You can entirely remove a dataset's labels by providing an empty list for the
labelsparameter. It is not mandatory for a dataset to retain any labels. See the tutorial on managing labels for datasets using APIs for more information on using this endpoint.
| DATASET_ID required | string The ID of an existing dataset. Dataset IDs can be retrieved using the Catalog Service API. |
| Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial. |
| x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial. |
| x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial. |
| x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
| Content-Type required | string The media type being sent in the request payload. The required value for calls to the Dataset Service API is |
| If-Match required | string The version of the dataset entity to compare against. As a requirement for all PUT and DELETE requests for dataset labels, the call will only update the dataset entity if the "If-Match" string matches that of the "etag" header that is returned in all responses from the Dataset Service API. |
Data usage labels updated
Labels entity not found
Data usage policy violation
{- "labels": [
- ""
], - "optionalLabels": [
- {
- "option": {
- "contentType": "application/vnd.adobe.xed-full+json;version=1",
- "schemaPath": "/properties/repositoryCreatedBy"
}, - "labels": [
- ""
]
}
]
}You can use this endpoint to add data usage labels to a specified dataset or fields.
NOTE: See the tutorial on managing labels for datasets using APIs for more information on using this endpoint.
| DATASET_ID required | string The ID of an existing dataset. Dataset IDs can be retrieved using the Catalog Service API. |
| Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial. |
| x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial. |
| x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial. |
| x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
| Content-Type required | string The media type being sent in the request payload. The required value for calls to the Dataset Service API is |
Data usage labels added
Labels entity already exists
Data usage policy violation
{- "labels": [
- ""
], - "optionalLabels": [
- {
- "option": {
- "contentType": "application/vnd.adobe.xed-full+json;version=1",
- "schemaPath": "/properties/repositoryCreatedBy"
}, - "labels": [
- ""
]
}
]
}