Get Credentials

Get credentials

After signing in, you can create credentials that can be used to call the Platform APIs.

Data Hygiene API (1.0.0)

Download OpenAPI specification:Download

Use the Data Hygiene REST API to schedule expiration dates for datasets and programmatically correct or delete stored customer personal data in Experience Platform.

(NEW) Interactive API documentation

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.

Quota

Use the /quota endpoint in the Data Hygiene API to monitor your Advanced data lifecycle management usage against your organization’s quota limits for each job type.

List your data hygiene quotas

You can use this endpoint to retrieve your data hygiene quotas. Quota type values include:

  • datasetExpirationQuota: This object shows the number of concurrently active dataset expirations for your organization, and your total allowance of expirations.
  • dailyConsumerDeleteIdentitiesQuota: This object shows the total number of record delete requests made by your organization today and your total daily allowance. Note: Only accepted requests are counted. If a workorder is rejected because it fails validation, those identity deletions do not count against your quota.
  • monthlyConsumerDeleteIdentitiesQuota: This object shows the total number of record delete requests made by your organization this month and your total monthly allowance.
  • monthlyUpdatedFieldIdentitiesQuota: This object shows the total number of record updates requests made by your organization this month and your total monthly allowance. Note: Only accepted requests are counted. If a workorder is rejected because it fails validation, those identity deletions do not count against your quota.
Request
query Parameters
quotaType
string

An optional query parameter that specifies the type of quota to retrieve. If no quotaType parameter is provided, all quota values are returned in the API response.

Enum: "datasetExpirationQuota" "dailyConsumerDeleteIdentitiesQuota" "monthlyConsumerDeleteIdentitiesQuota" "monthlyUpdatedFieldIdentitiesQuota"
header Parameters
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.

content-type
required
string

The type of content being sent in the body of the request. Should be 'application/json'.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/quota
Response samples
application/json
{
  • "quotas": [
    ]
}

Dataset Expiration

Use the /ttl endpoint to schedule expiration dates for datasets in Adobe Experience Platform.

List your dataset expirations

You can retrieve a list of your organization's dataset expirations by making a GET request to the /ttl endpoint. Query parameters can be used to filter the response to ensure the results are relevant and specific.

Request
query Parameters
author
string

Use the author query parameter to find the person who most recently updated the dataset expiration or workorder. If no updates have been made since its creation, this will match the original creator. This parameter matches entries where the created_by field corresponds to the search string. If the search string begins with LIKE or NOT LIKE, the remainder is treated as an SQL search pattern. Otherwise, the entire search string is treated as a literal string that must exactly match the entire content of a created_by field.

Example: author=author=LIKE %john%, author=John Q. Public
datasetId
string

Matches expirations that apply to specific dataset.

Example: datasetId=datasetId=62b3925ff20f8e1b990a7434
datasetName
string

Matches expirations whose dataset name contains the provided search string. The match is case-insensitive.

Example: datasetName=Acme
description
string

A description of the purpose of the request.

Example: description=Handle expiration of Acme information through the end of 2024.
displayName
string

Matches the display name provided in the search string. The match is case-insensitive.

Example: displayName=License Expiry
expiryDate
string

Filters results to include records that have an expiration date matching the specified date. This parameter is used to retrieve data associated with a specific expiration date.

Example: expiryDate=2024-01-06
expiryToDate
string

Filters results to include records with expirations that are due to be executed or have already been executed up to the specified end date. It is used to match expirations within or before the given interval.

Example: expiryToDate=2099-01-01&expiryFromDate=2100-01-01
expiryFromDate
string

Filters results to include records with expirations that are due to be executed or have already been executed starting from the specified start date. It is used to match expirations within or after the given interval.

Example: expiryFromDate=2099-01-01&expiryToDate=2100-01-01
limit
integer [ 1 .. 100 ]
Default: 25

An integer between 1 and 100 indicates the maximum number of expirations to return. Defaults to 25.

Example: limit=50
orgId
string

Matches datasets expirations whose organization ID matches that of the parameter. This value defaults to that of the x-gw-ims-org-id header. This parameter is ignored unless a service token is supplied in the request.

Example: orgId=orgId=885737B25DC460C50A49411B@AdobeOrg
page
integer

An integer that indicates which page of expirations to return.

Example: page=3
sandboxName
string

Matches dataset expirations whose sandbox name exactly matches the argument. Defaults to the sandbox name in the request’s x-sandbox-name header. Use sandboxName=* to include dataset expirations from all sandboxes.

