Get Credentials

Get credentials

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

Policy Service API (1.0)

Download OpenAPI specification:Download

Adobe Experience Platform Data Governance simplifies and streamlines the process of categorizing data and creating data usage policies. Once data labels have been applied and data usage policies are in place, marketing actions can be evaluated to ensure the correct use of data.

Use the Policy Service API to programmatically manage data usage labels, policies, and marketing actions. The API also provides endpoints to evaluate marketing actions against specific data usage labels to test for policy violations.

Note: You can use the Dataset Service API to manage data usage labels for an existing dataset.

Related documentation:
- Data Governance documentation
Visualize API calls with Postman (a free, third-party software):
API paths:
- PLATFORM Gateway URL: https://platform.adobe.io/
- Base path for this API: /data/foundation/dulepolicy
- Example of a complete path: https://platform.adobe.io/data/foundation/dulepolicy/labels/custom
Required headers:
- All calls require the headers Authorization, x-gw-ims-org-id, and x-api-key. For more information on how to obtain these values, see the authentication tutorial.
- All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header 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.
- All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header Content-Type with a value of application/json.
API error handling:
- Refer to the Experience Platform API troubleshooting guide for FAQs, API status codes, and request header errors.

(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.

Labels

Data usage labels allow you to categorize datasets and fields according to usage policies that apply to that data.

List core labels

NOTE: For more information on using this operation, see the labels endpoint guide on Experience League.

Request

query Parameters

property	string Filters responses based on whether a specific property exists, or whose value passes a conditional expression (e.g. `?property=name==C1`). Only the `name` property is supported for core resources. For custom resources, additional supported property values include `status`, `created`, `createdClient`, `createdUser`, `updated`, `updatedClient`, and `updatedUser`.
orderby	Array of strings A comma-separated list of properties by which the returned list of resources will be sorted.
start	string Indicates the pagination value for the returned list. This value should be obtained from a previous call's `_page.next` property. Should be omitted for a first page of results.
limit	integer A positive integer, indicating the number of results to limit the response to.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Core labels retrieved successfully

get/labels/core

Response samples

application/json

{"_page": {"count": 1
},
"_links": {"_page": {"href": "http://example.com",
"templated": "string"
}
},
"children": [{"name": "C1",
"category": "Contract",
"friendlyName": "Aggregate export only",
"description": "Data can only be exported from Adobe Experience Cloud in an aggregated form without including individual or device identifiers.",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}
]
}

Retrieve a core label

NOTE: For more information on using this operation, see the labels endpoint guide on Experience League.

Request

path Parameters

LABEL_NAME

required

string

The name of the core label.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Core label retrieved successfully

404

Core label not found

get/labels/core/{LABEL_NAME}

Response samples

application/json

{"name": "C1",
"category": "Contract",
"friendlyName": "Aggregate export only",
"description": "Data can only be exported from Adobe Experience Cloud in an aggregated form without including individual or device identifiers.",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}

List custom labels

NOTE: For more information on using this operation, see the labels endpoint guide on Experience League.

Request

query Parameters

property	string Filters responses based on whether a specific property exists, or whose value passes a conditional expression (e.g. `?property=name==C1`). Only the `name` property is supported for core resources. For custom resources, additional supported property values include `status`, `created`, `createdClient`, `createdUser`, `updated`, `updatedClient`, and `updatedUser`.
orderby	Array of strings A comma-separated list of properties by which the returned list of resources will be sorted.
start	string Indicates the pagination value for the returned list. This value should be obtained from a previous call's `_page.next` property. Should be omitted for a first page of results.
limit	integer A positive integer, indicating the number of results to limit the response to.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Custom labels retrieved successfully

get/labels/custom

Response samples

application/json

{"_page": {"count": 1
},
"_links": {"_page": {"href": "http://example.com",
"templated": "string"
}
},
"children": [{"name": "L2",
"category": "Custom",
"friendlyName": "Purchase History Data",
"description": "Data containing information on past transactions",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}
]
}

Retrieve a custom label

NOTE: For more information on using this operation, see the labels endpoint guide on Experience League.

Request

path Parameters

LABEL_NAME

required

string

The name of the custom label.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Custom label retrieved successfully

404

Custom label not found

get/labels/custom/{LABEL_NAME}

Response samples

application/json

{"name": "L2",
"category": "Custom",
"friendlyName": "Purchase History Data",
"description": "Data containing information on past transactions",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}

Create or update a custom label

You can use this endpoint to create or update a custom label. If the label with the given name does not exist, the custom label will be created. If the label with the given name does exist, the custom label will be updated.

NOTE: For more information on using this operation, see the labels endpoint guide on Experience League.

Request

path Parameters

LABEL_NAME

required

string

The name of the custom label.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Request Body schema: application/json
required

name	string A unique name for the label, which also acts as its identifier.
category	string The category of the label. Must be set to `Custom` for custom labels.
friendlyName	string A short, friendly name that can be displayed for the label in user interfaces.
description	string A description of the label's use case.

Responses

200

Custom label updated successfully

201

Custom label created successfully

400

Invalid request payload

put/labels/custom/{LABEL_NAME}

Request samples

Payload

application/json

{"name": "C1",
"category": "Custom",
"friendlyName": "Aggregate export only",
"description": "Data can only be exported from Adobe Experience Cloud in an aggregated form without including individual or device identifiers."
}

Response samples

application/json

{"name": "L2",
"category": "Custom",
"friendlyName": "Purchase History Data",
"description": "Data containing information on past transactions",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}

Policies

Data usage policies are rules that describe the kinds of marketing actions that are allowed or not allowed to be performed on data within Adobe Experience Platform.

List core policies

NOTE: For more information on using this operation, see the policies endpoint guide on Experience League.

Request

query Parameters

property	string Filters responses based on whether a specific property exists, or whose value passes a conditional expression (e.g. `?property=name==C1`). Only the `name` property is supported for core resources. For custom resources, additional supported property values include `status`, `created`, `createdClient`, `createdUser`, `updated`, `updatedClient`, and `updatedUser`.
orderby	Array of strings A comma-separated list of properties by which the returned list of resources will be sorted.
start	string Indicates the pagination value for the returned list. This value should be obtained from a previous call's `_page.next` property. Should be omitted for a first page of results.
limit	integer A positive integer, indicating the number of results to limit the response to.
duleLabels	Array of strings A comma-separated list of data usage label names. Using this parameter returns only those policies whose `deny` expression references any of the labels in the list.
marketingAction	string Restricts returned policies to those that reference a given marketing action 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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Core policies retrieved successfully

get/policies/core

Response samples

application/json

{"_links": {"_page": {"href": "http://example.com",
"templated": "string"
}
},
"_page": {"count": 1
},
"children": [{"name": "Restrict email targeting",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Restrict use of data labeled C4 OR C5 for email targeting.",
"deny": {"operator": "OR",
"operands": [{"label": "C4"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
],
"label": "C5"
}
]
},
"_links": {"self": {"href": "https://platform-stage.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
},
"id": "corepolicy_0003"
}
]
}

Retrieve a core policy

NOTE: For more information on using this operation, see the policies endpoint guide on Experience League.

Request

path Parameters

POLICY_ID

required

string

The ID of the policy to be retrieved.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Policy retrieved successfully

404

Policy not found

get/policies/core/{POLICY_ID}

Response samples

application/json

{"name": "Restrict email targeting",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Restrict use of data labeled C4 OR C5 for email targeting.",
"deny": {"operator": "OR",
"operands": [{"label": "C4"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
],
"label": "C5"
}
]
},
"_links": {"self": {"href": "https://platform-stage.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
},
"id": "corepolicy_0003"
}

List custom policies

NOTE: For more information on using this operation, see the policies endpoint guide on Experience League.

Request

query Parameters

property	string Filters responses based on whether a specific property exists, or whose value passes a conditional expression (e.g. `?property=name==C1`). Only the `name` property is supported for core resources. For custom resources, additional supported property values include `status`, `created`, `createdClient`, `createdUser`, `updated`, `updatedClient`, and `updatedUser`.
orderby	Array of strings A comma-separated list of properties by which the returned list of resources will be sorted.
start	string Indicates the pagination value for the returned list. This value should be obtained from a previous call's `_page.next` property. Should be omitted for a first page of results.
limit	integer A positive integer, indicating the number of results to limit the response to.
duleLabels	Array of strings A comma-separated list of data usage label names. Using this parameter returns only those policies whose `deny` expression references any of the labels in the list.
marketingAction	string Restricts returned policies to those that reference a given marketing action 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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Custom policies retrieved successfully

get/policies/custom

Response samples

application/json

{"_page": {"count": 1
},
"_links": {"_page": {"href": "http://example.com",
"templated": "string"
}
},
"children": [{"name": "Email Policy",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
]
}
]
},
"id": "76131228-7654-11e8-adc0-fa7ae01bbebc",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/custom/emailPolicy"
}
}
}
]
}

Create a custom policy

NOTE: For more information on using this operation, see the policies endpoint guide on Experience League.

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 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 type of content being sent in the body of the request. In POST, PUT, or PATCH requests to the Policy Service API, the value must be set to `application/json`.

Request Body schema: application/json
required

The custom policy to be created.

name	string The name of the policy
status	string The status of the policy Enum: "DRAFT" "ENABLED" "DISABLED"
marketingActionRefs	Array of strings <uri> List of marketing action URI references to which this policy applies.
description	string A description of what this policy enforces. Specifically, the reasoning behind the denial of these marketing actions in the presence of the data usage labels.
	object (PolicyExpression) A boolean expression to be evaluated over the presence of data usage labels, referred to as a "policy expression". Note that a policy expression must consist of either a label or an operator and operands. Each operand in turn is itself a policy expression. You cannot specify both a label and an operator/operand in combination. See the Policy Service API guide for more details on how to configure this property.

Responses

201

Custom policy created successfully

400

Invalid request payload

post/policies/custom

Request samples

Payload

application/json

{"name": "Email Policy",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
]
}
]
}
}

Response samples

application/json

{"name": "Email Policy",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
]
}
]
},
"id": "76131228-7654-11e8-adc0-fa7ae01bbebc",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/custom/emailPolicy"
}
}
}