Example: sandboxName=dev1
search
string

Matches expirations where the specified string is an exact match for the expiration ID, or is contained in any of these fields: author, display name, description, display name, dataset name.

Example: search=John Q. Public
status
string

A comma-separated list of statuses. When included, the response matches dataset expirations whose current status is among those listed.

Example: status=pending,canceled
updatedDate
string

Filters results to include records that have been updated on the specified date. This parameter helps retrieve data associated with updates, including creation, cancellation, or execution.

Example: updatedDate=2022-01-01
updatedFromDate
string

Filters results to include records that have been updated from the specified date onwards. This parameter is used to fetch data associated with updates occurring after or on a specific date.

Example: updatedFromDate=2022-01-01
updatedToDate
string

Filters results to include records that have been updated up to and including the specified date. Useful for retrieving data updated before or on a certain date, encompassing all types of updates.

Example: updatedToDate=2022-01-01
header Parameters
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

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.

Accept
required
string

Specifies the media type that the client expects in the response. All GET requests must include this header with the value of application/json.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/ttl
Response samples
application/json
{
  • "results": [
    ],
  • "current_page": 0,
  • "total_pages": 6,
  • "total_count": 118
}

Create a dataset expiration

To schedule a new dataset expiration, make a POST request to the /ttl endpoint with the required values in the payload. Specify the dataset ID and the expiry date and time (in ISO 8601 format) to ensure data is removed from the system after the specified period.

Request
header Parameters
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.

Accept
required
string

Specifies the media type that the client expects in the response. All GET requests must include this header with the value of application/json.

Request Body schema: application/json
required

A JSON payload containing the details of the dataset expiration to be created.

datasetId
required
string

The ID of the dataset to be impacted.

expiry
required
string

The expiry date and time in ISO 8601 format. If the string has no explicit zone offset, UTC is used by default. This must be at least 24 hours in the future. A dataset expiration will be created with the specified timestamp.

displayName
string

The display name for the dataset expiration.

description
string

A description of the dataset expiration's purpose.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/ttl
Request samples
application/json
{
  • "datasetId": "5b020a27e7040801dedbf46e",
  • "expiry": "2030-12-31T23:59:59Z",
  • "displayName": "Delete Acme Data before 2025",
  • "description": "The Acme information in this dataset is licensed for our use through the end of 2024."
}
Response samples
application/json
{
  • "ttlId": "SD-42215a53-b79e-49bc-bd00-69f8a470329f",
  • "datasetId": "66043e214ac58a2c9f9eb99f",
  • "datasetName": "E2E_Dataset_E2E_Identity_Map_Schema_5_1711554081377",
  • "sandboxName": "sample-platform-sandbox",
  • "imsOrg": "FB3C3EC6621DC3480A495EB2@AdobeOrg",
  • "status": "executing",
  • "expiry": "2024-03-28T16:41:24.262521Z",
  • "updatedAt": "2024-03-28T16:41:32.549939Z",
  • "updatedBy": "c87fb98d-b537-4cb9-b1b0-9b74c8e30e2c@techacct.adobe.com <c87fb98d-b537-4cb9-b1b0-9b74c8e30e2c@techacct.adobe.com> C4A32114631F55D40A495CA7@techacct.adobe.com",
  • "displayName": "E2E_Short_Expiry_1711554084262",
  • "description": "E2E_Short_Expiry"
}

Retrieve a specific dataset expiration

Use this endpoint to retrieve the details of a specific dataset expiration by providing its expiration ID or dataset ID.

Request
path Parameters
ID
required
string

An ID to identify the dataset expiration to perform an action on. This can be either the dataset expiration ID or the dataset ID.

query Parameters
productStatusDetails
string

This parameter is only accepted when the expiration status is executing, or completed. Each element of the array contains a productName and a productStatus. Supported productStatus values include: success, failure, and waiting.

Enum: "Data Management" "Identity Service" "Profile Service" "Journey Orchestrator"
header Parameters
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.

Accept
required
string