Retrieve a custom policy

NOTE: For more information on using this operation, see the policies endpoint guide on Experience League.

Request

path Parameters

POLICY_ID

required

string

The ID of the custom policy being retrieved.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Custom policy retrieved successfully

404

Custom policy not found

get/policies/custom/{POLICY_ID}

Response samples

application/json

{"id": "76131228-7654-11e8-adc0-fa7ae01bbebc",
"name": "Email Policy",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
]
}
]
},
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}

Update a custom policy

NOTE: For more information on using this operation, see the policies endpoint guide on Experience League.

Request

path Parameters

POLICY_ID

required

string

The ID of the policy being updated.

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 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 type of content being sent in the body of the request. In POST, PUT, or PATCH requests to the Policy Service API, the value must be set to `application/json`.

Request Body schema: application/json
required

The updated information for the policy, in its entirety.

name	string The name of the policy
status	string The status of the policy Enum: "DRAFT" "ENABLED" "DISABLED"
marketingActionRefs	Array of strings <uri> List of marketing action URI references to which this policy applies.
description	string A description of what this policy enforces. Specifically, the reasoning behind the denial of these marketing actions in the presence of the data usage labels.
	object (PolicyExpression) A boolean expression to be evaluated over the presence of data usage labels, referred to as a "policy expression". Note that a policy expression must consist of either a label or an operator and operands. Each operand in turn is itself a policy expression. You cannot specify both a label and an operator/operand in combination. See the Policy Service API guide for more details on how to configure this property.

Responses

200

Policy updated successfully

400

Invalid request payload

404

Policy not found

put/policies/custom/{POLICY_ID}

Request samples

Payload

application/json

{"name": "Email Policy",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
]
}
]
}
}

Response samples

application/json

{"id": "76131228-7654-11e8-adc0-fa7ae01bbebc",
"name": "Email Policy",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
]
}
]
},
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}

Delete a custom policy