Specifies the media type that the client expects in the response. All GET requests must include this header with the value of application/json.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/ttl/{ID}
Response samples
application/json
{
  • "ttlId": "SD-42215a53-b79e-49bc-bd00-69f8a470329f",
  • "datasetId": "66043e214ac58a2c9f9eb99f",
  • "datasetName": "E2E_Dataset_E2E_Identity_Map_Schema_5_1711554081377",
  • "sandboxName": "sample-platform-sandbox",
  • "imsOrg": "FB3C3EC6621DC3480A495EB2@AdobeOrg",
  • "status": "executing",
  • "expiry": "2024-03-28T16:41:24.262521Z",
  • "updatedAt": "2024-03-28T16:41:32.549939Z",
  • "updatedBy": "c87fb98d-b537-4cb9-b1b0-9b74c8e30e2c@techacct.adobe.com <c87fb98d-b537-4cb9-b1b0-9b74c8e30e2c@techacct.adobe.com> C4A32114631F55D40A495CA7@techacct.adobe.com",
  • "displayName": "E2E_Short_Expiry_1711554084262",
  • "description": "E2E_Short_Expiry",
  • "productStatusDetails": [
    ]
}

Update an existing dataset expiration

Update the displayName, description, and/or expiry of a dataset expiration. Note: If the expiry is changed it must be at least 24 hours in the future to avoid accidental deletions. This enforced delay provides an opportunity to cancel or re-schedule the dataset expiration.

Request
path Parameters
ID
required
string

An ID to identify the dataset expiration to perform an action on. This can be either the dataset expiration ID or the dataset ID.

header Parameters
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

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.

Request Body schema: application/json
required

A JSON payload containing the details used to update the dataset expiration.

expiry
required
string

The expiry date and time in ISO 8601 format. If the string has no explicit zone offset, UTC is used by default. This must be at least 24 hours in the future. A dataset expiration will be created with the specified timestamp.

displayName
string

The display name for the dataset expiration.

description
string

A description of the dataset expiration's purpose.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/ttl/{ID}
Request samples
application/json
{
  • "expiry": "2030-12-31T23:59:59Z",
  • "displayName": "Delete Acme Data before 2025",
  • "description": "The Acme information in this dataset is licensed for our use through the end of 2024."
}
Response samples
application/json
{
  • "ttlId": "SD-42215a53-b79e-49bc-bd00-69f8a470329f",
  • "datasetId": "66043e214ac58a2c9f9eb99f",
  • "datasetName": "E2E_Dataset_E2E_Identity_Map_Schema_5_1711554081377",
  • "sandboxName": "sample-platform-sandbox",
  • "imsOrg": "FB3C3EC6621DC3480A495EB2@AdobeOrg",
  • "status": "executing",
  • "expiry": "2024-03-28T16:41:24.262521Z",
  • "updatedAt": "2024-03-28T16:41:32.549939Z",
  • "updatedBy": "c87fb98d-b537-4cb9-b1b0-9b74c8e30e2c@techacct.adobe.com <c87fb98d-b537-4cb9-b1b0-9b74c8e30e2c@techacct.adobe.com> C4A32114631F55D40A495CA7@techacct.adobe.com",
  • "displayName": "E2E_Short_Expiry_1711554084262",
  • "description": "E2E_Short_Expiry"
}

Update the expiry of an existing dataset expiration

Use this endpoint to change the expiry date of an existing dataset expiration. This can be either the dataset expiration ID or the dataset

Request
path Parameters
ID
required
string

An ID to identify the dataset expiration to perform an action on. This can be either the dataset expiration ID or the dataset ID.

query Parameters
productStatusDetails
string

This parameter is only accepted when the expiration status is executing, or completed. Each element of the array contains a productName and a productStatus. Supported productStatus values include: success, failure, and waiting.

Enum: "Data Management" "Identity Service" "Profile Service" "Journey Orchestrator"
header Parameters
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

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.

Request Body schema: application/json
required

The request body to update the dataset expiration.

expiry
required
string

Use the PATCH method to change the change the dataset expiration date. The expiry date and time in ISO 8601 format. If the string has no explicit zone offset, UTC is used by default. This must be at least 24 hours in the future. A dataset expiration will be created with the specified timestamp.

Responses
200

The dataset expiration was updated successfully.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/ttl/{ID}
Request samples
application/json
{
  • "expiry": "2030-12-31T23:59:59Z"
}
Response samples
application/json
{
  • "ttlId": "SD-42215a53-b79e-49bc-bd00-69f8a470329f",
  • "datasetId": "66043e214ac58a2c9f9eb99f",
  • "datasetName": "E2E_Dataset_E2E_Identity_Map_Schema_5_1711554081377",
  • "sandboxName": "sample-platform-sandbox",
  • "imsOrg": "FB3C3EC6621DC3480A495EB2@AdobeOrg",
  • "status": "executing",
  • "expiry": "2024-03-28T16:41:24.262521Z",
  • "updatedAt": "2024-03-28T16:41:32.549939Z",
  • "updatedBy": "c87fb98d-b537-4cb9-b1b0-9b74c8e30e2c@techacct.adobe.com <c87fb98d-b537-4cb9-b1b0-9b74c8e30e2c@techacct.adobe.com> C4A32114631F55D40A495CA7@techacct.adobe.com",
  • "displayName": "E2E_Short_Expiry_1711554084262",
  • "description": "E2E_Short_Expiry",
  • "productStatusDetails": [
    ]
}