NOTE: For more information on using this operation, see the policies endpoint guide on Experience League.

Request

path Parameters

POLICY_ID

required

string

The ID of the policy to be deleted.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Policy deleted successfully

404

Policy not found

delete/policies/custom/{POLICY_ID}

Response samples

application/json

{"type": "string",
"status": 404,
"title": "NotFound",
"detail": "https://platform.adobe.io:443/policies/custom/12345 not found"
}

Update one or more attributes of a custom policy

NOTE: For more information on using this operation, see the policies endpoint guide on Experience League.

Request

path Parameters

POLICY_ID

required

string

The ID of the policy being updated.

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 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 type of content being sent in the body of the request. In POST, PUT, or PATCH requests to the Policy Service API, the value must be set to `application/json`.

Request Body schema: application/json
required

Use JSON Patch to update a portion of a policy.

op required	string The operation to be performed. Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string A JSON Pointer path to the resource field being updated.
value	object The value to be used in the context of the patch operation.

Responses

200

Policy updated successfully

400

Invalid request payload

404

Policy not found

patch/policies/custom/{POLICY_ID}

Request samples

Payload

application/json

{"op": "add",
"path": "string",
"value": { }
}

Response samples

application/json

{"id": "76131228-7654-11e8-adc0-fa7ae01bbebc",
"name": "Email Policy 001",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
]
}
]
},
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}

Enabled core policies

Unless explicitly indicated otherwise, only enabled policies participate in evaluation. The Policy Service API maintains a list of enabled core policies for your organization that you can manage using single API calls.

List all enabled core policies

NOTE: For more information on using this operation, see the policies endpoint guide on Experience League.

Request

header Parameters

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.
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.

Responses

200

Enabled core policies retrieved successfully

get/enabledCorePolicies

Response samples

application/json

{"policyIds": ["string"
],
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{CLIENT_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{CLIENT_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/enabledCorePolicies"
}
}
}

Create or update the list of enabled core policies

You can use this endpoint to create or update the list of enabled core policies.

NOTE: For more information on using this operation, see the policies endpoint guide on Experience League.

Request

header Parameters

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.
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.

Request Body schema: application/json
required

List of core policy IDs.

policyIds

Array of strings

A list of core policy IDs that you want to enable for this IMS Organization and sandbox.

Responses

200

Enabled core policies updated successfully

400

Invalid request payload

409

Policy update violates existing entities

put/enabledCorePolicies

Request samples

Payload

application/json

{"policyIds": ""
}

Response samples

application/json

{"policyIds": ["string"
],
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{CLIENT_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{CLIENT_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/enabledCorePolicies"
}
}
}

Marketing actions

Marketing actions, in the context of Data Governance, are actions that an Experience Platform data consumer takes, for which there is a need to check for violations of data usage policies.

List core marketing actions

NOTE: For more information on using this operation, see the marketing actions endpoint guide on Experience League.

Request

query Parameters

property	string Filters responses based on whether a specific property exists, or whose value passes a conditional expression (e.g. `?property=name==C1`). Only the `name` property is supported for core resources. For custom resources, additional supported property values include `status`, `created`, `createdClient`, `createdUser`, `updated`, `updatedClient`, and `updatedUser`.
orderby	Array of strings A comma-separated list of properties by which the returned list of resources will be sorted.
start	string Indicates the pagination value for the returned list. This value should be obtained from a previous call's `_page.next` property. Should be omitted for a first page of results.
limit	integer A positive integer, indicating the number of results to limit the response to.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Core marketing actions retrieved successfully

get/marketingActions/core

Response samples

application/json

{"_page": {"count": 1
},
"_links": {"_page": {"href": "http://example.com",
"templated": "string"
}
},
"children": [{"name": "exportToThirdParty",
"friendlyName": "Export to Third Party",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}
]
}

Retrieve a core marketing action

NOTE: For more information on using this operation, see the marketing actions endpoint guide on Experience League.

Request

path Parameters

MARKETING_ACTION_NAME

required

string

The name of the marketing action to be retrieved.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Marketing action retrieved successfully

404

Marketing action not found

get/marketingActions/core/{MARKETING_ACTION_NAME}

Response samples

application/json

{"name": "exportToThirdParty",
"friendlyName": "Export to Third Party",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}

List custom marketing actions

NOTE: For more information on using this operation, see the marketing actions endpoint guide on Experience League.

Request

query Parameters

property	string Filters responses based on whether a specific property exists, or whose value passes a conditional expression (e.g. `?property=name==C1`). Only the `name` property is supported for core resources. For custom resources, additional supported property values include `status`, `created`, `createdClient`, `createdUser`, `updated`, `updatedClient`, and `updatedUser`.
orderby	Array of strings A comma-separated list of properties by which the returned list of resources will be sorted.
start	string Indicates the pagination value for the returned list. This value should be obtained from a previous call's `_page.next` property. Should be omitted for a first page of results.
limit	integer A positive integer, indicating the number of results to limit the response to.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Custom marketing actions retrieved successfully

get/marketingActions/custom

Response samples

application/json

{"_page": {"count": 1
},
"children": [{"name": "analyticsDB",
"description": "Push data to external database for analytics.",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/analyticsDB"
}
}
}
]
}

Retrieve a custom marketing action

NOTE: For more information on using this operation, see the marketing actions endpoint guide on Experience League.

Request

path Parameters

MARKETING_ACTION_NAME

required

string

The name of the marketing action to be retrieved.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Custom marketing action retrieved successfully

404

Custom marketing action not found

get/marketingActions/custom/{MARKETING_ACTION_NAME}

Response samples

application/json

{"name": "analyticsDB",
"description": "Push data to external database for analytics.",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/analyticsDB"
}
}
}

Create or update a custom marketing action

You can use this endpoint to create or update a custom marketing action. If the marketing action with the given name does not exist, it will create a new marketing action. If the marketing action with the given name exists, it will update the existing marketing action.

NOTE: For more information on using this operation, see the marketing actions endpoint guide on Experience League.

Request

path Parameters

MARKETING_ACTION_NAME

required

string

The name of the marketing action to be created or updated.

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 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 type of content being sent in the body of the request. In POST, PUT, or PATCH requests to the Policy Service API, the value must be set to `application/json`.

Request Body schema: application/json
required

Details for the new or updated marketing action.

name required	string The name of the marketing action, which also acts as its unique identifier.
description	string A description for the marketing action.

Responses

200

Custom marketing action updated successfully

201

Custom marketing action created successfully

400

Invalid request payload

put/marketingActions/custom/{MARKETING_ACTION_NAME}

Request samples

Payload

application/json

{"name": "analyticsDB",
"description": "Push data to external database for analytics."
}

Response samples

application/json

{"name": "analyticsDB",
"description": "Push data to external database for analytics.",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}

Delete a custom marketing action

NOTE: For more information on using this operation, see the marketing actions endpoint guide on Experience League.

Request

path Parameters

MARKETING_ACTION_NAME

required

string

The name of the marketing action to be deleted.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Marketing action deleted successfully

404

Marketing action not found

delete/marketingActions/custom/{MARKETING_ACTION_NAME}

Response samples

application/json

{"type": "string",
"status": 404,
"title": "NotFound",
"detail": "https://platform.adobe.io:443/marketingActions/custom/marketingActionName not found"
}

Policy evaluation

The policy evaluation endpoints allow you to test a marketing action against specific labels or against datasets and fields to check for policy violations.

Evaluate a core marketing action based on data usage labels

This call returns a set of constraints that would govern an attempt to perform the given marketing action on a hypothetical source of data containing specific data usage labels.

You can also evaluate a marketing action based on the labels contained in an actual dataset in your data stores. See the POST method for this endpoint for more information.

NOTE: For more information on using this operation, see the policy evaluation endpoint guide on Experience League.

Request

path Parameters

MARKETING_ACTION_NAME

required

string

The name of the marketing action to test data usage labels against.

query Parameters