Cancel an existing dataset expiration

Use this endpoint to cancel an existing expiration for a dataset. This can be either the dataset expiration ID or the dataset

Request
path Parameters
ID
required
string

An ID to identify the dataset expiration to perform an action on. This can be either the dataset expiration ID or the dataset ID.

header Parameters
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

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.

Responses
200

The dataset expiration was successfully canceled.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

delete/ttl/{ID}
Response samples
application/json
{
  • "message": "The dataset was successfully canceled."
}

Record Delete

Use the /workorder endpoint in the Data Hygiene API to programmatically manage record delete requests in Adobe Experience Platform.

List workorders

You can retrieve a list of your organization's record delete requests by making a GET request to the /workorder endpoint.

Request
query Parameters
requestId
string

An optional workorder ID for a specific record delete request that you want to retrieve.

displayName
string

Matches the display name provided in the search string. The match is case-insensitive.

Example: displayName=License Expiry
description
string

A description of the purpose of the request.

Example: description=Handle expiration of Acme information through the end of 2024.
WORKORDER_ID
string

The ID of the deletion order. This can be used to look up the status of the deletion later.

Example: WORKORDER_ID=a15345b8-a2d6-4d6f-b33c-5b593e86439a
author
string

Use the author query parameter to find the person who most recently updated the dataset expiration or workorder. If no updates have been made since its creation, this will match the original creator. This parameter matches entries where the created_by field corresponds to the search string. If the search string begins with LIKE or NOT LIKE, the remainder is treated as an SQL search pattern. Otherwise, the entire search string is treated as a literal string that must exactly match the entire content of a created_by field.

Example: author=author=LIKE %john%, author=John Q. Public
status
string

A comma-separated list of statuses. When included, the response matches dataset expirations whose current status is among those listed.

Example: status=pending,canceled
page
integer

An integer that indicates which page of expirations to return.

Example: page=3
orderBy
string

The orderBy query parameter specifies the sorting order of the results returned by the API. Use it to arrange the data based on one or more fields, either in ascending (ASC) or descending (DESC) order. Use the + or - prefix to signify ASC, DESC respectively. The following values are accepted: displayName, description, datasetName, id, updatedBy, updatedAt, expiry, status.

Example: orderBy=-datasetName
toDate
string

This parameter specifies the end date of the date range. It allows the user to filter the work orders to include only those created on or before this date.

Example: toDate=2099-01-01&fromDate=2100-01-01
fromDate
string

This parameter specifies the start date of the date range. It allows the user to filter the work orders to include only those created on or after this date.

Example: fromDate=2099-01-01&toDate=2100-01-01
limit
integer [ 1 .. 100 ]
Default: 25

An integer between 1 and 100 indicates the maximum number of expirations to return. Defaults to 25.

Example: limit=50
filterDate
string

This parameter only returns the workorders that were created, updated, or have a particular status on that specific date. filterDate can be used with other query parameters to narrow down your search results and provide more specific and relevant information.

Example: filterDate=2024-06-12
header Parameters
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

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/workorder
Response samples
application/json
{
  • "workorderId": "a15345b8-a2d6-4d6f-b33c-5b593e86439a",
  • "orgId": "{ORG_ID}",
  • "bundleId": "BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd",
  • "action": "identity-delete",
  • "createdAt": "2022-07-21T18:05:28.316029Z",
  • "updatedAt": "2022-07-21T17:59:43.217801Z",
  • "status": "received",
  • "createdBy": "{USER_ID}",
  • "datasetId": "c48b51623ec641a2949d339bad69cb15",
  • "displayName": "Example Record Delete Request",
  • "description": "Cleanup identities required by Jira request 12345."
}

Create a workorder

You can delete one or more identities from a single dataset or all datasets by making a POST request to the /workorder endpoint.

Request
header Parameters
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

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.

content-type
required
string

The type of content being sent in the body of the request. Should be 'application/json'.

Request Body schema: application/json
action
required
string

The action to be performed. The value must be set to delete_identity for record deletes.