duleLabels required	Array of strings A comma-separated list of data usage labels that would be present on data that you want to test for policy violations.
includeDraft	boolean Default: false If true, the system checks for policy violations among policies with `DRAFT` status as well as `ENABLED` status. Otherwise, only `ENABLED` policies are checked.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Marketing action constraints retrieved successfully

404

Marketing action not found

get/marketingActions/core/{MARKETING_ACTION_NAME}/constraints

Response samples

application/json

{"timestamp": 1529699072556,
"clientId": "{CLIENT_ID}",
"userId": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting",
"duleLabels": ["C1",
"C3"
],
"violatedPolicies": [{"id": "76131228-7654-11e8-adc0-fa7ae01bbebc",
"name": "Email Policy",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
]
}
]
},
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}
]
}

Evaluate a core marketing action based on datasets and/or fields

This call returns a set of constraints that would govern an attempt to perform the given marketing action on an existing data source in Platform. The source data (typically a dataset) is specified by the entityType and entityId of the elements in the request body. In the case of a dataset entity, a set of fields may also be specified in the entityMeta to indicate that only those fields from that dataset should be used in the evaluation. The returned constraints take the form of a set of policies that would be violated by attempting the marketing action on the dataset(s) and/or field(s).

You can also evaluate a marketing action based on a defined set of usage labels instead of testing against an actual data source. See the GET method for this endpoint for more information.

NOTE: For more information on using this operation, see the policy evaluation endpoint guide on Experience League.

Request

path Parameters

MARKETING_ACTION_NAME

required

string

The name of the marketing action to test against datasets or fields.

query Parameters

includeDraft

boolean

Default: false

If true, the system checks for policy violations among policies with DRAFT status as well as ENABLED status. Otherwise, only ENABLED policies are checked.

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 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 type of content being sent in the body of the request. In POST, PUT, or PATCH requests to the Policy Service API, the value must be set to `application/json`.

Request Body schema: application/json
required

An array that lists the entities for which to retrieve labels. This can include dataset IDs and individual fields within those datasets.

Array

entityType required	string The type of entity on which to discover labels. Currently only `dataSet` is supported. Value: "dataSet"
entityId required	string The ID of the dataset.
	object Provides additional metadata about the dataset entity. You can use this field to list optional fields to run the evaluation on.

Responses

200

Marketing action dataset constraints retrieved successfully

400

Invalid request payload

404

Marketing action not found

post/marketingActions/core/{MARKETING_ACTION_NAME}/constraints

Request samples

Payload

application/json

[{"entityType": "dataSet",
"entityId": "5b1e3c867e6d2600003d5b49",
"entityMeta": {"fields": ["emailAddress",
"fullName"
]
}
}
]

Response samples

application/json

{"timestamp": 1529699072556,
"clientId": "{CLIENT_ID}",
"userId": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting",
"duleLabels": ["C1",
"C3"
],
"discoveredLabels": [{"entityType": "dataSet",
"entityId": "5b1e3c867e6d2600003d5b49",
"dataSetLabels": {"connection": ["C1"
],
"dataSet": ["C1",
"C3"
],
"fields": [{"path": "/emailAddress",
"labels": ["C1",
"C3",
"C7"
]
},
{"path": "/fullName",
"labels": ["C1",
"C3"
]
}
]
}
}
],
"violatedPolicies": [{"id": "76131228-7654-11e8-adc0-fa7ae01bbebc",
"name": "Email Policy",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
]
}
]
},
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}
]
}

Evaluate a custom marketing action based on data usage labels

This call returns a set of constraints that would govern an attempt to perform the given marketing action on a hypothetical source of data containing specific data usage labels.

You can also evaluate a marketing action based on the labels contained in an actual dataset in your data stores. See the POST method for this endpoint for more information.

NOTE: For more information on using this operation, see the policy evaluation endpoint guide on Experience League.

Request

path Parameters

MARKETING_ACTION_NAME

required

string

The name of the marketing action to test data usage labels against.

query Parameters

duleLabels required	Array of strings A comma-separated list of data usage labels that would be present on data that you want to test for policy violations.
includeDraft	boolean Default: false If true, the system checks for policy violations among policies with `DRAFT` status as well as `ENABLED` status. Otherwise, only `ENABLED` policies are checked.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses

200

Marketing action constraints retrieved successfully

404

Marketing action not found

get/marketingActions/custom/{MARKETING_ACTION_NAME}/constraints

Response samples

application/json

{"timestamp": 1529699072556,
"clientId": "{CLIENT_ID}",
"userId": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/analyticsDB",
"duleLabels": ["C1",
"C3"
],
"violatedPolicies": [{"id": "76131228-7654-11e8-adc0-fa7ae01bbebc",
"name": "Email Policy",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
]
}
]
},
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/custom/emailPolicy"
}
}
}
]
}

Evaluate a custom marketing action based on datasets and/or fields

This call returns a set of constraints that would govern an attempt to perform the given marketing action on an existing data source in Platform. The source data (typically a dataset) is specified by the "entityType" and "entityId" of the elements in the request body. In the case of a dataset entity, a set of fields may also be specified in the "entityMeta" to indicate that only those fields from that dataset should be used in the evaluation. The returned constraints take the form of a set of policies that would be violated by attempting the marketing action on the dataset(s) and/or field(s).

You can also evaluate a marketing action based on a defined set of usage labels instead of testing against an actual data source. See the GET method for this endpoint for more information.

NOTE: For more information on using this operation, see the policy evaluation endpoint guide on Experience League.

Request

path Parameters

MARKETING_ACTION_NAME

required

string

The name of the marketing action to test against datasets or fields.

query Parameters

includeDraft

boolean

Default: false

If true, the system checks for policy violations among policies with DRAFT status as well as ENABLED status. Otherwise, only ENABLED policies are checked.

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 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 type of content being sent in the body of the request. In POST, PUT, or PATCH requests to the Policy Service API, the value must be set to `application/json`.

Request Body schema: application/json
required

An array that lists the entities for which to retrieve labels. This can include dataset IDs and individual fields within those datasets.

Array

entityType required	string The type of entity on which to discover labels. Currently only `dataSet` is supported. Value: "dataSet"
entityId required	string The ID of the dataset.
	object Provides additional metadata about the dataset entity. You can use this field to list optional fields to run the evaluation on.

Responses

200

Marketing action dataset constraints retrieved successfully

400

Bad request

404

Marketing action not found

post/marketingActions/custom/{MARKETING_ACTION_NAME}/constraints

Request samples

Payload

application/json

[{"entityType": "dataSet",
"entityId": "5b1e3c867e6d2600003d5b49",
"entityMeta": {"fields": ["emailAddress",
"fullName"
]
}
}
]

Response samples

application/json

{"timestamp": 1529699072556,
"clientId": "{CLIENT_ID}",
"userId": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/analyticsDB",
"duleLabels": ["C1",
"C3"
],
"discoveredLabels": [{"entityType": "dataSet",
"entityId": "5b1e3c867e6d2600003d5b49",
"dataSetLabels": {"connection": ["C1"
],
"dataSet": ["C1",
"C3"
],
"fields": [{"path": "/emailAddress",
"labels": ["C1",
"C3",
"C7"
]
},
{"path": "/fullName",
"labels": ["C1",
"C3"
]
}
]
}
}
],
"violatedPolicies": [{"id": "76131228-7654-11e8-adc0-fa7ae01bbebc",
"name": "Email Policy",
"status": "ENABLED",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"operator": "OR",
"operands": [{"label": "C3"
},
{"label": "C7"
}
]
}
]
},
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/policies/core/corepolicy_0003"
}
}
}
]
}

Run multiple policy evaluation jobs in bulk

This endpoint allows you to run a list of policy evaluations in bulk, so you don't have to call the ../{MARKETING_ACTION_NAME}/constraints endpoint multiple times.

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 The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Request Body schema: application/json
required

An array of policy evaluation jobs to perform in bulk. Each job must evaluate based on one of the following:

A set of labels
A list of datasets and/or fields within those datasets

To evaluate a marketing action based on both labels and datasets, you must include two separate jobs for that action: one that includes a labels array, and one that contains an entityList array.

NOTE: For more information on using this operation, see the policy evaluation endpoint guide on Experience League.

Array

evalRef required	string The constraints URL to be evaluated. Should be of the form `../marketingActions/core/{MARKETING_ACTION_NAME}/constraints`. This evalRef provides a way to specify the marketing action name as well as whether it is a core or custom marketing action. Only the portion of this URL after the `/marketingActions` component is significant; any prefix to this is ignored.
includeDraft	boolean Default: false If true, the system checks for policy violations among policies with "DRAFT" status as well as "ENABLED" status. Otherwise, only "ENABLED" policies are checked.
labels	Array of strings List of labels to evaluate against the constraints. Any one request may contain either `labels` or `entityList`, not both.
	Array of objects (BulkEntityLabelRequest) List of entities on which to retrieve labels in order to perform this evaluation. Any one request may contain either `labels` or `entityList`, not both.

Responses

200

Policy evaluation results retrieved successfully

400

Invalid request payload

post/bulk-eval

Request samples

Payload

application/json

[{"evalRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting/constraints",
"includeDraft": false,
"labels": ["C1",
"C2",
"C3"
]
},
{"evalRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting/constraints",
"includeDraft": false,
"entityList": [{"entityType": "dataSet",
"entityId": "5b67f4dd9f6e710000ea9da4",
"entityMeta": {"fields": ["address"
]
}
}
]
}
]

Response samples

application/json

[{"status": 200,
"body": {"timestamp": 1595866566165,
"clientId": "{CLIENT_ID}",
"userId": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting",
"duleLabels": ["C1",
"C2",
"C3"
],
"violatedPolicies": [ ]
}
},
{"status": 200,
"body": {"timestamp": 1595866566165,
"clientId": "{CLIENT_ID}",
"userId": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"sandboxName": "prod",
"marketingActionRef": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting",
"duleLabels": ["C1",
"C2"
],
"discoveredLabels": [{"entityType": "dataset",
"entityId": "5b67f4dd9f6e710000ea9da4",
"dataSetLabels": {"connection": {"labels": [ ]
},
"dataset": {"labels": ["C1",
"C2"
]
},
"fields": [ ]
}
}
],
"violatedPolicies": [{"name": "Email Policy",
"status": "DRAFT",
"marketingActionRefs": ["https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/core/emailTargeting"
],
"description": "Conditions under which we won't send marketing-based email",
"deny": {"operator": "AND",
"operands": [{"label": "C1"
},
{"label": "C3"
}
]
},
"id": "76131228-7654-11e8-adc0-fa7ae01bbebc",
"imsOrg": "{IMS_ORG}",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {"self": {"href": "./76131228-7654-11e8-adc0-fa7ae01bbebc"
}
}
}
]
}
}
]

Get credentials

Policy Service API (1.0)

(NEW) Interactive API documentation

Labels

List core labels

query Parameters

header Parameters

Retrieve a core label

path Parameters

header Parameters

List custom labels

query Parameters

header Parameters

Retrieve a custom label

path Parameters

header Parameters

Create or update a custom label

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Policies

List core policies

query Parameters

header Parameters

Retrieve a core policy

path Parameters

header Parameters

List custom policies

query Parameters

header Parameters

Create a custom policy

header Parameters

Request Body schema: application/jsonrequired

Retrieve a custom policy

path Parameters

header Parameters

Update a custom policy

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Delete a custom policy

path Parameters

header Parameters

Update one or more attributes of a custom policy

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Enabled core policies

List all enabled core policies

header Parameters

Create or update the list of enabled core policies

header Parameters

Request Body schema: application/jsonrequired

Marketing actions

List core marketing actions

query Parameters

header Parameters

Retrieve a core marketing action

path Parameters

header Parameters

List custom marketing actions

query Parameters

header Parameters

Retrieve a custom marketing action

path Parameters

header Parameters

Create or update a custom marketing action

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Delete a custom marketing action

path Parameters

header Parameters

Policy evaluation

Evaluate a core marketing action based on data usage labels

path Parameters

query Parameters

header Parameters

Evaluate a core marketing action based on datasets and/or fields

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required