Enum: "delete_dataset" "delete_identity"
datasetId
required
string

If you are deleting from a single dataset, this value must be the ID of the dataset in question. If you are deleting from all datasets, set the value to ALL. If you are specifying a single dataset, the dataset’s associated Experience Data Model (XDM) schema must have a primary identity defined. If the dataset does not have a primary identity, then it must have an identity map in order to be modified by a Data Lifecycle request. If an identity map exists, it will be present as a top-level field named identityMap. Note that a dataset row may have many identities in its identity map, but only one can be marked as primary. "primary": true must be included to force the ID to match a primary identity.

displayName
string

The display name for the record delete request.

description
string

A description for the record delete request.

Array of objects

An array containing the identities of at least one user whose information you would like to delete. Each identity is comprised of an identity namespace and a value: namespace: Contains a single string property, code, which represents the identity namespace. id: The identity value. If datasetId specifies a single dataset, each entity under identities must use the same identity namespace as the schema’s primary identity. If datasetId is set to ALL, the identities array is not constrained to any single namespace since each dataset might be different. However, your requests are still constrained to the namespaces available to your organization, as reported by Identity Service.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/workorder
Request samples
application/json
{
  • "action": "delete_identity",
  • "datasetId": "c48b51623ec641a2949d339bad69cb15",
  • "displayName": "Example Record Delete Request",
  • "description": "Cleanup identities required by Jira request 12345.",
  • "identities": [
    ]
}
Response samples
application/json
{
  • "workorderId": "a15345b8-a2d6-4d6f-b33c-5b593e86439a",
  • "orgId": "{ORG_ID}",
  • "bundleId": "BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd",
  • "action": "identity-delete",
  • "createdAt": "2022-07-21T18:05:28.316029Z",
  • "updatedAt": "2022-07-21T17:59:43.217801Z",
  • "status": "received",
  • "createdBy": "{USER_ID}",
  • "datasetId": "c48b51623ec641a2949d339bad69cb15",
  • "displayName": "Example Record Delete Request",
  • "description": "Cleanup identities required by Jira request 12345."
}

Retrieve a workorder

You can use this endpoint to retrieve the status of a record delete request. After creating a record delete request, you can check its status by making a GET request with the specified workorderId.

Request
path Parameters
WORKORDER_ID
required
string

The ID of the deletion order. This can be used to look up the status of the deletion later.

Example: a15345b8-a2d6-4d6f-b33c-5b593e86439a
header Parameters
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

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.

content-type
required
string

The type of content being sent in the body of the request. Should be 'application/json'.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/workorder/{WORKORDER_ID}
Response samples
application/json
{
  • "workorderId": "a15345b8-a2d6-4d6f-b33c-5b593e86439a",
  • "orgId": "{ORG_ID}",
  • "bundleId": "BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd",
  • "action": "identity-delete",
  • "createdAt": "2022-07-21T18:05:28.316029Z",
  • "updatedAt": "2022-07-21T17:59:43.217801Z",
  • "status": "received",
  • "createdBy": "{USER_ID}",
  • "datasetId": "c48b51623ec641a2949d339bad69cb15",
  • "displayName": "Example Record Delete Request",
  • "description": "Cleanup identities required by Jira request 12345.",
  • "productStatusDetails": [
    ]
}

Update a workorder

Update the displayName and description of a specific workorder.

Request
path Parameters
WORKORDER_ID
required
string

The ID of the deletion order. This can be used to look up the status of the deletion later.

Example: a15345b8-a2d6-4d6f-b33c-5b593e86439a
header Parameters
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

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.

Request Body schema: application/json
displayName
string

An updated display name for the record delete request.

description
string

An updated description for the record delete request.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/workorder/{WORKORDER_ID}
Request samples
application/json
{
  • "displayName": "Update - displayName",
  • "description": "Update - description"
}
Response samples
application/json
{
  • "workorderId": "a15345b8-a2d6-4d6f-b33c-5b593e86439a",
  • "orgId": "{ORG_ID}",
  • "bundleId": "BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd",
  • "action": "identity-delete",
  • "createdAt": "2022-07-21T18:05:28.316029Z",
  • "updatedAt": "2022-07-21T17:59:43.217801Z",
  • "status": "received",
  • "createdBy": "{USER_ID}",
  • "datasetId": "c48b51623ec641a2949d339bad69cb15",
  • "displayName": "Example Record Delete Request",
  • "description": "Cleanup identities required by Jira request 12345.",
  • "productStatusDetails": [
    ]
}