Get Credentials

Get credentials

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

Schema Registry API (1.0)

Download OpenAPI specification:Download

Use the Schema Registry API to access the Schema Library within Adobe Experience Platform. The registry provides a user interface and RESTful API from which all available library resources are accessible. Programmatically manage all schemas and related Experience Data Model (XDM) resources available to you within Platform. This includes those defined by Adobe, Experience Platform partners, and vendors whose applications you use.

Related documentation:
- XDM 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/schemaregistry
- Example of a complete path for making a call to "/stats": https://platform.adobe.io/data/foundation/schemaregistry/stats
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 GET requests to the Schema Registry require an Accept header to determine what data is returned by the system. See the section on Accept headers in the Schema Registry developer guide 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.

Stats

Returns {TENANT_ID} along with information regarding IMS Org usage of the Schema Registry such as resource counts, recently created resources, and class usage.

Retrieve your tenant ID and other usage information related to the Schema Registry.

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 IMS 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 for more information.

Responses

200

Success

400

Bad formatting

get/stats

Response samples

application/json

{"imsOrg": "{IMS_ORG}",
"tenantId": "{TENANT_ID}",
"counts": {"schemas": 4,
"mixins": 38,
"datatypes": 382,
"classes": 5,
"unions": 2
},
"recentlyCreatedResources": [{"title": "Tenant Data Schema",
"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/274f17bc5807ff307a046bab1489fb18",
"meta:altId": "_{TENANT_ID}.schemas.274f17bc5807ff307a046bab1489fb18",
"version": "1.1"
}
],
"recentlyUpdatedResources": [{"title": "Tenant Data Schema",
"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/274f17bc5807ff307a046bab1489fb18",
"meta:altId": "_{TENANT_ID}.schemas.274f17bc5807ff307a046bab1489fb18",
"version": "1.1"
}
],
"classUsage": [{"$id": "https://ns.adobe.com/xdm/context/profile",
"title": "XDM Individual Profile",
"numberOfSchemas": 3,
"schemas": [{"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/3d569c62921ac9371ad148afbaec3891547aca2a49575cef",
"title": "Customers",
"description": "Basic profile schema."
},
{"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/ad79ff2868d65545812ffe6745a2085d0b5deff379bc3faf",
"title": "Loyalty Members",
"description": "Describes members of the loyalty program."
},
{"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/274f17bc5807ff307a046bab1489fb18,",
"title": "Tenant Data Schema,",
"meta:altId": "_{TENANT_ID}.schemas.274f17bc5807ff307a046bab1489fb18,"
}
]
},
{"$id": "https://ns.adobe.com/xdm/context/profile",
"title": "XDM ExperienceEvent",
"numberOfSchemas": 1,
"schemas": [{"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/7a3739168b1cb52b1489f6f3c43eaa66ff155fa87cd1e5ee",
"title": "Website Event",
"description": "Describes a web traffic event."
}
]
}
]
}

Schemas

Schemas provide an abstract definition of a real-world object along with constraints and expectations that can be applied and used to validate data.

List schemas

You can list schemas within the global or tenant container by performing a GET request. To help filter results, the Schema Registry supports the use of query parameters when listing resources.

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

Request

path Parameters

CONTAINER_ID

required

string

The name of the container that you want to list resources from. To list core resources provided by Adobe, use global. To list custom resources defined by your organization, use tenant.

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. For example, `property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile` returns only field groups that are compatible with the XDM Individual Profile class.
orderby	string Sort the listed resources by specified fields. For example `orderby=title` sorts results by title in ascending order (A-Z). Adding a `-` before the field name (`orderby=-title`) sorts items in descending order (Z-A). Multiple fields can also be included to denote primary and secondary sort orders (for example, `orderby=title,description`).
start	string When used in conjunction with an `orderby` parameter, `start` specifies where the paginated list of items should begin. This parameter cannot be used without an `orderby` parameter present. Typically, this parameter is omitted in order to obtain the first page of results. After that, `start` should be set to the maximum value of the primary sort property of the `orderby` field received in the previous page. The API response then returns entries beginning with those that have a primary sort property from `orderby` strictly greater than (for ascending) or strictly less than (for descending) the specified value. For example, if the `orderby` parameter is set to `orderby=name,firstname`, the `start` parameter would contain a value for the `name` property. In this case, if you wanted to show the next 20 entries of a resource immediately following the name "Miller", you would use: `?orderby=name,firstname&start=Miller&limit=20`.
limit	number When used in conjunction with an `orderby` parameter, `limit` restricts the maximum number of items that should be returned for a given request. This parameter cannot be used without an `orderby` parameter present. The `limit` parameter specifies a positive integer (between `0` and `500`) as a hint as to the maximum number of items that should be returned. For example, `limit=5` returns only five resources in the list. However, this value is not strictly honored. The actual response size may be smaller or larger as constrained by the need to provide the reliable operation of the `start` parameter, if one is provided.

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 IMS 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 for more information.

required

string

The desired response format. For listing calls, the following Accept header values are permitted:

Accept	Description
`application/vnd.adobe.xed-id+json`	Returns a short summary of each resource, generally the preferred header for listing.
`application/vnd.adobe.xed+json`	Returns full JSON for each resource, with the original `$ref` and `allOf` attributes included.

Responses

200

Success

400

Bad formatting

get/{CONTAINER_ID}/schemas

Response samples

application/json

{"results": [{"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/0238be93d3e7a06aec5e0655955901ec",
"meta:altId": "_{TENANT_ID}.schemas.0238be93d3e7a06aec5e0655955901ec",
"version": "1.4",
"title": "Hotels"
},
{"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/0ef4ce0d390f0809fad490802f53d30b",
"meta:altId": "_{TENANT_ID}.schemas.0ef4ce0d390f0809fad490802f53d30b",
"version": "1.0",
"title": "Loyalty Members"
}
],
"_page": {"orderby": "title",
"next": null,
"count": 2
},
"_links": {"next": null,
"global_schemas": {"href": "https://platform.adobe.io/data/foundation/schemaregistry/global/schemas"
}
}
}

Retrieve a schema

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

Request

path Parameters

CONTAINER_ID required	string The name of the container that you want to retrieve a resource from. To retrieve a core resource provided by Adobe, use `global`. To retrieve a custom resource defined by your organization, use `tenant`.
SCHEMA_ID required	string The `meta:altId` or URL-encoded `$id` of the schema in question.

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 IMS 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 for more information.

required

string

The desired response format. For lookup requests, a version parameter must be included, with the following Accept header values being permitted:

Accept	Description
`application/vnd.adobe.xed+json; version=1`	Returns only the basic details of the resource, with all inherited fields relegated to `$ref` and `allOf` properties.
`application/vnd.adobe.xed-full+json; version=1`	Returns the full details of the resource, including the details all fields inherited from other resources.
`application/vnd.adobe.xed-notext+json; version=1`	Returns only the basic details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-notext+json; version=1`	Returns the full details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-desc+json; version=1`	Returns the full details of the resource, including descriptions but with no titles.

Responses

200

Success

400

Bad formatting

404

Not found

406

Invalid Accept format

get/{CONTAINER_ID}/schemas/{SCHEMA_ID}

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d4ad4b8463a67f6755f2aabbeb9e02c7",
"meta:altId": "_{TENANT_ID}.schemas.d4ad4b8463a67f6755f2aabbeb9e02c7",
"meta:resourceType": "schemas",
"version": "1.4",
"title": "Hotels",
"type": "object",
"description": "Schema for hotels.",
"allOf ": [{"$ref ": "https://ns.adobe.com/xdm/context/profile"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/a5f8594ef47312543ee8d7437f934fd8"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extensible": false,
"meta:abstract": false,
"meta:extends": ["https://ns.adobe.com/xdm/context/profile",
"https://ns.adobe.com/xdm/data/record",
"https://ns.adobe.com/xdm/context/identitymap",
"https://ns.adobe.com/xdm/common/extensible",
"https://ns.adobe.com/xdm/common/auditable",
"https://ns.adobe.com/{TENANT_ID}/mixins/a5f8594ef47312543ee8d7437f934fd8"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1570222174191,
"repo:lastModifiedDate": 1574113291149,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "e6717738681f663237572053aa02cb3a656ed02847e3361071db4d405e52357d",
"meta:globalLibVersion": "1.27.4"
},
"meta:class": "https://ns.adobe.com/xdm/context/profile",
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Create a custom schema

NOTE: For more information on using this operation, see the schemas 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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The JSON payload must include an allOf attribute referencing the $id of the base class the that the schema will implement.

type required	string The JSON Schema data type for the resource. Must be set to `object`.
title required	string A title for the schema.
description required	string A description for the schema.
required	Array of objects Lists the class and/or field groups whose fields the schema implements. Each object contains a single property (`$ref`) whose value represents the `$id` of the class or field group the new schema will implement. One class must be provided, with zero or more additional field groups.

Responses

201

Success

400

Bad formatting

post/tenant/schemas

Request samples

Payload

application/json

{"type": "object",
"title": "New Schema",
"description": "Description of the new schema.",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/context/profile"
}
]
}

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/e417987b8b861d373ef4d0fe8ad61fa4c15fa0274332c8af",
"meta:altId": "_{TENANT_ID}.schemas.e417987b8b861d373ef4d0fe8ad61fa4c15fa0274332c8af",
"meta:resourceType": "schemas",
"version": "1.0",
"title": "New Schema",
"type": "object",
"description": "Description of the new schema.",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/context/profile",
"type": "object",
"meta:xdmType": "object"
}
],
"refs": ["https://ns.adobe.com/xdm/context/profile"
],
"imsOrg": "{IMS_ORG}",
"meta:extensible": false,
"meta:abstract": false,
"meta:extends": ["https://ns.adobe.com/xdm/common/auditable",
"https://ns.adobe.com/xdm/data/record",
"https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1635537329990,
"repo:lastModifiedDate": 1635537329990,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "022afad00319b928238bcf88e20cc8e1fbdddfee6663925041004a49bdc2abeb",
"meta:globalLibVersion": "1.27.4"
},
"meta:class": "https://ns.adobe.com/xdm/context/profile",
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Update a custom schema

A PUT request essentially re-writes the schema, therefore the request body must include all fields required to create (POST) a schema. This is especially useful when updating a lot of information in the schema at once.

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

Request

path Parameters

SCHEMA_ID

required

string

The meta:altId or URL-encoded $id of the schema in question.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The JSON payload must include all of the fields that were originally required for creating the schema, but with updated values. This includes an allOf attribute referencing the $id of the class the schema will implement.

type required	string The JSON Schema data type for the resource. Must be set to `object`.
title required	string A title for the schema.
description required	string A description for the schema.
required	Array of objects Lists the class and/or field groups whose fields the schema implements. Each object contains a single property (`$ref`) whose value represents the `$id` of the class or field group the new schema will implement. One class must be provided, with zero or more additional field groups.

Responses

200

Success

400

Bad formatting

put/tenant/schemas/{SCHEMA_ID}

Request samples

Payload

application/json

{"type": "object",
"title": "New Schema",
"description": "Description of the new schema.",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/context/profile"
}
]
}

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d4ad4b8463a67f6755f2aabbeb9e02c7",
"meta:altId": "_{TENANT_ID}.schemas.d4ad4b8463a67f6755f2aabbeb9e02c7",
"meta:resourceType": "schemas",
"version": "1.1",
"title": "Hotels",
"type": "object",
"description": "string",
"allOf": [{"$ref ": "string"
}
],
"imsOrg": "string",
"meta:extensible": true,
"meta:abstract": true,
"meta:extends": ["string"
],
"meta:xdmType": "string",
"meta:registryMetadata": {"repo:createdDate": 0,
"repo:lastModifiedDate": 0,
"xdm:createdClientId": "string",
"xdm:lastModifiedClientId": "string",
"xdm:createdUserId": "string",
"xdm:lastModifiedUserId": "string",
"etag": "string",
"meta:globalLibVersion": "string",
"meta:usageCount": 0
}
}

Update one or more attributes of a custom schema

You can use this endpoint to update one or more attributes of the custom schema.

The Schema Registry supports all standard JSON Patch operations, including add, remove, and replace. For more information on JSON Patch, including all available operations, please refer to the the official JSON Patch specification.

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

Request

path Parameters

SCHEMA_ID

required

string

The meta:altId or URL-encoded $id of the schema in question.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The request body accepts a JSON Patch payload.

Array

op required	string The JSON Patch operation to be performed.
path required	string The path to the field that the operation should be performed on.
value	string If adding or updating an attribute, this property indicates the value that should be set for that property.

Responses

200

Success

400

Bad formatting

patch/tenant/schemas/{SCHEMA_ID}

Request samples

Payload

application/json

[{"op": "add",
"path": "/meta:immutableTags-",
"value": "union"
}
]

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d4ad4b8463a67f6755f2aabbeb9e02c7",
"meta:altId": "_{TENANT_ID}.schemas.d4ad4b8463a67f6755f2aabbeb9e02c7",
"meta:resourceType": "schemas",
"version": "1.1",
"title": "Hotels",
"type": "object",
"description": "string",
"allOf": [{"$ref ": "string"
}
],
"imsOrg": "string",
"meta:extensible": true,
"meta:abstract": true,
"meta:extends": ["string"
],
"meta:xdmType": "string",
"meta:registryMetadata": {"repo:createdDate": 0,
"repo:lastModifiedDate": 0,
"xdm:createdClientId": "string",
"xdm:lastModifiedClientId": "string",
"xdm:createdUserId": "string",
"xdm:lastModifiedUserId": "string",
"etag": "string",
"meta:globalLibVersion": "string",
"meta:usageCount": 0
},
"meta:immutableTags": ["union"
]
}

Delete a custom schema

You can remove an existing schema by performing a DELETE request. A successful deletion returns an empty response body and HTTP status 204 (No Content).

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

Request

path Parameters

SCHEMA_ID

required

string

The meta:altId or URL-encoded $id of the schema in question.

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 IMS 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 for more information.

Responses

204

No content

404

Not found

500

Internal server error

delete/tenant/schemas/{SCHEMA_ID}

Behaviors

Behaviors define the nature of data that a schema describes. Each XDM class must reference a specific behavior, which all schemas that employ that class will inherit. Schemas that inherit the "record" behavior provide information about the attributes of a subject, while those that inherit the "time-series" behavior provide a snapshot of the system at the time an action was taken by a record subject.

List behaviors

NOTE: For more information on using this operation, see the behaviors 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 IMS 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 for more information.

required

string

The desired response format. For listing calls, the following Accept header values are permitted:

Accept	Description
`application/vnd.adobe.xed-id+json`	Returns a short summary of each resource, generally the preferred header for listing.
`application/vnd.adobe.xed+json`	Returns full JSON for each resource, with the original `$ref` and `allOf` attributes included.

Responses

200

Success

400

Bad formatting

get/global/behaviors

Response samples

application/json

{"results": [{"$id": "https://ns.adobe.com/xdm/data/record",
"meta:altId": "_xdm.data.record",
"version": "1.16.4",
"title": "Record Schema"
},
{"$id": "https://ns.adobe.com/xdm/data/adhoc",
"meta:altId": "_xdm.data.adhoc",
"version": "1.16.4",
"title": "Ad Hoc Schema"
},
{"$id": "https://ns.adobe.com/xdm/data/time-series",
"meta:altId": "_xdm.data.time-series",
"version": "1.16.4",
"title": "Time-series Schema"
}
],
"_page": {"orderby": "updated",
"next": null,
"count": 3
},
"_links": {"next": null
}
}

Retrieve a behavior

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

Request

path Parameters

BEHAVIOR_ID

required

string

The meta:altId or URL-encoded $id of the behavior in question.

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 IMS 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 for more information.

required

string

The desired response format. For lookup requests, a version parameter must be included, with the following Accept header values being permitted:

Accept	Description
`application/vnd.adobe.xed+json; version=1`	Returns only the basic details of the resource, with all inherited fields relegated to `$ref` and `allOf` properties.
`application/vnd.adobe.xed-full+json; version=1`	Returns the full details of the resource, including the details all fields inherited from other resources.
`application/vnd.adobe.xed-notext+json; version=1`	Returns only the basic details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-notext+json; version=1`	Returns the full details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-desc+json; version=1`	Returns the full details of the resource, including descriptions but with no titles.

Responses

200

Success

400

Bad formatting

get/global/behaviors/{BEHAVIOR_ID}

Response samples

application/json

{"$id": "https://ns.adobe.com/xdm/data/record",
"meta:altId": "_xdm.data.record",
"meta:resourceType": "behaviors",
"version": "1.16.4",
"title": "Record Schema",
"type": "object",
"description": "Used to indicate the behavior of record data semantic when composed into data schemas.",
"definitions": {"record": {"properties": {"_id": {"title": "Identifier",
"type": "string",
"format": "uri-reference",
"description": "A unique identifier for the record.",
"meta:xdmType": "string",
"meta:xdmField": "@id"
}
}
}
},
"allOf": [{"$ref": "#/components/schemas/record"
},
{"$ref ": "https://ns.adobe.com/xdm/common/extensible%23/definitions/@context",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1606266789446,
"repo:lastModifiedDate": 1606266789446,
"eTag": "2cc114a54949a9668fe2ad046ccece59192e1bfa28f14e5ac7c893acb7820ba2",
"meta:globalLibVersion": "1.16.4"
}
}

Classes

Classes define behavioral aspects of the data within the schema and describe the smallest number of common properties contained in all schemas that implement the same class.

List classes

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

Request

path Parameters

CONTAINER_ID

required

string

The name of the container that you want to list resources from. To list core resources provided by Adobe, use global. To list custom resources defined by your organization, use tenant.

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. For example, `property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile` returns only field groups that are compatible with the XDM Individual Profile class.
orderby	string Sort the listed resources by specified fields. For example `orderby=title` sorts results by title in ascending order (A-Z). Adding a `-` before the field name (`orderby=-title`) sorts items in descending order (Z-A). Multiple fields can also be included to denote primary and secondary sort orders (for example, `orderby=title,description`).
start	string When used in conjunction with an `orderby` parameter, `start` specifies where the paginated list of items should begin. This parameter cannot be used without an `orderby` parameter present. Typically, this parameter is omitted in order to obtain the first page of results. After that, `start` should be set to the maximum value of the primary sort property of the `orderby` field received in the previous page. The API response then returns entries beginning with those that have a primary sort property from `orderby` strictly greater than (for ascending) or strictly less than (for descending) the specified value. For example, if the `orderby` parameter is set to `orderby=name,firstname`, the `start` parameter would contain a value for the `name` property. In this case, if you wanted to show the next 20 entries of a resource immediately following the name "Miller", you would use: `?orderby=name,firstname&start=Miller&limit=20`.
limit	number When used in conjunction with an `orderby` parameter, `limit` restricts the maximum number of items that should be returned for a given request. This parameter cannot be used without an `orderby` parameter present. The `limit` parameter specifies a positive integer (between `0` and `500`) as a hint as to the maximum number of items that should be returned. For example, `limit=5` returns only five resources in the list. However, this value is not strictly honored. The actual response size may be smaller or larger as constrained by the need to provide the reliable operation of the `start` parameter, if one is provided.

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 IMS 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 for more information.

required

string

The desired response format. For listing calls, the following Accept header values are permitted:

Accept	Description
`application/vnd.adobe.xed-id+json`	Returns a short summary of each resource, generally the preferred header for listing.
`application/vnd.adobe.xed+json`	Returns full JSON for each resource, with the original `$ref` and `allOf` attributes included.

Responses

200

Success

400

Bad formatting

get/{CONTAINER_ID}/classes

Response samples

application/json

{"results": [{"$id": "https://ns.adobe.com/experience/journeyOrchestration/stepEvents/journey",
"meta:altId": "_experience.journeyOrchestration.stepEvents.journey",
"meta:resourceType": "classes",
"version": "1.27.4",
"title": "Journey Orchestration Class",
"type": "object",
"description": "A Record based Journey class for Journey orchestration contains common journey fields",
"definitions": {"journeyClass": {"properties": { }
}
},
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/data/record",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "#/definitions/journeyClass",
"type": "object",
"meta:xdmType": "object"
}
],
"auditable": true,
"meta:extensible": true,
"meta:abstract": true,
"meta:extends": ["https://ns.adobe.com/xdm/data/record"
],
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1635361814823,
"repo:lastModifiedDate": 1635361814823,
"eTag": "351d2457ea40413a486ed6f328eb7f9384e63ded16019c7223e2586badf5a60a",
"meta:globalLibVersion": "1.27.4"
}
},
{"$id": "https://ns.adobe.com/experience/journeyOrchestration/stepEvents/journeyStepEvent",
"meta:altId": "_experience.journeyOrchestration.stepEvents.journeyStepEvent",
"meta:resourceType": "classes",
"version": "1.27.4",
"title": "Journey Step Event",
"type": "object",
"description": "A time-series based Journey Step Event Class.",
"definitions": {"journeyStepEventClass": {"properties": {"_experience": {"properties": {"journeyOrchestration": {"properties": {"serviceType": {"title": "Service Type",
"type": "string",
"description": "This fields identifies the type of event.",
"meta:xdmType": "string",
"meta:xdmField": "https://ns.adobe.com/experience/journeyOrchestration/serviceType"
}
},
"type": "object",
"meta:xdmType": "object",
"meta:xedConverted": true
}
},
"type": "object",
"meta:xdmType": "object",
"meta:xedConverted": true
}
}
}
},
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/data/time-series",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "#/definitions/journeyStepEventClass",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:extends": ["https://ns.adobe.com/xdm/data/time-series"
],
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1635361814826,
"repo:lastModifiedDate": 1635361814826,
"eTag": "f9b83a0cc1d6ccd240ee3aebaf332d98876a0d749746ef9bfc0af99c713d0b43",
"meta:globalLibVersion": "1.27.4"
}
}
],
"_page": {"orderby": "updated",
"next": null,
"count": 2
},
"_links": {"next": null
}
}

Retrieve a class

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

Request

path Parameters

CONTAINER_ID required	string The name of the container that you want to retrieve a resource from. To retrieve a core resource provided by Adobe, use `global`. To retrieve a custom resource defined by your organization, use `tenant`.
CLASS_ID required	string The `meta:altId` or URL-encoded `$id` of the class you want to look up.

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 IMS 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 for more information.

required

string

The desired response format. For lookup requests, a version parameter must be included, with the following Accept header values being permitted:

Accept	Description
`application/vnd.adobe.xed+json; version=1`	Returns only the basic details of the resource, with all inherited fields relegated to `$ref` and `allOf` properties.
`application/vnd.adobe.xed-full+json; version=1`	Returns the full details of the resource, including the details all fields inherited from other resources.
`application/vnd.adobe.xed-notext+json; version=1`	Returns only the basic details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-notext+json; version=1`	Returns the full details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-desc+json; version=1`	Returns the full details of the resource, including descriptions but with no titles.

Responses

200

Success

400

Bad formatting

404

Not found

get/{CONTAINER_ID}/classes/{CLASS_ID}

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/classes/9731ca27f72801dc6e9d6a170df94745",
"meta:altId": "_{TENANT_ID}.classes.9731ca27f72801dc6e9d6a170df94745",
"meta:resourceType": "classes",
"version": "1.0",
"title": "Luma Product Class",
"type": "object",
"description": "A custom product class for the Luma brand.",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/data/record"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extensible": true,
"meta:abstract": true,
"meta:extends": ["https://ns.adobe.com/xdm/data/record"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1569014354925,
"repo:lastModifiedDate": 1569014354925,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "3afbb3e8e4ea2ce02a2ba2fa31727a59a7a6d7d1ec70b62ca711058c26829761",
"meta:globalLibVersion": "1.27.4"
},
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Create a custom class

NOTE: For more information on using this operation, see the classes 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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The request payload must include an allOf attribute referencing either 'https://ns.adobe.com/xdm/data/record' or 'https://ns.adobe.com/xdm/data/time-series'. This value represents the data behavior upon which the class is based. allOf may also optionally include field groups or custom fields that will be included each time the class is used.

type required	string The JSON Schema data type for the payload. Must be set to `object`.
title required	string A title for the class.
description required	string A description for the class.
required	Array of objects Lists the behavior that the class inherits along with any additional class-level fields.

Responses

201

Success

400

Bad formatting

post/tenant/classes

Request samples

Payload

application/json

{"type": "object",
"title": "New Class",
"description": "Description of the new class.",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/data/record"
}
]
}

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/classes/9731ca27f72801dc6e9d6a170df94745",
"meta:altId": "_{TENANT_ID}.classes.9731ca27f72801dc6e9d6a170df94745",
"meta:resourceType": "classes",
"version": "1.0",
"title": "New Class",
"type": "object",
"description": "Description of the new class.",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/data/record"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extensible": true,
"meta:abstract": true,
"meta:extends": ["https://ns.adobe.com/xdm/data/record"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1569014354925,
"repo:lastModifiedDate": 1569014354925,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "3afbb3e8e4ea2ce02a2ba2fa31727a59a7a6d7d1ec70b62ca711058c26829761",
"meta:globalLibVersion": "1.27.4"
},
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Update a custom class

A PUT request essentially re-writes the class, therefore the request body must include all fields required to create (POST) a class. This is especially useful when updating a lot of information in the class at once.

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

Request

path Parameters

CLASS_ID

required

string

The meta:altId or URL-encoded $id of the class you want to update.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The JSON payload must include all of the fields that were originally required for creating the class, but with updated values. This includes an allOf attribute referencing the behavior of the class.

type required	string The JSON Schema data type for the payload. Must be set to `object`.
title required	string A title for the class.
description required	string A description for the class.
required	Array of objects Lists the behavior that the class inherits along with any additional class-level fields.

Responses

200

Success

400

Bad formatting

put/tenant/classes/{CLASS_ID}

Request samples

Payload

application/json

{"type": "object",
"title": "New Class",
"description": "Updated description of the new class.",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/data/time-series"
}
]
}

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/classes/9731ca27f72801dc6e9d6a170df94745",
"meta:altId": "_{TENANT_ID}.classes.9731ca27f72801dc6e9d6a170df94745",
"meta:resourceType": "classes",
"version": "1.0",
"title": "New Class",
"type": "object",
"description": "Updated description of the new class.",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/data/time-series"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extensible": true,
"meta:abstract": true,
"meta:extends": ["https://ns.adobe.com/xdm/data/time-series"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1569014354925,
"repo:lastModifiedDate": 1569014354925,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "3afbb3e8e4ea2ce02a2ba2fa31727a59a7a6d7d1ec70b62ca711058c26829761",
"meta:globalLibVersion": "1.27.4"
},
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Update one or more attributes of a custom class

You can use this endpoint to update one or more attributes for a custom class. The Schema Registry supports all standard JSON Patch operations, including add, remove, and replace, to allow users to modify or update classes they have defined.

NOTE: For more information on JSON Patch, including all available operations, please refer to the the official JSON Patch specification. > >For more information on using this operation, see the classes endpoint guide on Experience League.

Request

path Parameters

CLASS_ID

required

string

The meta:altId or URL-encoded $id of the class you want to update.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The request body accepts a JSON Patch payload.

Array

op required	string The JSON Patch operation to be performed.
path required	string The path to the field that the operation should be performed on.
value	string If adding or updating an attribute, this property indicates the value that should be set for that property.

Responses

200

Success

400

Bad formatting

patch/tenant/classes/{CLASS_ID}

Request samples

Payload

application/json

[{"op": "replace",
"path": "description",
"value": "A PATCH-updated description for the class."
}
]

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/classes/9731ca27f72801dc6e9d6a170df94745",
"meta:altId": "_{TENANT_ID}.classes.9731ca27f72801dc6e9d6a170df94745",
"meta:resourceType": "classes",
"version": "1.0",
"title": "New Class",
"type": "object",
"description": "A PATCH-updated description of the new class.",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/data/record"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extensible": true,
"meta:abstract": true,
"meta:extends": ["https://ns.adobe.com/xdm/data/record"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1569014354925,
"repo:lastModifiedDate": 1569014354925,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "3afbb3e8e4ea2ce02a2ba2fa31727a59a7a6d7d1ec70b62ca711058c26829761",
"meta:globalLibVersion": "1.27.4"
},
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Delete a custom class

Remove a class by performing a DELETE request to the $id of the class being removed.

A successful deletion returns an empty response body and HTTP status 204 (No Content).

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

Request

path Parameters

CLASS_ID

required

string

The meta:altId or URL-encoded $id of the class you want to delete.

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 IMS 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 for more information.

Responses

204

No content

404

Not found

delete/tenant/classes/{CLASS_ID}

Field groups

A field group is a reusable component that defines one or more fields to implement certain functions within a schema based on a compatible class.

List field groups

Retrieve a list of field groups within the specified container.

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

Request

path Parameters

CONTAINER_ID

required

string

The name of the container that you want to list resources from. To list core resources provided by Adobe, use global. To list custom resources defined by your organization, use tenant.

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. For example, `property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile` returns only field groups that are compatible with the XDM Individual Profile class.
orderby	string Sort the listed resources by specified fields. For example `orderby=title` sorts results by title in ascending order (A-Z). Adding a `-` before the field name (`orderby=-title`) sorts items in descending order (Z-A). Multiple fields can also be included to denote primary and secondary sort orders (for example, `orderby=title,description`).
start	string When used in conjunction with an `orderby` parameter, `start` specifies where the paginated list of items should begin. This parameter cannot be used without an `orderby` parameter present. Typically, this parameter is omitted in order to obtain the first page of results. After that, `start` should be set to the maximum value of the primary sort property of the `orderby` field received in the previous page. The API response then returns entries beginning with those that have a primary sort property from `orderby` strictly greater than (for ascending) or strictly less than (for descending) the specified value. For example, if the `orderby` parameter is set to `orderby=name,firstname`, the `start` parameter would contain a value for the `name` property. In this case, if you wanted to show the next 20 entries of a resource immediately following the name "Miller", you would use: `?orderby=name,firstname&start=Miller&limit=20`.
limit	number When used in conjunction with an `orderby` parameter, `limit` restricts the maximum number of items that should be returned for a given request. This parameter cannot be used without an `orderby` parameter present. The `limit` parameter specifies a positive integer (between `0` and `500`) as a hint as to the maximum number of items that should be returned. For example, `limit=5` returns only five resources in the list. However, this value is not strictly honored. The actual response size may be smaller or larger as constrained by the need to provide the reliable operation of the `start` parameter, if one is provided.

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 IMS 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 for more information.

required

string

The desired response format. For listing calls, the following Accept header values are permitted:

Accept	Description
`application/vnd.adobe.xed-id+json`	Returns a short summary of each resource, generally the preferred header for listing.
`application/vnd.adobe.xed+json`	Returns full JSON for each resource, with the original `$ref` and `allOf` attributes included.

Responses

200

Success

400

Bad formatting

get/{CONTAINER_ID}/fieldgroups

Response samples

application/json

{"results": [{"$id": "https://ns.adobe.com/xdm/context/profile-person-details",
"meta:altId": "_xdm.context.profile-person-details",
"meta:resourceType": "mixins",
"version": "1.27.4",
"title": "Demographic Details",
"type": "object",
"description": "Demographic information such as name, gender, and birth date of an individual.",
"definitions": {"profile-person-details": {"properties": {"person": {"title": "Person",
"$ref ": "https://ns.adobe.com/xdm/context/person",
"description": "An individual actor, contact, or owner.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:person"
}
}
}
},
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "#/definitions/profile-person-details",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1635361816945,
"repo:lastModifiedDate": 1635361816945,
"eTag": "9f6a76cf4e115d0a3db3900fb418979ebea28bce47967484a1a0b2a2c32514cb",
"meta:globalLibVersion": "1.27.4",
"meta:usageCount": 316
},
"meta:tags": {"industry": ["all"
]
},
"meta:createdDate": "2020-08-10"
},
{"$id": "https://ns.adobe.com/xdm/context/profile-personal-details",
"meta:altId": "_xdm.context.profile-personal-details",
"meta:resourceType": "mixins",
"version": "1.27.4",
"title": "Personal Contact Details",
"type": "object",
"description": "Contact information for an individual person such as home address, phone number, fax, and email.",
"definitions": {"profile-personal-details": {"properties": {"faxPhone": {"title": "Fax phone",
"$ref ": "https://ns.adobe.com/xdm/context/phonenumber",
"description": "Fax phone number.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:faxPhone"
},
"homeAddress": {"title": "Home address",
"$ref ": "https://ns.adobe.com/xdm/common/address",
"description": "A home postal address.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:homeAddress"
},
"homePhone": {"title": "Home phone",
"$ref ": "https://ns.adobe.com/xdm/context/phonenumber",
"description": "Home phone number.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:homePhone"
},
"mobilePhone": {"title": "Mobile phone",
"$ref ": "https://ns.adobe.com/xdm/context/phonenumber",
"description": "Mobile phone number.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:mobilePhone"
},
"personalEmail": {"title": "Personal email",
"$ref ": "https://ns.adobe.com/xdm/context/emailaddress",
"description": "A personal email address.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:personalEmail"
}
}
}
},
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "#/definitions/profile-personal-details",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1635361816961,
"repo:lastModifiedDate": 1635361816961,
"eTag": "750a04f69224e9fab367c6663199218dbd524852652627756284b4333fd7b27b",
"meta:globalLibVersion": "1.27.4",
"meta:usageCount": 300
},
"meta:tags": {"industry": ["all"
]
},
"meta:createdDate": "2020-08-10"
}
],
"_page": {"orderby": "updated",
"next": null,
"count": 2
},
"_links": {"next": null
}
}

Retrieve a field group

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

Request

path Parameters

CONTAINER_ID required	string The name of the container that you want to retrieve a resource from. To retrieve a core resource provided by Adobe, use `global`. To retrieve a custom resource defined by your organization, use `tenant`.
FIELD_GROUP_ID required	string The `meta:altId` or URL-encoded `$id` of the field group you want to look up.

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 IMS 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 for more information.

required

string

The desired response format. For lookup requests, a version parameter must be included, with the following Accept header values being permitted:

Accept	Description
`application/vnd.adobe.xed+json; version=1`	Returns only the basic details of the resource, with all inherited fields relegated to `$ref` and `allOf` properties.
`application/vnd.adobe.xed-full+json; version=1`	Returns the full details of the resource, including the details all fields inherited from other resources.
`application/vnd.adobe.xed-notext+json; version=1`	Returns only the basic details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-notext+json; version=1`	Returns the full details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-desc+json; version=1`	Returns the full details of the resource, including descriptions but with no titles.

Responses

200

Success

400

Bad formatting

get/{CONTAINER_ID}/fieldgroups/{FIELD_GROUP_ID}

Response samples

application/json

{"$id": "https://ns.adobe.com/xdm/context/profile-person-details",
"meta:altId": "_xdm.context.profile-person-details",
"meta:resourceType": "mixins",
"version": "1.22.3",
"title": "Demographic Details",
"type": "object",
"description": "Demographic information such as name, gender, and birth date of an individual.",
"definitions": {"profile-person-details": {"properties": {"person": {"title": "Person",
"$ref ": "https://ns.adobe.com/xdm/context/person",
"description": "An individual actor, contact, or owner.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:person"
}
}
}
},
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/common/extensible%23/definitions/@context",
"type": "object",
"meta:xdmType": "object"
},
{"$ref": "#/components/schemas/profile-person-details"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1620758109174,
"repo:lastModifiedDate": 1620758109174,
"eTag": "f5b20a7edefab1c4b1a86fbd4de91570b57d36b9f2c6deb3225a18d14fafce3b",
"meta:globalLibVersion": "1.22.3",
"meta:usageCount": 29
},
"meta:tags": {"industry": ["all"
]
},
"meta:createdDate": "2020-08-10"
}

Create a custom field group

NOTE: For more information on using this operation, see the field groups 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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The JSON payload must include a 'meta:intendedToExtend' field listing the '$id' of the class(es) with which the field group is compatible.

type required	string The JSON Schema data type for the field group. Must be set to `object`.
title required	string A title for the field group.
description	string A description for the field group.
meta:intendedToExtend required	Array of strings Contains the `$id` value(s) of the class(es) that this field group is compatible with.
definitions	object Describes the unique attributes provided by the field group that are not inherited from other XDM resources. Custom attributes must be nested under `properties._{TENANT_ID}` to avoid collisions with similar fields provided by classes and other field groups. For details on how to define different field types to include in your field group, see the field constraints guide.
	Array of objects A list of reference strings that determine the attributes that the field group provides. A string can refer to a custom field definition provided under the `definitions` object (e.g. `#/definitions/property`) or the `$id` of another field group or data type that this field group extends or employs.

Responses

201

Success

400

Bad formatting

post/tenant/fieldgroups

Request samples

Payload

application/json

{"type": "object",
"title": "Property Details",
"description": "Detailed information related to the properties owned and operated by the company.",
"meta:intendedToExtend": ["https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
],
"definitions": {"property": {"properties": {"_{TENANT_ID}": {"type": "object",
"properties": {"propertyName": {"type": "string",
"title": "Property Name",
"description": "Name of the property"
},
"propertyCity": {"title": "Property City",
"description": "City where the property is located.",
"type": "string"
},
"phoneNumber": {"title": "Phone Number",
"description": "Primary phone number for the property.",
"type": "string"
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type and primary use of property.",
"enum": ["retail",
"yoga",
"fitness"
],
"meta:enum": {"retail": "Retail Store",
"yoga": "Yoga Studio",
"fitness": "Fitness Center"
}
},
"propertyConstruction": {"$ref ": "https://ns.adobe.com/{TENANT_ID}/datatypes/24c643f618647344606222c494bd0102"
}
}
}
}
}
},
"allOf": [{"$ref": "#/definitions/property"
}
]
}

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/mixins/8779fd45d6e4eb074300023a439862bbba359b60d451627a",
"meta:altId": "_{TENANT_ID}.mixins.8779fd45d6e4eb074300023a439862bbba359b60d451627a",
"meta:resourceType": "mixins",
"version": "1.2",
"title": "Property Details",
"type": "object",
"description": "Detailed information related to the properties owned and operated by the company.",
"definitions": {"property": {"properties": {"_{TENANT_ID}": {"type": "object",
"properties": {"propertyName": {"type": "string",
"title": "Property Name",
"description": "Name of the property"
},
"propertyCity": {"title": "Property City",
"description": "City where the property is located.",
"type": "string"
},
"phoneNumber": {"title": "Phone Number",
"description": "Primary phone number for the property.",
"type": "string"
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type and primary use of property.",
"enum": ["retail",
"yoga",
"fitness"
],
"meta:enum": {"retail": "Retail Store",
"yoga": "Yoga Studio",
"fitness": "Fitness Center"
}
},
"propertyConstruction": {"$ref ": "https://ns.adobe.com/{TENANT_ID}/datatypes/24c643f618647344606222c494bd0102"
}
}
}
}
}
},
"allOf": [{"$ref ": "#/definitions/customFields",
"type": "object",
"meta:xdmType": "object"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1594941263588,
"repo:lastModifiedDate": 1594941538433,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "5e8a5e508eb2ed344c08cb23ed27cfb60c841bec59a2f7513deda0f7af903021",
"meta:globalLibVersion": "1.15.4"
},
"meta:containerId": "tenant",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Update a custom field group

A PUT request essentially re-writes the field group, therefore the request body must include all fields required to create (POST) a field group. This is especially useful when updating a lot of information in the field group at once.

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

Request

path Parameters

FIELD_GROUP_ID

required

string

The meta:altId or URL-encoded $id of the field group you want to update.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The JSON payload must include all of the fields that were originally required for creating the field group, but with updated values. This includes an allOf attribute referencing the $id of the class the schema will implement.

type required	string The JSON Schema data type for the field group. Must be set to `object`.
title required	string A title for the field group.
description	string A description for the field group.
meta:intendedToExtend required	Array of strings Contains the `$id` value(s) of the class(es) that this field group is compatible with.
definitions	object Describes the unique attributes provided by the field group that are not inherited from other XDM resources. Custom attributes must be nested under `properties._{TENANT_ID}` to avoid collisions with similar fields provided by classes and other field groups. For details on how to define different field types to include in your field group, see the field constraints guide.
	Array of objects A list of reference strings that determine the attributes that the field group provides. A string can refer to a custom field definition provided under the `definitions` object (e.g. `#/definitions/property`) or the `$id` of another field group or data type that this field group extends or employs.

Responses

200

Success

400

Bad formatting

put/tenant/fieldgroups/{FIELD_GROUP_ID}

Request samples

Payload

application/json

{"type": "object",
"title": "Property Details",
"description": "Detailed information related to the properties owned and operated by the company.",
"meta:intendedToExtend": ["https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
],
"definitions": {"property": {"properties": {"_{TENANT_ID}": {"type": "object",
"properties": {"propertyName": {"type": "string",
"title": "Property Name",
"description": "Name of the property"
},
"propertyCity": {"title": "Property City",
"description": "City where the property is located.",
"type": "string"
},
"phoneNumber": {"title": "Phone Number",
"description": "Primary phone number for the property.",
"type": "string"
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type and primary use of property.",
"enum": ["retail",
"yoga",
"fitness"
],
"meta:enum": {"retail": "Retail Store",
"yoga": "Yoga Studio",
"fitness": "Fitness Center"
}
},
"propertyConstruction": {"$ref ": "https://ns.adobe.com/{TENANT_ID}/datatypes/24c643f618647344606222c494bd0102"
}
}
}
}
}
},
"allOf": [{"$ref": "#/definitions/property"
}
]
}

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/mixins/8779fd45d6e4eb074300023a439862bbba359b60d451627a",
"meta:altId": "_{TENANT_ID}.mixins.8779fd45d6e4eb074300023a439862bbba359b60d451627a",
"meta:resourceType": "mixins",
"version": "1.3",
"title": "Property Details",
"type": "object",
"description": "Detailed information related to the properties owned and operated by the company.",
"definitions": {"property": {"properties": {"_{TENANT_ID}": {"type": "object",
"properties": {"propertyName": {"type": "string",
"title": "Property Name",
"description": "Name of the property"
},
"propertyCity": {"title": "Property City",
"description": "City where the property is located.",
"type": "string"
},
"phoneNumber": {"title": "Phone Number",
"description": "Primary phone number for the property.",
"type": "string"
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type and primary use of property.",
"enum": ["retail",
"yoga",
"fitness"
],
"meta:enum": {"retail": "Retail Store",
"yoga": "Yoga Studio",
"fitness": "Fitness Center"
}
},
"propertyConstruction": {"$ref ": "https://ns.adobe.com/{TENANT_ID}/datatypes/24c643f618647344606222c494bd0102"
}
}
}
}
}
},
"allOf": [{"$ref ": "#/definitions/customFields",
"type": "object",
"meta:xdmType": "object"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1594941263588,
"repo:lastModifiedDate": 1594941538433,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "5e8a5e508eb2ed344c08cb23ed27cfb60c841bec59a2f7513deda0f7af903021",
"meta:globalLibVersion": "1.15.4"
},
"meta:containerId": "tenant",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Update a custom field group

You can use this endpoint to update one or more attributes of your custom field group. The Schema Registry supports all standard JSON Patch operations, including add, remove, and replace, to allow you to modify or update resources you have defined.

NOTE: For more information on JSON Patch, including all available operations, please refer to the the official JSON Patch specification. > >For more information on using this operation, see the field groups endpoint guide on Experience League.

Request

path Parameters

FIELD_GROUP_ID

required

string

The meta:altId or URL-encoded $id of the field group you want to update.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The request body accepts a JSON Patch payload.

Array

op required	string The JSON Patch operation to be performed.
path required	string The path to the field that the operation should be performed on.
value	string If adding or updating an attribute, this property indicates the value that should be set for that property.

Responses

200

Success

400

Bad formatting

patch/tenant/fieldgroups/{FIELD_GROUP_ID}

Request samples

Payload

application/json

[{"op": "add",
"path": "/definitions/property/properties/_{TENANT_ID}/properties/propertyCity",
"value": {"title": "Property Country",
"description": "The country where the property is located.",
"type": "string"
}
}
]

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/mixins/8779fd45d6e4eb074300023a439862bbba359b60d451627a",
"meta:altId": "_{TENANT_ID}.mixins.8779fd45d6e4eb074300023a439862bbba359b60d451627a",
"meta:resourceType": "mixins",
"version": "1.3",
"title": "Property Details",
"type": "object",
"description": "Detailed information related to the properties owned and operated by the company.",
"definitions": {"property": {"properties": {"_{TENANT_ID}": {"type": "object",
"properties": {"propertyName": {"type": "string",
"title": "Property Name",
"description": "Name of the property"
},
"propertyCity": {"title": "Property City",
"description": "City where the property is located.",
"type": "string"
},
"phoneNumber": {"title": "Phone Number",
"description": "Primary phone number for the property.",
"type": "string"
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type and primary use of property.",
"enum": ["retail",
"yoga",
"fitness"
],
"meta:enum": {"retail": "Retail Store",
"yoga": "Yoga Studio",
"fitness": "Fitness Center"
}
},
"propertyConstruction": {"$ref ": "https://ns.adobe.com/{TENANT_ID}/datatypes/24c643f618647344606222c494bd0102"
},
"propertyCountry": {"title": "Property Country",
"description": "Country where the property is located.",
"type": "string"
}
}
}
}
}
},
"allOf": [{"$ref ": "#/definitions/customFields",
"type": "object",
"meta:xdmType": "object"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1594941263588,
"repo:lastModifiedDate": 1594941538433,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "5e8a5e508eb2ed344c08cb23ed27cfb60c841bec59a2f7513deda0f7af903021",
"meta:globalLibVersion": "1.15.4"
},
"meta:containerId": "tenant",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Delete a custom field group

You can remove an existing field group through a DELETE request. A successful deletion returns an empty response body and HTTP status 204 (No Content).

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

Request

path Parameters

FIELD_GROUP_ID

required

string

The meta:altId or URL-encoded $id of the field group you want to delete.

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 IMS 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 for more information.

Responses

204

No content

delete/tenant/fieldgroups/{FIELD_GROUP_ID}

Data types

Data types are used as reference field types in classes or schemas to define complex types. Data types may define multiple sub-fields providing a consistent multi-field structure.

List data types

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

Request

path Parameters

CONTAINER_ID

required

string

The name of the container that you want to list resources from. To list core resources provided by Adobe, use global. To list custom resources defined by your organization, use tenant.

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. For example, `property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile` returns only field groups that are compatible with the XDM Individual Profile class.
orderby	string Sort the listed resources by specified fields. For example `orderby=title` sorts results by title in ascending order (A-Z). Adding a `-` before the field name (`orderby=-title`) sorts items in descending order (Z-A). Multiple fields can also be included to denote primary and secondary sort orders (for example, `orderby=title,description`).
start	string When used in conjunction with an `orderby` parameter, `start` specifies where the paginated list of items should begin. This parameter cannot be used without an `orderby` parameter present. Typically, this parameter is omitted in order to obtain the first page of results. After that, `start` should be set to the maximum value of the primary sort property of the `orderby` field received in the previous page. The API response then returns entries beginning with those that have a primary sort property from `orderby` strictly greater than (for ascending) or strictly less than (for descending) the specified value. For example, if the `orderby` parameter is set to `orderby=name,firstname`, the `start` parameter would contain a value for the `name` property. In this case, if you wanted to show the next 20 entries of a resource immediately following the name "Miller", you would use: `?orderby=name,firstname&start=Miller&limit=20`.
limit	number When used in conjunction with an `orderby` parameter, `limit` restricts the maximum number of items that should be returned for a given request. This parameter cannot be used without an `orderby` parameter present. The `limit` parameter specifies a positive integer (between `0` and `500`) as a hint as to the maximum number of items that should be returned. For example, `limit=5` returns only five resources in the list. However, this value is not strictly honored. The actual response size may be smaller or larger as constrained by the need to provide the reliable operation of the `start` parameter, if one is provided.

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 IMS 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 for more information.

required

string

The desired response format. For listing calls, the following Accept header values are permitted:

Accept	Description
`application/vnd.adobe.xed-id+json`	Returns a short summary of each resource, generally the preferred header for listing.
`application/vnd.adobe.xed+json`	Returns full JSON for each resource, with the original `$ref` and `allOf` attributes included.

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

Success

400

Bad formatting

get/{CONTAINER_ID}/datatypes

Response samples

application/json

{"results": [{"$id": "https://ns.adobe.com/xdm/context/webinfo",
"meta:altId": "_xdm.context.webinfo",
"meta:resourceType": "datatypes",
"version": "1.27.4",
"title": "Web information",
"type": "object",
"description": "",
"definitions": {"webinfo": {"properties": {"webInteraction": {"title": "Web interaction",
"type": "object",
"description": "Details about the web link or URL that corresponds to where the interaction occurred.",
"properties": {"URL": {"title": "URL",
"type": "string",
"description": "The actual link or URL used for this web interaction.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:URL"
},
"linkClicks": {"title": "Link Clicks",
"$ref ": "https://ns.adobe.com/xdm/data/measure",
"description": "Click of a web link has occurred.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:linkClicks"
},
"name": {"title": "Name",
"type": "string",
"description": "The normative name used for this web link, used for classification purposes.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:name"
},
"region": {"title": "Region",
"type": "string",
"description": "The region name represents the region or area of a document that the web link belongs to such as header or footer.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:region"
},
"type": {"title": "Type",
"type": "string",
"description": "The link type.",
"enum": ["download",
"exit",
"other"
],
"meta:enum": {"download": "Download",
"exit": "Exit",
"other": "Other"
},
"meta:xdmType": "string",
"meta:xdmField": "xdm:type"
}
},
"meta:xdmType": "object",
"meta:xdmField": "xdm:webInteraction"
},
"webPageDetails": {"title": "Web page details",
"type": "object",
"description": "Details about the web page where the web interaction occurred.",
"properties": {"URL": {"title": "URL",
"type": "string",
"description": "The normative or usual URL of the web page.  This may or may not be the actual URL used to reach the page, which would be recorded using `Web Link`.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:URL"
},
"isErrorPage": {"title": "Is error page",
"type": "boolean",
"description": "Flag that indicate if the page is error page or not.  Error here is defined by the application, and may nor may not correspond to a page served with an HTTP error code.  This flag is used to broadly categorize web interactions.",
"meta:xdmType": "boolean",
"meta:xdmField": "xdm:isErrorPage"
},
"isHomePage": {"title": "Is home page",
"type": "boolean",
"description": "Flag that indicate if the page is the site home page or not.  The definition of home page is determined by the application, but is commonly used to designate a top level landing page or common site entry point.  This flag is used to broadly categorize web interactions.",
"meta:xdmType": "boolean",
"meta:xdmField": "xdm:isHomePage"
},
"name": {"title": "Name",
"type": "string",
"description": "The normative name of the web page. This name is not necessarily the page title or directly associate with page content, but is used to organize a site's pages for classification purposes.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:name"
},
"pageViews": {"title": "Page Views",
"$ref ": "https://ns.adobe.com/xdm/data/measure",
"description": "View(s) of a webpage has occurred.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:pageViews"
},
"server": {"title": "Server",
"type": "string",
"description": "The normative or usual server that hosts the web page.  This may or may not be the host or server that actually served the page interaction, but is used for classification purposes.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:server"
},
"siteSection": {"title": "Site section",
"type": "string",
"description": "The normative name of the site section where this web page resides, which may be used to classify or categorize the interaction.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:siteSection"
},
"viewName": {"title": "View Name",
"type": "string",
"description": "The name of the view, within a page. This is commonly used with Single Page Applications or pages that have tabs or controls that change a majority of the page layout.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:viewName"
}
},
"meta:xdmType": "object",
"meta:xdmField": "xdm:webPageDetails"
},
"webReferrer": {"title": "Web referrer",
"type": "object",
"description": "The referrer of a web interaction, which is the URL a visitor came from immediately before the current web interaction was recorded.",
"properties": {"URL": {"title": "URL",
"type": "string",
"description": "The referrer URL.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:URL"
},
"type": {"title": "Type",
"type": "string",
"description": "The referrer type.",
"enum": ["internal",
"external",
"search_engine",
"typed_bookmarked",
"email",
"social",
"unknown",
"usenet"
],
"meta:enum": {"internal": "Internal",
"external": "External",
"search_engine": "Search engine",
"typed_bookmarked": "Typed or bookmarked",
"email": "Email",
"social": "Social network",
"unknown": "Unknown",
"news": "Usenet newsgroup"
},
"meta:xdmType": "string",
"meta:xdmField": "xdm:type"
}
},
"meta:xdmType": "object",
"meta:xdmField": "xdm:webReferrer"
}
}
}
},
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "#/definitions/webinfo",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1635361816390,
"repo:lastModifiedDate": 1635361816390,
"eTag": "9acb5ce67a37306d5b50f4d7d714ddac2bb30b4dcf8ccbef7affbb887b9f2677",
"meta:globalLibVersion": "1.27.4",
"meta:usageCount": 11
},
"meta:createdDate": "2021-02-19"
},
{"$id": "https://ns.adobe.com/xdm/content/productlistitem",
"meta:altId": "_xdm.content.productlistitem",
"meta:resourceType": "datatypes",
"version": "1.27.4",
"title": "Product list item",
"type": "object",
"description": "The product list item represents a product selected by a customer with specific options, pricing, usage context for a specific point of time and may differ from the product record. For example the product record contains details from the product information system that are consistent for all customers, where the product list item has the actual price offered to the customer at that time which may vary due to sales campaigns or seasonal pricing.",
"definitions": {"productlistitem": {"properties": {"_id": {"title": "Line item ID.",
"type": "string",
"format": "uri-reference",
"description": "The line item identifier for this product entry. The product itself is identified through `xdm:product`.",
"meta:xdmType": "string",
"meta:xdmField": "@id"
},
"SKU": {"title": "SKU",
"type": "string",
"description": "Stock keeping unit (SKU), the unique identifier for a product defined by the vendor.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:SKU"
},
"currencyCode": {"title": "Currency code",
"type": "string",
"examples": ["USD",
"EUR"
],
"pattern": "^[A-Z]{3}$",
"description": "The ISO 4217 alphabetic currency code used for pricing the product.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:currencyCode"
},
"name": {"title": "Name",
"type": "string",
"description": "The display name for the product as presented to the user for this product view.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:name"
},
"priceTotal": {"title": "Price total",
"type": "number",
"description": "The total price for the product line item.",
"meta:xdmType": "number",
"meta:xdmField": "xdm:priceTotal"
},
"product": {"title": "Product",
"type": "string",
"format": "uri",
"description": "The XDM identifier of the product itself.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:product"
},
"productAddMethod": {"title": "Product add method",
"type": "string",
"description": "The method that was used to add a product item to the list by the visitor. Set with product list add metrics.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:productAddMethod"
},
"quantity": {"title": "Quantity",
"type": "integer",
"description": "The number of units the customer has indicated they require of the product.",
"meta:xdmType": "int",
"meta:xdmField": "xdm:quantity"
}
},
"required": ["SKU"
]
}
},
"allOf": [{"$ref ": "#/definitions/productlistitem",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "https://ns.adobe.com/xdm/mixins/product-measurement#/definitions/uomcode",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1635361816394,
"repo:lastModifiedDate": 1635361816394,
"eTag": "ba11c63e004dd1db02b7475cf2908b2611890f2e7bd139e31ff064bb424c24c7",
"meta:globalLibVersion": "1.27.4",
"meta:usageCount": 33
},
"meta:createdDate": "2021-02-19"
}
],
"_page": {"orderby": "updated",
"next": null,
"count": 2
},
"_links": {"next": null
}
}

Retrieve a data type

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

Request

path Parameters

CONTAINER_ID required	string The name of the container that you want to retrieve a resource from. To retrieve a core resource provided by Adobe, use `global`. To retrieve a custom resource defined by your organization, use `tenant`.
DATA_TYPE_ID required	string The `meta:altId` or URL-encoded `$id` of the data type in question.

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 IMS 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 for more information.

required

string

The desired response format. For lookup requests, a version parameter must be included, with the following Accept header values being permitted:

Accept	Description
`application/vnd.adobe.xed+json; version=1`	Returns only the basic details of the resource, with all inherited fields relegated to `$ref` and `allOf` properties.
`application/vnd.adobe.xed-full+json; version=1`	Returns the full details of the resource, including the details all fields inherited from other resources.
`application/vnd.adobe.xed-notext+json; version=1`	Returns only the basic details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-notext+json; version=1`	Returns the full details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-desc+json; version=1`	Returns the full details of the resource, including descriptions but with no titles.

Responses

200

Success

400

Bad formatting

get/{CONTAINER_ID}/datatypes/{DATA_TYPE_ID}

Response samples

application/json

{"$id": "https://ns.adobe.com/xdm/content/productlistitem",
"meta:altId": "_xdm.content.productlistitem",
"meta:resourceType": "datatypes",
"version": "1.27.4",
"title": "Product list item",
"type": "object",
"description": "The product list item represents a product selected by a customer with specific options, pricing, usage context for a specific point of time and may differ from the product record. For example the product record contains details from the product information system that are consistent for all customers, where the product list item has the actual price offered to the customer at that time which may vary due to sales campaigns or seasonal pricing.",
"definitions": {"productlistitem": {"properties": {"_id": {"title": "Line item ID.",
"type": "string",
"format": "uri-reference",
"description": "The line item identifier for this product entry. The product itself is identified through `xdm:product`.",
"meta:xdmType": "string",
"meta:xdmField": "@id"
},
"SKU": {"title": "SKU",
"type": "string",
"description": "Stock keeping unit (SKU), the unique identifier for a product defined by the vendor.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:SKU"
},
"currencyCode": {"title": "Currency code",
"type": "string",
"examples": ["USD",
"EUR"
],
"pattern": "^[A-Z]{3}$",
"description": "The ISO 4217 alphabetic currency code used for pricing the product.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:currencyCode"
},
"name": {"title": "Name",
"type": "string",
"description": "The display name for the product as presented to the user for this product view.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:name"
},
"priceTotal": {"title": "Price total",
"type": "number",
"description": "The total price for the product line item.",
"meta:xdmType": "number",
"meta:xdmField": "xdm:priceTotal"
},
"product": {"title": "Product",
"type": "string",
"format": "uri",
"description": "The XDM identifier of the product itself.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:product"
},
"productAddMethod": {"title": "Product add method",
"type": "string",
"description": "The method that was used to add a product item to the list by the visitor. Set with product list add metrics.",
"meta:xdmType": "string",
"meta:xdmField": "xdm:productAddMethod"
},
"quantity": {"title": "Quantity",
"type": "integer",
"description": "The number of units the customer has indicated they require of the product.",
"meta:xdmType": "int",
"meta:xdmField": "xdm:quantity"
}
},
"required": ["SKU"
]
}
},
"allOf": [{"$ref ": "#/definitions/productlistitem",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "https://ns.adobe.com/xdm/mixins/product-measurement#/definitions/uomcode",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1635361816394,
"repo:lastModifiedDate": 1635361816394,
"eTag": "ba11c63e004dd1db02b7475cf2908b2611890f2e7bd139e31ff064bb424c24c7",
"meta:globalLibVersion": "1.27.4",
"meta:usageCount": 33
},
"meta:createdDate": "2021-02-19"
}

Create a custom data type

NOTE: For more information on using this operation, see the data types 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 IMS 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 for more information.

required

string

The desired response format. For lookup requests, a version parameter must be included, with the following Accept header values being permitted:

Accept	Description
`application/vnd.adobe.xed+json; version=1`	Returns only the basic details of the resource, with all inherited fields relegated to `$ref` and `allOf` properties.
`application/vnd.adobe.xed-full+json; version=1`	Returns the full details of the resource, including the details all fields inherited from other resources.
`application/vnd.adobe.xed-notext+json; version=1`	Returns only the basic details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-notext+json; version=1`	Returns the full details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-desc+json; version=1`	Returns the full details of the resource, including descriptions but with no titles.

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.

Content-Type

required

string

The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of application/json.

Request Body schema: application/json
required

Unlike field groups, defining a data type does not require meta:extends or meta:intendedToExtend fields, nor do fields need to be nested to avoid collisions. When it comes to defining the field structure of data type itself, you can use primitive types (like string or object) or you can reference other existing data types through $ref attributes. See the guide on defining custom XDM fields in the API for detailed guidance on the expected format for different XDM field types.

type required	string The JSON Schema data type for the resource. Must be set to `object` or `array`.
title required	string A title for the data type.
description	string A description for the data type.
properties	object If `type` is set to `object`, this field describes the attributes that the object will provide. Not supported for `array` data types. See the guide on defining XDM field types in the API for more information on how to format XDM fields.
items	object If `type` is set to `array`, this field describes the type and structure of each array list item. Not supported for `object` data types. See the guide on defining XDM field types in the API for more information on how to format XDM fields.

Responses

201

Success

400

Bad formatting

post/tenant/datatypes

Request samples

Payload

application/json

{"title": "Property Construction",
"description": "Information related to the property construction",
"type": "object",
"properties": {"yearBuilt": {"type": "integer",
"title": "Year Built",
"description": "The year the property was constructed."
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type of building or structure in which the property exists.",
"enum": ["freeStanding",
"mall",
"shoppingCenter"
],
"meta:enum": {"freeStanding": "Free Standing Building",
"mall": "Mall Space",
"shoppingCenter": "Shopping Center"
}
}
}
}

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/datatypes/669ffcc61cf5e94e8640dbe6a15f0f24eb3cd1ddbbfb6b36",
"meta:altId": "_{TENANT_ID}.datatypes.669ffcc61cf5e94e8640dbe6a15f0f24eb3cd1ddbbfb6b36",
"meta:resourceType": "datatypes",
"version": "1.0",
"title": "Property Construction",
"type": "object",
"description": "Information related to the property construction",
"properties": {"yearBuilt": {"type": "integer",
"title": "Year Built",
"description": "The year the property was constructed.",
"meta:xdmType": "int"
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type of building or structure in which the property exists.",
"enum": ["freeStanding",
"mall",
"shoppingCenter"
],
"meta:enum": {"freeStanding": "Free Standing Building",
"mall": "Mall Space",
"shoppingCenter": "Shopping Center"
},
"meta:xdmType": "string"
}
},
"refs": [ ],
"imsOrg": "{ORG_ID}",
"meta:extensible": true,
"meta:abstract": true,
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1670885230789,
"repo:lastModifiedDate": 1670885230789,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "d3cc803a1f8daa06b7c150d882bd337d88f4d5d5f08d36cfc4c2849dc0255f7e",
"meta:globalLibVersion": "1.38.3.1"
},
"meta:containerId": "tenant",
"meta:sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"meta:sandboxType": "production",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Update a custom data type

A PUT request essentially re-writes the data type, therefore the request body must include all fields required to create (POST) a data type. This is especially useful when updating a lot of information in the data type at once.

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

Request

path Parameters

DATA_TYPE_ID

required

string

The meta:altId or URL-encoded $id of the data type in question.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The JSON payload must include all of the fields that were originally required for creating the data type, but with updated values.

type required	string The JSON Schema data type for the resource. Must be set to `object` or `array`.
title required	string A title for the data type.
description	string A description for the data type.
properties	object If `type` is set to `object`, this field describes the attributes that the object will provide. Not supported for `array` data types. See the guide on defining XDM field types in the API for more information on how to format XDM fields.
items	object If `type` is set to `array`, this field describes the type and structure of each array list item. Not supported for `object` data types. See the guide on defining XDM field types in the API for more information on how to format XDM fields.

Responses

200

Success

400

Bad formatting

put/tenant/datatypes/{DATA_TYPE_ID}

Request samples

Payload

application/json

{"title": "Property Construction",
"description": "Updated description for the data type.",
"type": "object",
"properties": {"yearBuilt": {"type": "integer",
"title": "Year Built",
"description": "The year the property was constructed."
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type of building or structure in which the property exists.",
"enum": ["freeStanding",
"mall",
"shoppingCenter"
],
"meta:enum": {"freeStanding": "Free Standing Building",
"mall": "Mall Space",
"shoppingCenter": "Shopping Center"
}
}
}
}

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/datatypes/669ffcc61cf5e94e8640dbe6a15f0f24eb3cd1ddbbfb6b36",
"meta:altId": "_{TENANT_ID}.datatypes.669ffcc61cf5e94e8640dbe6a15f0f24eb3cd1ddbbfb6b36",
"meta:resourceType": "datatypes",
"version": "1.1",
"title": "Property Construction",
"type": "object",
"description": "Updated description of the data type.",
"properties": {"yearBuilt": {"type": "integer",
"title": "Year Built",
"description": "The year the property was constructed.",
"meta:xdmType": "int"
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type of building or structure in which the property exists.",
"enum": ["freeStanding",
"mall",
"shoppingCenter"
],
"meta:enum": {"freeStanding": "Free Standing Building",
"mall": "Mall Space",
"shoppingCenter": "Shopping Center"
},
"meta:xdmType": "string"
}
},
"refs": [ ],
"imsOrg": "{ORG_ID}",
"meta:extensible": true,
"meta:abstract": true,
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1670885230789,
"repo:lastModifiedDate": 1670885230789,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "d3cc803a1f8daa06b7c150d882bd337d88f4d5d5f08d36cfc4c2849dc0255f7e",
"meta:globalLibVersion": "1.38.3.1"
},
"meta:containerId": "tenant",
"meta:sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"meta:sandboxType": "production",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Update a custom data type's attributes

You can use this endpoint to update one or more attributes of a custom data type. The Schema Registry supports all standard JSON Patch operations, including add, remove, and replace, to allow users to modify or update data types they have defined.

NOTE: For more information on JSON Patch, including all available operations, please refer to the the official JSON Patch specification. > >For more information on using this operation, see the data types endpoint guide on Experience League.

Request

path Parameters

DATA_TYPE_ID

required

string

The meta:altId or URL-encoded $id of the data type in question.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The request body accepts a JSON Patch payload.

Array

op	string Type of JSON Patch operation being performed.
path	string Location where the operation is being performed.
value	object Required elements vary depending on type of 'value' (e.g. string, integer, object, etc.)

Responses

200

Success

400

Bad formatting

patch/tenant/datatypes/{DATA_TYPE_ID}

Request samples

Payload

application/json

[{"op": "add",
"path": "/properties/field3",
"value": {"title": "Field 3",
"type": "string",
"format": "date",
"description": "Description of Field 3."
}
}
]

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/datatypes/669ffcc61cf5e94e8640dbe6a15f0f24eb3cd1ddbbfb6b36",
"meta:altId": "_{TENANT_ID}.datatypes.669ffcc61cf5e94e8640dbe6a15f0f24eb3cd1ddbbfb6b36",
"meta:resourceType": "datatypes",
"version": "1.1",
"title": "Property Construction",
"type": "object",
"description": "Information related to the property construction",
"properties": {"yearBuilt": {"type": "integer",
"title": "Year Built",
"description": "The year the property was constructed.",
"meta:xdmType": "int"
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type of building or structure in which the property exists.",
"enum": ["freeStanding",
"mall",
"shoppingCenter"
],
"meta:enum": {"freeStanding": "Free Standing Building",
"mall": "Mall Space",
"shoppingCenter": "Shopping Center"
},
"meta:xdmType": "string"
},
"field1": {"title": "Field 1",
"description": "Description of Field 1.",
"type": "string"
},
"field2": {"title": "Field 2",
"description": "Description of Field 2.",
"type": "integer"
},
"field3": {"title": "Field 3",
"description": "Description of Field 3.",
"type": "string",
"format": "date"
}
},
"refs": [ ],
"imsOrg": "{ORG_ID}",
"meta:extensible": true,
"meta:abstract": true,
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1670885230789,
"repo:lastModifiedDate": 1670885230789,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "d3cc803a1f8daa06b7c150d882bd337d88f4d5d5f08d36cfc4c2849dc0255f7e",
"meta:globalLibVersion": "1.38.3.1"
},
"meta:containerId": "tenant",
"meta:sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"meta:sandboxType": "production",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Delete a custom class

Removing a data type is done through a DELETE request to the $id of the data type being removed.

A successful deletion returns an empty response body and HTTP status 204 (No Content).

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

Request

path Parameters

DATA_TYPE_ID

required

string

The meta:altId or URL-encoded $id of the data type in question.

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 IMS 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 for more information.

Responses

204

No content

404

Not found

500

Internal server error

delete/tenant/datatypes/{DATA_TYPE_ID}

Descriptors

Schema descriptors are tenant-level metadata used to provide interpretive details on how data based on certain schemas may relate or interact with one another.

List descriptors

Schemas define a static view of data entities, but do not provide specific details on how data based on these schemas (datasets) may relate to one another. Platform allows you to describe these relationships and other interpretive metadata about a schema through the use of descriptors.

Descriptors are tenant-level metadata for schemas, meaning they are unique to your IMS Organization and all descriptor operations take place in the tenant container.

Each schema can have one or more schema descriptor entities applied to it. Each schema descriptor entity includes a descriptor @type and the sourceSchema to which it applies. Once applied, these descriptors apply to all datasets created using the schema.

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

Request

path Parameters

CONTAINER_ID

required

string

The name of the container that you want to list resources from. To list core resources provided by Adobe, use global. To list custom resources defined by your organization, use tenant.

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. For example, `property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile` returns only field groups that are compatible with the XDM Individual Profile class.
orderby	string Sort response by specified fields separated by "," and/or prefix field with "-" for descending order. Used by the v2 option of the API, as indicated by the `Accept` header.
limit	number Specify a limit for the number of response results to be displayed (must be between 0 and 500). Used by the v2 option of the API, as indicated by the `Accept` header.
start	string The start value of the first `orderBy` field. The value of this parameter be the same data type as that of the `orderBy` field (e.g. strings or integers). Used by the v2 option of the API, as indicated by the `Accept` header.

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 IMS 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 for more information.

required

string

The desired response format. Descriptors require unique Accept headers using xdm instead of xed. The following values are permitted:

Accept	Description
`application/vnd.adobe.xdm-id+json`	Returns a list of descriptor IDs, grouped by their `@type`.
`application/vnd.adobe.xdm-link+json`	Returns a list of descriptor API paths, grouped by their `@type`.
`application/vnd.adobe.xdm+json`	Returns a list of descriptor objects, grouped by their `@type`.
`application/vnd.adobe.xdm-v2{-id/-link}+json`	Including the `-v2` option in any of the above `Accept` headers permits paging functionality, returning a results array with a `_page` attribute that can be used to request the next page if needed.

Responses

200

Success

400

Bad formatting

get/{CONTAINER_ID}/descriptors

Response samples

application/json

{"xdm:alternateDisplayInfo": [{"@id": "6acc5b7c0fc15159463ac1f1dbcb0c5950f330f2db740105",
"@type": "xdm:alternateDisplayInfo",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/4177bdbd4b2b328061bdd077dce25ea020b80d5c208553e0",
"xdm:sourceVersion": 1,
"xdm:sourceProperty": "/_experience/analytics/customDimensions/eVars/eVar1",
"imsOrg": "{IMS_ORG}",
"version": "1",
"xdm:title": {"en_us": "Internal Campaign"
},
"xdm:description": {"en_us": "Internal campaign eVar."
},
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production",
"meta:registryMetadata": {"repo:createdDate": 1611685171098,
"repo:lastModifiedDate": 1611685171098,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b"
}
}
],
"xdm:descriptorIdentity": [{"@id": "8f52618ac104afa0da2b1d7c1cc8ac4a0da66a53",
"@type": "xdm:descriptorIdentity",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/837ea89d1103906bf6f2710064ae40b1",
"xdm:sourceVersion": 1,
"xdm:sourceProperty": "/personalEmail/address",
"imsOrg": "{IMS_ORG}",
"version": "1",
"xdm:namespace": "Email",
"xdm:property": "xdm:code",
"xdm:isPrimary": true,
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production",
"meta:registryMetadata": {"repo:createdDate": 1556055659091,
"repo:lastModifiedDate": 1556055659091,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b"
}
}
],
"xdm:descriptorReferenceIdentity": [{"@id": "bde9eb256ec3ddb51491459d00ddd4e0c3b03d16",
"@type": "xdm:descriptorReferenceIdentity",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/e7bc97acfaf14832fd666cbd6b3629e1",
"xdm:sourceVersion": 1,
"xdm:sourceProperty": "/_{TENANT_ID}/favoriteProduct",
"imsOrg": "{IMS_ORG}",
"version": "1",
"xdm:identityNamespace": "productID",
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production",
"meta:registryMetadata": {"repo:createdDate": 1570569826581,
"repo:lastModifiedDate": 1570569826581,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b"
}
}
],
"xdm:descriptorOneToOne": [{"@id": "11b03201c4cbc99f99abe33523d49cc24a636330",
"@type": "xdm:descriptorOneToOne",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/e7bc97acfaf14832fd666cbd6b3629e1",
"xdm:sourceVersion": 1,
"xdm:sourceProperty": "/_{TENANT_ID}/favoriteProduct",
"xdm:destinationSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/74ec84c38fefa486bc81c03a172933f1",
"xdm:destinationVersion": 1,
"imsOrg": "{IMS_ORG}",
"version": "1",
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production",
"meta:registryMetadata": {"repo:createdDate": 1570569826248,
"repo:lastModifiedDate": 1570569826248,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b"
}
}
]
}

Retrieve a descriptor

View the details of a specific descriptor by performing a lookup (GET) request using the @id of the descriptor. Descriptors are not versioned, therefore no Accept header is required in the lookup request.

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

Request

path Parameters

CONTAINER_ID required	string The name of the container that you want to retrieve a resource from. To retrieve a core resource provided by Adobe, use `global`. To retrieve a custom resource defined by your organization, use `tenant`.
DESCRIPTOR_ID required	string The unique ID (`@id`) of the descriptor in question.

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 IMS 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 for more information.

Responses

200

Success

400

Bad formatting

get/{CONTAINER_ID}/descriptors/{DESCRIPTOR_ID}

Response samples

application/json

{"@id": "8f52618ac104afa0da2b1d7c1cc8ac4a0da66a53",
"@type": "xdm:descriptorIdentity",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/837ea89d1103906bf6f2710064ae40b1",
"xdm:sourceVersion": 1,
"xdm:sourceProperty": "/personalEmail/address",
"imsOrg": "{IMS_ORG}",
"version": "1",
"xdm:namespace": "Email",
"xdm:property": "xdm:code",
"xdm:isPrimary": true,
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production",
"meta:registryMetadata": {"repo:createdDate": 1556055659091,
"repo:lastModifiedDate": 1556055659091,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b"
}
}

Create a descriptor

You can create a new descriptor by making a POST request. The required request payload fields vary based on the @type of descriptor being defined. For details on the requirements for each descriptor type, refer to the section on defining descriptors 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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The required request payload fields vary based on the @type of descriptor being defined. For details on the requirements for each descriptor type, refer to the section on defining descriptors in the API guide.

@type	string The descriptor type. Enum: "xdm:alternateDisplayInfo" "xdm:descriptorIdentity" "xdm:descriptorReferenceIdentity" "xdm:descriptorOneToOne"
xdm:sourceSchema	string The URI `$id` of the schema that this descriptor applies to.
xdm:sourceVersion	string The latest major version of the `sourceSchema`.
xdm:sourceProperty	string The path to the field within the `sourceSchema` that this descriptor applies to.

Responses

201

Success

400

Bad formatting

post/tenant/descriptors

Request samples

Payload

application/json

{"@type": "xdm:descriptorIdentity",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/5b8d40b434bec502955d3e0144c4ce14d096897c6b0ca11f",
"xdm:sourceVersion": 1,
"xdm:sourceProperty": "/homeAddress",
"xdm:description": {"en_us": "The home address for the customer."
}
}

Response samples

application/json

{"@id": "557ab9db09a9451820c1dca6b8bc13473695ac63c56934eb",
"@type": "xdm:alternateDisplayInfo",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/5b8d40b434bec502955d3e0144c4ce14d096897c6b0ca11f",
"xdm:sourceVersion": 1,
"xdm:sourceProperty": "/homeAddress",
"imsOrg": "{IMS_ORG}",
"version": "1",
"xdm:description": {"en_us": "The home address for the customer."
},
"meta:containerId": "tenant",
"meta:sandboxId": "36ac3b60-e3df-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production"
}

Update a descriptor

You can update a descriptor by making a PUT request. This action essentially rewrites the existing descriptor, therefore the payload must include all fields that were required when the descriptor was first defined.

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

Request

path Parameters

DESCRIPTOR_ID

required

string

The unique ID (@id) of the descriptor in question.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

@type	string The descriptor type. Enum: "xdm:alternateDisplayInfo" "xdm:descriptorIdentity" "xdm:descriptorReferenceIdentity" "xdm:descriptorOneToOne"
xdm:sourceSchema	string The URI `$id` of the schema that this descriptor applies to.
xdm:sourceVersion	string The latest major version of the `sourceSchema`.
xdm:sourceProperty	string The path to the field within the `sourceSchema` that this descriptor applies to.

Responses

200

Success

400

Bad formatting

put/tenant/descriptors/{DESCRIPTOR_ID}

Request samples

Payload

application/json

{"@type": "xdm:descriptorIdentity",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/5b8d40b434bec502955d3e0144c4ce14d096897c6b0ca11f",
"xdm:sourceVersion": 1,
"xdm:sourceProperty": "/homeAddress",
"xdm:description": {"en_us": "The home address for the customer."
}
}

Response samples

application/json

{"@id": "557ab9db09a9451820c1dca6b8bc13473695ac63c56934eb",
"@type": "xdm:alternateDisplayInfo",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/5b8d40b434bec502955d3e0144c4ce14d096897c6b0ca11f",
"xdm:sourceVersion": 1,
"xdm:sourceProperty": "/homeAddress",
"imsOrg": "{IMS_ORG}",
"version": "1",
"xdm:description": {"en_us": "The home address for the customer."
},
"meta:containerId": "tenant",
"meta:sandboxId": "36ac3b60-e3df-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production"
}

Delete a descriptor

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

Request

path Parameters

DESCRIPTOR_ID

required

string

The unique ID (@id) of the descriptor in question.

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 IMS 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 for more information.

Responses

204

No content

403

Forbidden

404

Not found

delete/tenant/descriptors/{DESCRIPTOR_ID}

Unions

Union schemas aggregate the fields of all schemas that implement the same class (such as ExperienceEvent or Profile) into a single schema. They are used by Real-time Customer Profile to merge data together to form a "single source of truth" for an individual.

List union schemas

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

Request

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. For example, `property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile` returns only field groups that are compatible with the XDM Individual Profile class.
orderby	string Sort the listed resources by specified fields. For example `orderby=title` sorts results by title in ascending order (A-Z). Adding a `-` before the field name (`orderby=-title`) sorts items in descending order (Z-A). Multiple fields can also be included to denote primary and secondary sort orders (for example, `orderby=title,description`).
start	string When used in conjunction with an `orderby` parameter, `start` specifies where the paginated list of items should begin. This parameter cannot be used without an `orderby` parameter present. Typically, this parameter is omitted in order to obtain the first page of results. After that, `start` should be set to the maximum value of the primary sort property of the `orderby` field received in the previous page. The API response then returns entries beginning with those that have a primary sort property from `orderby` strictly greater than (for ascending) or strictly less than (for descending) the specified value. For example, if the `orderby` parameter is set to `orderby=name,firstname`, the `start` parameter would contain a value for the `name` property. In this case, if you wanted to show the next 20 entries of a resource immediately following the name "Miller", you would use: `?orderby=name,firstname&start=Miller&limit=20`.
limit	number When used in conjunction with an `orderby` parameter, `limit` restricts the maximum number of items that should be returned for a given request. This parameter cannot be used without an `orderby` parameter present. The `limit` parameter specifies a positive integer (between `0` and `500`) as a hint as to the maximum number of items that should be returned. For example, `limit=5` returns only five resources in the list. However, this value is not strictly honored. The actual response size may be smaller or larger as constrained by the need to provide the reliable operation of the `start` parameter, if one is provided.

header Parameters

required

string

The desired response format. For listing calls, the following Accept header values are permitted:

Accept	Description
`application/vnd.adobe.xed-id+json`	Returns a short summary of each resource, generally the preferred header for listing.
`application/vnd.adobe.xed+json`	Returns full JSON for each resource, with the original `$ref` and `allOf` attributes included.

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 IMS 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 for more information.

Responses

200

Success

400

Bad formatting

get/tenant/unions

Response samples

application/json

{"results": [{"$id": "https://ns.adobe.com/xdm/context/profile__union",
"meta:altId": "_xdm.context.profile__union",
"meta:resourceType": "unions",
"version": "1.0",
"title": "XDM Individual Profile",
"type": "object",
"description": "An XDM Individual Profile forms a singular representation of the attributes and interests of both identified and partially-identified individuals. Less-identified profiles may contain only anonymous behavioral signals, such as browser cookies, while highly-identified profiles may contain detailed personal information such as name, date of birth, location, and email address. As a profile grows, it becomes a robust repository of personal information, identification information, contact details, and communication preferences for an individual.",
"allOf": [{ },
{"$ref ": "https://ns.adobe.com/xdm/context/profile-test-profile"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/e16d03cd4f0f1cd0f837ceada0aa478e"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/03a07059cad2a4d772385bcf8105750f"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/6287e6dfaf504f1eb47842492431255d"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/5a55c7ba8bfe66d1ec0fd5b7e6a2a280c45c6e3312c259ef"
},
{"$ref ": "https://ns.adobe.com/xdm/mixins/profile-consents"
},
{"$ref ": "https://ns.adobe.com/xdm/common/external-source-system-audit-details"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-person-details"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/1e9576c98a5d2a67ac90da1a271f5eb2"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-privacy"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/44850059caa530684c4507d0e01647e9"
},
{"$ref ": "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/d0b9284f0610076e97f57dfadf78b3de"
},
{"$ref ": "https://ns.adobe.com/experience/campaign/profile-all"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-personal-details"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/811a7c6627d5af6680cdfebf81c101c2"
},
{"$ref ": "https://ns.adobe.com/experience/profile-edgeregion"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile"
},
{"$ref ": "https://ns.adobe.com/xdm/context/identitymap"
},
{"$ref ": "https://ns.adobe.com/experience/profile/profile-all"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-segmentation"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-preferences-details"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/5e903c020e4cd4ef65ec4b3ebcc0a1df9ab2c064f303e377"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-work-details"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extends": ["https://ns.adobe.com/{TENANT_ID}/schemas/7c92ae0a47db946ba5d7d47b1cfbca4b",
"https://ns.adobe.com/xdm/common/extensible",
"https://ns.adobe.com/{TENANT_ID}/schemas/5d70026f5522fc60b3c81f6523b83c86",
"https://ns.adobe.com/{TENANT_ID}/mixins/5a55c7ba8bfe66d1ec0fd5b7e6a2a280c45c6e3312c259ef",
"https://ns.adobe.com/xdm/mixins/profile-consents",
"https://ns.adobe.com/{TENANT_ID}/schemas/c447e8716f1d4598be9e36dcd64cd55a",
"https://ns.adobe.com/xdm/common/external-source-system-audit-details",
"https://ns.adobe.com/{TENANT_ID}/mixins/d0b9284f0610076e97f57dfadf78b3de",
"https://ns.adobe.com/{TENANT_ID}/schemas/653e53eb04341d09453c9b6a5fb43d1b4ca9526ec274856d",
"https://ns.adobe.com/{TENANT_ID}/schemas/c65ddf08cf2d4a2fe94bd06113bf4bc4c855e12a936410d5",
"https://ns.adobe.com/{TENANT_ID}/mixins/811a7c6627d5af6680cdfebf81c101c2",
"https://ns.adobe.com/{TENANT_ID}/schemas/ea2208ffef6dc12851f938e54bc723f2b6aa1a7bcb9b9535",
"https://ns.adobe.com/experience/profile/profile-all",
"https://ns.adobe.com/xdm/context/profile-work-details",
"https://ns.adobe.com/{TENANT_ID}/schemas/a938858fbe085db9cc0d7b17ca7da28d",
"https://ns.adobe.com/{TENANT_ID}/schemas/e5c13b941fc87d3614f742528e8c30693baae7c41af01fc2",
"https://ns.adobe.com/{TENANT_ID}/schemas/b67de72ed55dcafec654ec9818eb55a4",
"https://ns.adobe.com/{TENANT_ID}/schemas/e7bc97acfaf14832fd666cbd6b3629e1",
"https://ns.adobe.com/{TENANT_ID}/schemas/afb2da1c042e4413de24f4096157c9f6a72cc43b57ee1a",
"https://ns.adobe.com/experience/campaign/profile-all",
"https://ns.adobe.com/xdm/context/profile",
"https://ns.adobe.com/xdm/context/profile-segmentation",
"https://ns.adobe.com/xdm/context/profile-preferences-details",
"https://ns.adobe.com/{TENANT_ID}/schemas/36966a17ce64bcee6544df170f7299759d3dce41c8cbee6",
"https://ns.adobe.com/{TENANT_ID}/schemas/b29ba32d98a8b1f00388c6c6eceff4db6917fd174eab4c55",
"https://ns.adobe.com/{TENANT_ID}/mixins/5e903c020e4cd4ef65ec4b3ebcc0a1df9ab2c064f303e377",
"https://ns.adobe.com/{TENANT_ID}/schemas/456bdc7d1216fb96fa42495a449f39c2",
"https://ns.adobe.com/{TENANT_ID}/schemas/579a2817c2342751afb9241015da9741",
"https://ns.adobe.com/{TENANT_ID}/schemas/be9f753fc193a23baa8893bbe7679afe",
"https://ns.adobe.com/xdm/common/auditable",
"https://ns.adobe.com/{TENANT_ID}/schemas/f09963a76904b524f6419a50c19dd4318061d82d8b04638",
"https://ns.adobe.com/{TENANT_ID}/mixins/e16d03cd4f0f1cd0f837ceada0aa478e",
"https://ns.adobe.com/{TENANT_ID}/schemas/b1e6dd903c29dc7aea408ecd1ed040f0c161df7961fc50b2",
"https://ns.adobe.com/{TENANT_ID}/schemas/d29a200b5deb6cfb55d3b865ef627f33",
"https://ns.adobe.com/xdm/context/profile-person-details",
"https://ns.adobe.com/xdm/context/profile-privacy",
"https://ns.adobe.com/{TENANT_ID}/mixins/44850059caa530684c4507d0e01647e9",
"https://ns.adobe.com/{TENANT_ID}/schemas/e348088f36cb2dc90d14737de6832aa35c7a7f1a116e1dbe",
"https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
"https://ns.adobe.com/xdm/context/profile-personal-details",
"https://ns.adobe.com/xdm/data/record",
"https://ns.adobe.com/experience/profile-edgeregion",
"https://ns.adobe.com/xdm/context/identitymap",
"https://ns.adobe.com/{TENANT_ID}/schemas/ebbbb87cb534798841d760ea2c5d861d",
"https://ns.adobe.com/{TENANT_ID}/schemas/3494225dfbfb0d9ac346b00a1142c3a1c0751aff9dbbf5ef",
"https://ns.adobe.com/{TENANT_ID}/schemas/6fd18629565e429e5379c77c2755618b",
"https://ns.adobe.com/xdm/context/profile-test-profile",
"https://ns.adobe.com/{TENANT_ID}/schemas/4fcf5778706905d53c138b1ed4d94c6c",
"https://ns.adobe.com/{TENANT_ID}/mixins/03a07059cad2a4d772385bcf8105750f",
"https://ns.adobe.com/{TENANT_ID}/mixins/6287e6dfaf504f1eb47842492431255d",
"https://ns.adobe.com/{TENANT_ID}/schemas/ac95d88f11b47688ef2f24f55fe5f3a9a607bb2c4325e68d",
"https://ns.adobe.com/{TENANT_ID}/schemas/70e3226d662a19800837b7dd7cfc3ef6",
"https://ns.adobe.com/{TENANT_ID}/schemas/5df4f4cc39462136cbbead3481f878a878420025282a53b8",
"https://ns.adobe.com/{TENANT_ID}/schemas/3a1859ec31ba93153050f92d981aec5d97b350d22cf960d5",
"https://ns.adobe.com/{TENANT_ID}/mixins/1e9576c98a5d2a67ac90da1a271f5eb2",
"https://ns.adobe.com/{TENANT_ID}/schemas/3d569c62921ac9371ad148afbaec3891547aca2a49575cef"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"eTag": "e4655a460374dec4dd7c32d3075a4ffc8249146b4d9c6ae09682da51266a78da",
"meta:globalLibVersion": "1.28.1"
},
"meta:class": "https://ns.adobe.com/xdm/context/profile",
"meta:containerId": "tenant"
},
{"$id": "https://ns.adobe.com/xdm/context/experienceevent__union",
"meta:altId": "_xdm.context.experienceevent__union",
"meta:resourceType": "unions",
"version": "1.0",
"title": "XDM ExperienceEvent",
"type": "object",
"description": "An ExperienceEvent is a fact record of what occurred, including the point in time and identity of the individual involved. ExperienceEvents can be either explicit (directly observable human actions) or implicit (raised without a direct human action) and are recorded without aggregation or interpretation. They are critical for time-domain analytics as they allow for observation and analysis of changes that occur in a given window of time and the comparison between multiple windows of time to track trends.",
"allOf": [{"$ref ": "https://ns.adobe.com/experience/journeyOrchestration/stepEvents/journeyStepEventDataFetchFields"
},
{"$ref ": "https://ns.adobe.com/experience/journeyOrchestration/stepEvents/journeyStepEventCommonFields"
},
{"$ref ": "https://ns.adobe.com/xdm/context/experienceevent-commerce"
},
{"$ref ": "https://ns.adobe.com/xdm/context/experienceevent-web"
},
{"$ref ": "https://ns.adobe.com/xdm/context/experienceevent-marketing"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/ae0c9aadd004dbd2c438077f500df26781c414e60bbf4a54"
},
{"$ref ": "https://ns.adobe.com/xdm/context/experienceevent-environment-details"
},
{"$ref ": "https://ns.adobe.com/xdm/context/experienceevent"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/1a7a5de2a84c6aacbf86c8d282a891a0"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/7b5217dec3313f1a2a067ff5a29066c0"
},
{"$ref ": "https://ns.adobe.com/xdm/context/identitymap"
},
{"$ref ": "https://ns.adobe.com/experience/journeyOrchestration/stepEvents/journeyStepEventActionExecutionFields"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/90e1950ab23ab1e71273c2aab0bbf5e978d5d9a6a1cc5bab"
},
{"$ref ": "https://ns.adobe.com/experience/campaign/orchestration/eventid"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extends": ["https://ns.adobe.com/xdm/data/time-series",
"https://ns.adobe.com/{TENANT_ID}/schemas/cece2f127694fc27e9233480018790b3ceb4f3e50a55cf80",
"https://ns.adobe.com/experience/journeyOrchestration/stepEvents/journeyStepEventDataFetchFields",
"https://ns.adobe.com/experience/journeyOrchestration/stepEvents/journeyStepEventCommonFields",
"https://ns.adobe.com/{TENANT_ID}/schemas/3423b2c60609e0418ded3962fcc47ed8",
"https://ns.adobe.com/xdm/context/experienceevent-commerce",
"https://ns.adobe.com/xdm/common/extensible",
"https://ns.adobe.com/{TENANT_ID}/schemas/f8fe82b4e8bd1ee85db5ad0172664957ef8c9931245cb7e6",
"https://ns.adobe.com/xdm/context/experienceevent-web",
"https://ns.adobe.com/xdm/context/experienceevent-marketing",
"https://ns.adobe.com/{TENANT_ID}/mixins/ae0c9aadd004dbd2c438077f500df26781c414e60bbf4a54",
"https://ns.adobe.com/xdm/context/experienceevent-environment-details",
"https://ns.adobe.com/xdm/context/experienceevent",
"https://ns.adobe.com/{TENANT_ID}/mixins/1a7a5de2a84c6aacbf86c8d282a891a0",
"https://ns.adobe.com/{TENANT_ID}/schemas/4425853159dc7e494b8971a4de80daf97571bd5c30d743cf",
"https://ns.adobe.com/{TENANT_ID}/mixins/7b5217dec3313f1a2a067ff5a29066c0",
"https://ns.adobe.com/xdm/context/identitymap",
"https://ns.adobe.com/experience/journeyOrchestration/stepEvents/journeyStepEventActionExecutionFields",
"https://ns.adobe.com/{TENANT_ID}/mixins/90e1950ab23ab1e71273c2aab0bbf5e978d5d9a6a1cc5bab",
"https://ns.adobe.com/{TENANT_ID}/schemas/5d4a826626bbff36134b24b92dd61f83",
"https://ns.adobe.com/{TENANT_ID}/schemas/bacec2361d131bf03211cf3c2372673f",
"https://ns.adobe.com/{TENANT_ID}/schemas/43f12f6de7d667db7f11f35e6af43802",
"https://ns.adobe.com/experience/campaign/orchestration/eventid"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"eTag": "e4655a460374dec4dd7c32d3075a4ffc8249146b4d9c6ae09682da51266a78da",
"meta:globalLibVersion": "1.28.1"
},
"meta:class": "https://ns.adobe.com/xdm/context/experienceevent",
"meta:containerId": "tenant"
},
{"$id": "https://ns.adobe.com/xdm/context/segmentdefinition__union",
"meta:altId": "_xdm.context.segmentdefinition__union",
"meta:resourceType": "unions",
"version": "1.0",
"title": "Segment definition",
"type": "object",
"description": "This is the base class for a segment definition which includes required fields like identity of a segment and name of segment. Segment definitions coming from various system can use this class to build Segment Definition XDM schema.",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/context/identitymap"
},
{"$ref ": "https://ns.adobe.com/xdm/context/segmentdefinition"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extends": ["https://ns.adobe.com/{TENANT_ID}/schemas/23255099a00826c31bbad8fa9519d3d513d5171bf2b787a2",
"https://ns.adobe.com/xdm/common/auditable",
"https://ns.adobe.com/xdm/data/record",
"https://ns.adobe.com/xdm/context/identitymap",
"https://ns.adobe.com/xdm/context/segmentdefinition"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"eTag": "e4655a460374dec4dd7c32d3075a4ffc8249146b4d9c6ae09682da51266a78da",
"meta:globalLibVersion": "1.28.1"
},
"meta:class": "https://ns.adobe.com/xdm/context/segmentdefinition",
"meta:containerId": "tenant"
}
]
}

Retrieve a union schema

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

Request

path Parameters

UNION_ID

required

string

The meta:altId or URL-encoded $id of the union schema in question.

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 IMS 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 for more information.

required

string

The desired response format. For lookup requests, a version parameter must be included, with the following Accept header values being permitted:

Accept	Description
`application/vnd.adobe.xed+json; version=1`	Returns only the basic details of the resource, with all inherited fields relegated to `$ref` and `allOf` properties.
`application/vnd.adobe.xed-full+json; version=1`	Returns the full details of the resource, including the details all fields inherited from other resources.
`application/vnd.adobe.xed-notext+json; version=1`	Returns only the basic details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-notext+json; version=1`	Returns the full details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-desc+json; version=1`	Returns the full details of the resource, including descriptions but with no titles.

Responses

200

Success

400

Bad formatting

get/tenant/unions/{UNION_ID}

Response samples

application/json

{"$id": "https://ns.adobe.com/xdm/context/profile__union",
"meta:altId": "_xdm.context.profile__union",
"meta:resourceType": "unions",
"version": "1.0",
"title": "XDM Individual Profile",
"type": "object",
"description": "An XDM Individual Profile forms a singular representation of the attributes and interests of both identified and partially-identified individuals. Less-identified profiles may contain only anonymous behavioral signals, such as browser cookies, while highly-identified profiles may contain detailed personal information such as name, date of birth, location, and email address. As a profile grows, it becomes a robust repository of personal information, identification information, contact details, and communication preferences for an individual.",
"allOf": [{ },
{"$ref ": "https://ns.adobe.com/xdm/context/profile-test-profile"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/e16d03cd4f0f1cd0f837ceada0aa478e"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/03a07059cad2a4d772385bcf8105750f"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/6287e6dfaf504f1eb47842492431255d"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/5a55c7ba8bfe66d1ec0fd5b7e6a2a280c45c6e3312c259ef"
},
{"$ref ": "https://ns.adobe.com/xdm/mixins/profile-consents"
},
{"$ref ": "https://ns.adobe.com/xdm/common/external-source-system-audit-details"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-person-details"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/1e9576c98a5d2a67ac90da1a271f5eb2"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-privacy"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/44850059caa530684c4507d0e01647e9"
},
{"$ref ": "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/d0b9284f0610076e97f57dfadf78b3de"
},
{"$ref ": "https://ns.adobe.com/experience/campaign/profile-all"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-personal-details"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/811a7c6627d5af6680cdfebf81c101c2"
},
{"$ref ": "https://ns.adobe.com/experience/profile-edgeregion"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile"
},
{"$ref ": "https://ns.adobe.com/xdm/context/identitymap"
},
{"$ref ": "https://ns.adobe.com/experience/profile/profile-all"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-segmentation"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-preferences-details"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/5e903c020e4cd4ef65ec4b3ebcc0a1df9ab2c064f303e377"
},
{"$ref ": "https://ns.adobe.com/xdm/context/profile-work-details"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extends": ["https://ns.adobe.com/{TENANT_ID}/schemas/7c92ae0a47db946ba5d7d47b1cfbca4b",
"https://ns.adobe.com/xdm/common/extensible",
"https://ns.adobe.com/{TENANT_ID}/schemas/5d70026f5522fc60b3c81f6523b83c86",
"https://ns.adobe.com/{TENANT_ID}/mixins/5a55c7ba8bfe66d1ec0fd5b7e6a2a280c45c6e3312c259ef",
"https://ns.adobe.com/xdm/mixins/profile-consents",
"https://ns.adobe.com/{TENANT_ID}/schemas/c447e8716f1d4598be9e36dcd64cd55a",
"https://ns.adobe.com/xdm/common/external-source-system-audit-details",
"https://ns.adobe.com/{TENANT_ID}/mixins/d0b9284f0610076e97f57dfadf78b3de",
"https://ns.adobe.com/{TENANT_ID}/schemas/653e53eb04341d09453c9b6a5fb43d1b4ca9526ec274856d",
"https://ns.adobe.com/{TENANT_ID}/schemas/c65ddf08cf2d4a2fe94bd06113bf4bc4c855e12a936410d5",
"https://ns.adobe.com/{TENANT_ID}/mixins/811a7c6627d5af6680cdfebf81c101c2",
"https://ns.adobe.com/{TENANT_ID}/schemas/ea2208ffef6dc12851f938e54bc723f2b6aa1a7bcb9b9535",
"https://ns.adobe.com/experience/profile/profile-all",
"https://ns.adobe.com/xdm/context/profile-work-details",
"https://ns.adobe.com/{TENANT_ID}/schemas/a938858fbe085db9cc0d7b17ca7da28d",
"https://ns.adobe.com/{TENANT_ID}/schemas/e5c13b941fc87d3614f742528e8c30693baae7c41af01fc2",
"https://ns.adobe.com/{TENANT_ID}/schemas/b67de72ed55dcafec654ec9818eb55a4",
"https://ns.adobe.com/{TENANT_ID}/schemas/e7bc97acfaf14832fd666cbd6b3629e1",
"https://ns.adobe.com/{TENANT_ID}/schemas/afb2da1c042e4413de24f4096157c9f6a72cc43b57ee1a",
"https://ns.adobe.com/experience/campaign/profile-all",
"https://ns.adobe.com/xdm/context/profile",
"https://ns.adobe.com/xdm/context/profile-segmentation",
"https://ns.adobe.com/xdm/context/profile-preferences-details",
"https://ns.adobe.com/{TENANT_ID}/schemas/36966a17ce64bcee6544df170f7299759d3dce41c8cbee6",
"https://ns.adobe.com/{TENANT_ID}/schemas/b29ba32d98a8b1f00388c6c6eceff4db6917fd174eab4c55",
"https://ns.adobe.com/{TENANT_ID}/mixins/5e903c020e4cd4ef65ec4b3ebcc0a1df9ab2c064f303e377",
"https://ns.adobe.com/{TENANT_ID}/schemas/456bdc7d1216fb96fa42495a449f39c2",
"https://ns.adobe.com/{TENANT_ID}/schemas/579a2817c2342751afb9241015da9741",
"https://ns.adobe.com/{TENANT_ID}/schemas/be9f753fc193a23baa8893bbe7679afe",
"https://ns.adobe.com/xdm/common/auditable",
"https://ns.adobe.com/{TENANT_ID}/schemas/f09963a76904b524f6419a50c19dd4318061d82d8b04638",
"https://ns.adobe.com/{TENANT_ID}/mixins/e16d03cd4f0f1cd0f837ceada0aa478e",
"https://ns.adobe.com/{TENANT_ID}/schemas/b1e6dd903c29dc7aea408ecd1ed040f0c161df7961fc50b2",
"https://ns.adobe.com/{TENANT_ID}/schemas/d29a200b5deb6cfb55d3b865ef627f33",
"https://ns.adobe.com/xdm/context/profile-person-details",
"https://ns.adobe.com/xdm/context/profile-privacy",
"https://ns.adobe.com/{TENANT_ID}/mixins/44850059caa530684c4507d0e01647e9",
"https://ns.adobe.com/{TENANT_ID}/schemas/e348088f36cb2dc90d14737de6832aa35c7a7f1a116e1dbe",
"https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
"https://ns.adobe.com/xdm/context/profile-personal-details",
"https://ns.adobe.com/xdm/data/record",
"https://ns.adobe.com/experience/profile-edgeregion",
"https://ns.adobe.com/xdm/context/identitymap",
"https://ns.adobe.com/{TENANT_ID}/schemas/ebbbb87cb534798841d760ea2c5d861d",
"https://ns.adobe.com/{TENANT_ID}/schemas/3494225dfbfb0d9ac346b00a1142c3a1c0751aff9dbbf5ef",
"https://ns.adobe.com/{TENANT_ID}/schemas/6fd18629565e429e5379c77c2755618b",
"https://ns.adobe.com/xdm/context/profile-test-profile",
"https://ns.adobe.com/{TENANT_ID}/schemas/4fcf5778706905d53c138b1ed4d94c6c",
"https://ns.adobe.com/{TENANT_ID}/mixins/03a07059cad2a4d772385bcf8105750f",
"https://ns.adobe.com/{TENANT_ID}/mixins/6287e6dfaf504f1eb47842492431255d",
"https://ns.adobe.com/{TENANT_ID}/schemas/ac95d88f11b47688ef2f24f55fe5f3a9a607bb2c4325e68d",
"https://ns.adobe.com/{TENANT_ID}/schemas/70e3226d662a19800837b7dd7cfc3ef6",
"https://ns.adobe.com/{TENANT_ID}/schemas/5df4f4cc39462136cbbead3481f878a878420025282a53b8",
"https://ns.adobe.com/{TENANT_ID}/schemas/3a1859ec31ba93153050f92d981aec5d97b350d22cf960d5",
"https://ns.adobe.com/{TENANT_ID}/mixins/1e9576c98a5d2a67ac90da1a271f5eb2",
"https://ns.adobe.com/{TENANT_ID}/schemas/3d569c62921ac9371ad148afbaec3891547aca2a49575cef"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"eTag": "e4655a460374dec4dd7c32d3075a4ffc8249146b4d9c6ae09682da51266a78da",
"meta:globalLibVersion": "1.28.1"
},
"meta:class": "https://ns.adobe.com/xdm/context/profile",
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production"
}

Export/Import

The Schema Registry API allows you to transfer and share XDM resources between sandboxes and IMS Organizations. For any schema, field group, or data type, you can generate an export payload containing the structure of the resource and any dependent resources. This payload can then be used to import the resource into a destination sandbox and IMS Org.

Retrieve an export payload

You can use this endpoint to retrieve an export payload for a specific resource in order to transfer it into a different sandbox or IMS Organization.

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

Request

path Parameters

RESOURCE_ID

required

string

The meta:altId or URL-encoded $id value of the schema, field group, or data type you want to export.

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 IMS 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 for more information.

required

string

The desired response format. For lookup requests, a version parameter must be included, with the following Accept header values being permitted:

Accept	Description
`application/vnd.adobe.xed+json; version=1`	Returns only the basic details of the resource, with all inherited fields relegated to `$ref` and `allOf` properties.
`application/vnd.adobe.xed-full+json; version=1`	Returns the full details of the resource, including the details all fields inherited from other resources.
`application/vnd.adobe.xed-notext+json; version=1`	Returns only the basic details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-notext+json; version=1`	Returns the full details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-desc+json; version=1`	Returns the full details of the resource, including descriptions but with no titles.

Responses

200

Success

404

Not found

get/rpc/export/{RESOURCE_ID}

Response samples

application/json

[{"$id": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"meta:altId": "_<XDM_TENANTID_PLACEHOLDER>.mixins.443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"meta:resourceType": "mixins",
"version": "1.0",
"title": "Example field group",
"type": "object",
"description": "",
"definitions": {"customFields": {"type": "object",
"properties": {"_<XDM_TENANTID_PLACEHOLDER>": {"type": "object",
"properties": {"customerId": {"title": "Customer ID",
"description": "",
"type": "string",
"isRequired": false,
"meta:xdmType": "string"
}
},
"meta:xdmType": "object"
}
}
},
"meta:xdmType": "object"
},
"allOf": [{"$ref ": "#/definitions/customFields",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": [ ],
"meta:xdmType": "object",
"meta:sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
"meta:sandboxType": "production"
},
{"$id": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/schemas/20af3f1d4b175f27ba59529d1b51a0c79fc25df454117c80",
"meta:altId": "_<XDM_TENANTID_PLACEHOLDER>.schemas.20af3f1d4b175f27ba59529d1b51a0c79fc25df454117c80",
"meta:resourceType": "schemas",
"version": "1.1",
"title": "Example schema",
"type": "object",
"description": "",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/context/profile",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": false,
"meta:abstract": false,
"meta:extends": ["https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"https://ns.adobe.com/xdm/common/auditable",
"https://ns.adobe.com/xdm/data/record",
"https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:class": "https://ns.adobe.com/xdm/context/profile",
"meta:sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
"meta:sandboxType": "production"
}
]

Import a resource

Use an export payload to import a resource into a different sandbox or IMS Organization.

NOTE: For more information on using this operation, see the export/import 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 unique ID ({IMS_ORG}) of the IMS Organization that you want to import the resource into.
x-sandbox-name required	string The name of the sandbox that you want to import the resource into. See the sandboxes overview documentation for more information.

Request Body schema: application/json

The payload returned by a GET /rpc/export/{RESOURCE_ID} call, indicating which schemas, field groups, and/or data types should be imported into the destination IMS Organization and sandbox.

Array

object

Responses

200

Success

400

Bad formatting

post/rpc/import

Request samples

Payload

application/json

[{"$id": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"meta:altId": "_<XDM_TENANTID_PLACEHOLDER>.mixins.443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"meta:resourceType": "mixins",
"version": "1.0",
"title": "Example field group",
"type": "object",
"description": "",
"definitions": {"customFields": {"type": "object",
"properties": {"_<XDM_TENANTID_PLACEHOLDER>": {"type": "object",
"properties": {"customerId": {"title": "Customer ID",
"description": "",
"type": "string",
"isRequired": false,
"meta:xdmType": "string"
}
},
"meta:xdmType": "object"
}
}
},
"meta:xdmType": "object"
},
"allOf": [{"$ref ": "#/definitions/customFields",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": [ ],
"meta:xdmType": "object",
"meta:sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
"meta:sandboxType": "production"
},
{"$id": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/schemas/20af3f1d4b175f27ba59529d1b51a0c79fc25df454117c80",
"meta:altId": "_<XDM_TENANTID_PLACEHOLDER>.schemas.20af3f1d4b175f27ba59529d1b51a0c79fc25df454117c80",
"meta:resourceType": "schemas",
"version": "1.1",
"title": "Example schema",
"type": "object",
"description": "",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/context/profile",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": false,
"meta:abstract": false,
"meta:extends": ["https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"https://ns.adobe.com/xdm/common/auditable",
"https://ns.adobe.com/xdm/data/record",
"https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:class": "https://ns.adobe.com/xdm/context/profile",
"meta:sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
"meta:sandboxType": "production"
}
]

Response samples

application/json

[{"$id": "https://ns.adobe.com/{TENANT_ID}/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"meta:altId": "_{TENANT_ID}.mixins.443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"meta:resourceType": "mixins",
"version": "1.0",
"title": "Example field group",
"type": "object",
"description": "",
"definitions": {"customFields": {"type": "object",
"properties": {"_{TENANT_ID}": {"type": "object",
"properties": {"customerId": {"title": "Customer ID",
"description": "",
"type": "string",
"isRequired": false,
"meta:xdmType": "string"
}
},
"meta:xdmType": "object"
}
}
},
"meta:xdmType": "object"
},
"allOf": [{"$ref ": "#/definitions/customFields",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": [ ],
"meta:xdmType": "object",
"meta:sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
"meta:sandboxType": "production"
},
{"$id": "https://ns.adobe.com/{TENANT_ID}/schemas/20af3f1d4b175f27ba59529d1b51a0c79fc25df454117c80",
"meta:altId": "_{TENANT_ID}.schemas.20af3f1d4b175f27ba59529d1b51a0c79fc25df454117c80",
"meta:resourceType": "schemas",
"version": "1.1",
"title": "Example schema",
"type": "object",
"description": "",
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/context/profile",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "https://ns.adobe.com/{TENANT_ID}/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": false,
"meta:abstract": false,
"meta:extends": ["https://ns.adobe.com/{TENANT_ID}/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
"https://ns.adobe.com/xdm/common/auditable",
"https://ns.adobe.com/xdm/data/record",
"https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:class": "https://ns.adobe.com/xdm/context/profile",
"meta:sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
"meta:sandboxType": "production"
}
]

Sample data

You can generate sample data for any specified schema within the Schema Library. The response object returned can then be used as the source of dataset ingestion.

Retrieve sample data

Retrieve sample data for a schema.

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

Request

path Parameters

SCHEMA_ID

required

string

The meta:altId or URL-encoded $id value of the schema you want to generate sample data for.

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 IMS 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 for more information.

required

string

The desired response format. For lookup requests, a version parameter must be included, with the following Accept header values being permitted:

Accept	Description
`application/vnd.adobe.xed+json; version=1`	Returns only the basic details of the resource, with all inherited fields relegated to `$ref` and `allOf` properties.
`application/vnd.adobe.xed-full+json; version=1`	Returns the full details of the resource, including the details all fields inherited from other resources.
`application/vnd.adobe.xed-notext+json; version=1`	Returns only the basic details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-notext+json; version=1`	Returns the full details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-desc+json; version=1`	Returns the full details of the resource, including descriptions but with no titles.

Responses

200

Success

404

Not found

get/rpc/sampledata/{SCHEMA_ID}

Response samples

application/json

{"@id": "/uri-reference",
"xdm:name": "Example Offer Name",
"xdm:representations": [{"xdm:channel": "https://ns.adobe.com/xdm/common/uri",
"xdm:components": [{"@type": "https://ns.adobe.com/experience/offer-management/content-component-text",
"dc:format": "application/vnd.adobe.photoshop",
"dc:language": ["\n"
],
"repo:id": "urn:aaid:sc:US:6dc33479-13ca-4b19-b25d-c805eff8a69e",
"repo:name": "Example Repo Name",
"repo:resolveURL": "https://plaftform.adobe.io/resolveByPath?path=&quot;/mycorp/content/projectx/fragment/prod/herobanners/banner14.html3&quot;"
}
],
"xdm:placement": "https://ns.adobe.com/xdm/common/uri"
}
],
"xdm:status": "draft",
"xdm:tags": ["https://ns.adobe.com/xdm/common/uri"
]
}

Audit log

The Schema Registry maintains a log of all the changes that have occurred to a resource (class, field group, data type, or schema) between different updates.

Retrieve a resource's audit log

This endpoint retrieves a resource's audit log, which shows a list of all the changes made to the resource.

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

Request

path Parameters

RESOURCE_ID

required

string

The meta:altId or URL-encoded $id value of the resource whose changes you wish to view.

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 IMS 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 for more information.

Responses

200

Success

get/rpc/auditlog/{RESOURCE_ID}

Response samples

application/json

[{"id": "https://ns.adobe.com/{TENANT_ID}/schemas/50649eb1b040bf042d6400a0335901cd2a97d31a4eac4330",
"updatedUser": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"updatedTime": "02-19-2021 05:43:56",
"requestId": "a14NMF0jd6BIfyXaHdTDl4bC4R0r9rht",
"clientId": "{CLIENT_ID}",
"sandBoxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"updates": [{"id": "https://ns.adobe.com/{TENANT_ID}/schemas/50649eb1b040bf042d6400a0335901cd2a97d31a4eac4330",
"xdmType": "schemas",
"action": "remove",
"path": "/meta:usageCount",
"value": 0
}
]
},
{"id": "https://ns.adobe.com/{TENANT_ID}/schemas/50649eb1b040bf042d6400a0335901cd2a97d31a4eac4330",
"updatedUser": "{USER_ID}",
"imsOrg": "{IMS_ORG}",
"updatedTime": "02-19-2021 05:43:56",
"requestId": "pFQbgmWrdbJrNB9GdxTSGECpXYWspu68",
"clientId": "{CLIENT_ID}",
"sandBoxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"updates": [{"id": "https://ns.adobe.com/{TENANT_ID}/classes/11052164b588f0c29584bf6ae1a6663a59aa65426c82389f",
"xdmType": "classes",
"action": "remove",
"path": "/definitions/customFields/properties/_{TENANT_ID}/properties/loyaltySunday_ABC",
"value": {"title": "LoyaltySundayABC",
"description": "",
"type": "string",
"isRequired": false,
"required": [ ],
"meta:xdmType": "string"
}
},
{"id": "https://ns.adobe.com/{TENANT_ID}/classes/11052164b588f0c29584bf6ae1a6663a59aa65426c82389f",
"xdmType": "classes",
"action": "remove",
"path": "/definitions/customFields/properties/_{TENANT_ID}/properties/loyaltyMoxee_XYZ",
"value": {"title": "LoyaltyMoxeeXYZ",
"description": "",
"type": "string",
"isRequired": false,
"required": [ ],
"meta:xdmType": "string"
}
}
]
}
]

Mixins (deprecated)

"Mixin" is the former term for a field group. The /mixins endpoints are deprecated and only maintained as legacy endpoints. For new implementations, please use the /fieldgroups endpoint instead.

List all mixinsDeprecated

NOTE: This endpoint is deprecated. For future implementations, please use the equivalent operation for the field groups endpoint instead.

Request

path Parameters

CONTAINER_ID

required

string

The name of the container that you want to list resources from. To list core resources provided by Adobe, use global. To list custom resources defined by your organization, use tenant.

query Parameters

property	string A comma-separated list of top-level object properties to be returned in the response. For example, `property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile` returns only field groups that are compatible with the XDM Individual Profile class.
orderby	string Sort the listed resources by specified fields. For example `orderby=title` sorts results by title in ascending order (A-Z). Adding a `-` before the field name (`orderby=-title`) sorts items in descending order (Z-A). Multiple fields can also be included to denote primary and secondary sort orders (for example, `orderby=title,description`).
start	string When used in conjunction with an `orderby` parameter, `start` specifies where the paginated list of items should begin. This parameter cannot be used without an `orderby` parameter present. Typically, this parameter is omitted in order to obtain the first page of results. After that, `start` should be set to the maximum value of the primary sort property of the `orderby` field received in the previous page. The API response then returns entries beginning with those that have a primary sort property from `orderby` strictly greater than (for ascending) or strictly less than (for descending) the specified value. For example, if the `orderby` parameter is set to `orderby=name,firstname`, the `start` parameter would contain a value for the `name` property. In this case, if you wanted to show the next 20 entries of a resource immediately following the name "Miller", you would use: `?orderby=name,firstname&start=Miller&limit=20`.
limit	number When used in conjunction with an `orderby` parameter, `limit` restricts the maximum number of items that should be returned for a given request. This parameter cannot be used without an `orderby` parameter present. The `limit` parameter specifies a positive integer (between `0` and `500`) as a hint as to the maximum number of items that should be returned. For example, `limit=5` returns only five resources in the list. However, this value is not strictly honored. The actual response size may be smaller or larger as constrained by the need to provide the reliable operation of the `start` parameter, if one is provided.

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 IMS 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 for more information.

required

string

The desired response format. For listing calls, the following Accept header values are permitted:

Accept	Description
`application/vnd.adobe.xed-id+json`	Returns a short summary of each resource, generally the preferred header for listing.
`application/vnd.adobe.xed+json`	Returns full JSON for each resource, with the original `$ref` and `allOf` attributes included.

Responses

200

Success

400

Bad formatting

get/{CONTAINER_ID}/mixins

Response samples

application/json

{"results": [{"$id": "https://ns.adobe.com/xdm/context/profile-person-details",
"meta:altId": "_xdm.context.profile-person-details",
"meta:resourceType": "mixins",
"version": "1.27.4",
"title": "Demographic Details",
"type": "object",
"description": "Demographic information such as name, gender, and birth date of an individual.",
"definitions": {"profile-person-details": {"properties": {"person": {"title": "Person",
"$ref ": "https://ns.adobe.com/xdm/context/person",
"description": "An individual actor, contact, or owner.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:person"
}
}
}
},
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "#/definitions/profile-person-details",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1635361816945,
"repo:lastModifiedDate": 1635361816945,
"eTag": "9f6a76cf4e115d0a3db3900fb418979ebea28bce47967484a1a0b2a2c32514cb",
"meta:globalLibVersion": "1.27.4",
"meta:usageCount": 316
},
"meta:tags": {"industry": ["all"
]
},
"meta:createdDate": "2020-08-10"
},
{"$id": "https://ns.adobe.com/xdm/context/profile-personal-details",
"meta:altId": "_xdm.context.profile-personal-details",
"meta:resourceType": "mixins",
"version": "1.27.4",
"title": "Personal Contact Details",
"type": "object",
"description": "Contact information for an individual person such as home address, phone number, fax, and email.",
"definitions": {"profile-personal-details": {"properties": {"faxPhone": {"title": "Fax phone",
"$ref ": "https://ns.adobe.com/xdm/context/phonenumber",
"description": "Fax phone number.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:faxPhone"
},
"homeAddress": {"title": "Home address",
"$ref ": "https://ns.adobe.com/xdm/common/address",
"description": "A home postal address.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:homeAddress"
},
"homePhone": {"title": "Home phone",
"$ref ": "https://ns.adobe.com/xdm/context/phonenumber",
"description": "Home phone number.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:homePhone"
},
"mobilePhone": {"title": "Mobile phone",
"$ref ": "https://ns.adobe.com/xdm/context/phonenumber",
"description": "Mobile phone number.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:mobilePhone"
},
"personalEmail": {"title": "Personal email",
"$ref ": "https://ns.adobe.com/xdm/context/emailaddress",
"description": "A personal email address.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:personalEmail"
}
}
}
},
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context",
"type": "object",
"meta:xdmType": "object"
},
{"$ref ": "#/definitions/profile-personal-details",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1635361816961,
"repo:lastModifiedDate": 1635361816961,
"eTag": "750a04f69224e9fab367c6663199218dbd524852652627756284b4333fd7b27b",
"meta:globalLibVersion": "1.27.4",
"meta:usageCount": 300
},
"meta:tags": {"industry": ["all"
]
},
"meta:createdDate": "2020-08-10"
}
],
"_page": {"orderby": "updated",
"next": null,
"count": 2
},
"_links": {"next": null
}
}

Retrieve a mixinDeprecated

NOTE: This endpoint is deprecated. For future implementations, please use the equivalent operation for the field groups endpoint instead.

Request

path Parameters

CONTAINER_ID required	string The name of the container that you want to retrieve a resource from. To retrieve a core resource provided by Adobe, use `global`. To retrieve a custom resource defined by your organization, use `tenant`.
MIXIN_ID required	string The `meta:altId` or URL-encoded `$id` of the mixin in question.

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 IMS 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 for more information.

required

string

The desired response format. For lookup requests, a version parameter must be included, with the following Accept header values being permitted:

Accept	Description
`application/vnd.adobe.xed+json; version=1`	Returns only the basic details of the resource, with all inherited fields relegated to `$ref` and `allOf` properties.
`application/vnd.adobe.xed-full+json; version=1`	Returns the full details of the resource, including the details all fields inherited from other resources.
`application/vnd.adobe.xed-notext+json; version=1`	Returns only the basic details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-notext+json; version=1`	Returns the full details of the resource, but with no titles or descriptions.
`application/vnd.adobe.xed-full-desc+json; version=1`	Returns the full details of the resource, including descriptions but with no titles.

Responses

200

Success

404

Not found

406

Invalid Accept format

get/{CONTAINER_ID}/mixins/{MIXIN_ID}

Response samples

application/json

{"$id": "https://ns.adobe.com/xdm/context/profile-person-details",
"meta:altId": "_xdm.context.profile-person-details",
"meta:resourceType": "mixins",
"version": "1.22.3",
"title": "Demographic Details",
"type": "object",
"description": "Demographic information such as name, gender, and birth date of an individual.",
"definitions": {"profile-person-details": {"properties": {"person": {"title": "Person",
"$ref ": "https://ns.adobe.com/xdm/context/person",
"description": "An individual actor, contact, or owner.",
"type": "object",
"meta:xdmType": "object",
"meta:xdmField": "xdm:person"
}
}
}
},
"allOf": [{"$ref ": "https://ns.adobe.com/xdm/common/extensible%23/definitions/@context",
"type": "object",
"meta:xdmType": "object"
},
{"$ref": "#/components/schemas/profile-person-details"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:status": "stable",
"$schema": "http://json-schema.org/draft-06/schema#",
"meta:registryMetadata": {"repo:createdDate": 1620758109174,
"repo:lastModifiedDate": 1620758109174,
"eTag": "f5b20a7edefab1c4b1a86fbd4de91570b57d36b9f2c6deb3225a18d14fafce3b",
"meta:globalLibVersion": "1.22.3",
"meta:usageCount": 29
},
"meta:tags": {"industry": ["all"
]
},
"meta:createdDate": "2020-08-10"
}

Create a new custom mixinDeprecated

NOTE: This endpoint is deprecated. For future implementations, please use the equivalent operation for the field groups endpoint instead.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The JSON payload must include a 'meta:intendedToExtend' field listing the '$id' of the class(es) with which the field group is compatible.

type required	string The JSON Schema data type for the field group. Must be set to `object`.
title required	string A title for the field group.
description	string A description for the field group.
meta:intendedToExtend required	Array of strings Contains the `$id` value(s) of the class(es) that this field group is compatible with.
definitions	object Describes the unique attributes provided by the field group that are not inherited from other XDM resources. Custom attributes must be nested under `properties._{TENANT_ID}` to avoid collisions with similar fields provided by classes and other field groups. For details on how to define different field types to include in your field group, see the field constraints guide.
	Array of objects A list of reference strings that determine the attributes that the field group provides. A string can refer to a custom field definition provided under the `definitions` object (e.g. `#/definitions/property`) or the `$id` of another field group or data type that this field group extends or employs.

Responses

201

Success

400

Bad formatting

post/tenant/mixins

Request samples

Payload

application/json

{"type": "object",
"title": "Property Details",
"description": "Detailed information related to the properties owned and operated by the company.",
"meta:intendedToExtend": ["https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
],
"definitions": {"property": {"properties": {"_{TENANT_ID}": {"type": "object",
"properties": {"propertyName": {"type": "string",
"title": "Property Name",
"description": "Name of the property"
},
"propertyCity": {"title": "Property City",
"description": "City where the property is located.",
"type": "string"
},
"phoneNumber": {"title": "Phone Number",
"description": "Primary phone number for the property.",
"type": "string"
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type and primary use of property.",
"enum": ["retail",
"yoga",
"fitness"
],
"meta:enum": {"retail": "Retail Store",
"yoga": "Yoga Studio",
"fitness": "Fitness Center"
}
},
"propertyConstruction": {"$ref ": "https://ns.adobe.com/{TENANT_ID}/datatypes/24c643f618647344606222c494bd0102"
}
}
}
}
}
},
"allOf": [{"$ref": "#/definitions/property"
}
]
}

Response samples

application/json

{"$id": "https://ns.adobe.com/{TENANT_ID}/mixins/8779fd45d6e4eb074300023a439862bbba359b60d451627a",
"meta:altId": "_{TENANT_ID}.mixins.8779fd45d6e4eb074300023a439862bbba359b60d451627a",
"meta:resourceType": "mixins",
"version": "1.2",
"title": "Property Details",
"type": "object",
"description": "Detailed information related to the properties owned and operated by the company.",
"definitions": {"property": {"properties": {"_{TENANT_ID}": {"type": "object",
"properties": {"propertyName": {"type": "string",
"title": "Property Name",
"description": "Name of the property"
},
"propertyCity": {"title": "Property City",
"description": "City where the property is located.",
"type": "string"
},
"phoneNumber": {"title": "Phone Number",
"description": "Primary phone number for the property.",
"type": "string"
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type and primary use of property.",
"enum": ["retail",
"yoga",
"fitness"
],
"meta:enum": {"retail": "Retail Store",
"yoga": "Yoga Studio",
"fitness": "Fitness Center"
}
},
"propertyConstruction": {"$ref ": "https://ns.adobe.com/{TENANT_ID}/datatypes/24c643f618647344606222c494bd0102"
}
}
}
}
}
},
"allOf": [{"$ref ": "#/definitions/customFields",
"type": "object",
"meta:xdmType": "object"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:registryMetadata": {"repo:createdDate": 1594941263588,
"repo:lastModifiedDate": 1594941538433,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "5e8a5e508eb2ed344c08cb23ed27cfb60c841bec59a2f7513deda0f7af903021",
"meta:globalLibVersion": "1.15.4"
},
"meta:containerId": "tenant",
"meta:tenantNamespace": "_{TENANT_ID}"
}

Update a custom mixinDeprecated

NOTE: This endpoint is deprecated. For future implementations, please use the equivalent operation for the field groups endpoint instead.

Request

path Parameters

MIXIN_ID

required

string

The meta:altId or URL-encoded $id of the mixin in question.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

type required	string The JSON Schema data type for the field group. Must be set to `object`.
title required	string A title for the field group.
description	string A description for the field group.
meta:intendedToExtend required	Array of strings Contains the `$id` value(s) of the class(es) that this field group is compatible with.
definitions	object Describes the unique attributes provided by the field group that are not inherited from other XDM resources. Custom attributes must be nested under `properties._{TENANT_ID}` to avoid collisions with similar fields provided by classes and other field groups. For details on how to define different field types to include in your field group, see the field constraints guide.
	Array of objects A list of reference strings that determine the attributes that the field group provides. A string can refer to a custom field definition provided under the `definitions` object (e.g. `#/definitions/property`) or the `$id` of another field group or data type that this field group extends or employs.

Responses

200

Success

400

Bad formatting

put/tenant/mixins/{MIXIN_ID}

Request samples

Payload

application/json

{"type": "object",
"title": "Property Details",
"description": "Detailed information related to the properties owned and operated by the company.",
"meta:intendedToExtend": ["https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
],
"definitions": {"property": {"properties": {"_{TENANT_ID}": {"type": "object",
"properties": {"propertyName": {"type": "string",
"title": "Property Name",
"description": "Name of the property"
},
"propertyCity": {"title": "Property City",
"description": "City where the property is located.",
"type": "string"
},
"phoneNumber": {"title": "Phone Number",
"description": "Primary phone number for the property.",
"type": "string"
},
"propertyType": {"type": "string",
"title": "Property Type",
"description": "Type and primary use of property.",
"enum": ["retail",
"yoga",
"fitness"
],
"meta:enum": {"retail": "Retail Store",
"yoga": "Yoga Studio",
"fitness": "Fitness Center"
}
},
"propertyConstruction": {"$ref ": "https://ns.adobe.com/{TENANT_ID}/datatypes/24c643f618647344606222c494bd0102"
}
}
}
}
}
},
"allOf": [{"$ref": "#/definitions/property"
}
]
}

Update custom mixinDeprecated

NOTE: This endpoint is deprecated. For future implementations, please use the equivalent operation for the field groups endpoint instead.

Request

path Parameters

MIXIN_ID

required

string

The meta:altId or URL-encoded $id of the mixin in question.

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 IMS 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 for more information.
Content-Type required	string The type of content being sent in the body of the request. When sending requests that include payloads to the Schema Registry API, this header must be included with a value of `application/json`.

Request Body schema: application/json
required

The request body accepts a JSON Patch payload.

Array

op required	string The JSON Patch operation to be performed.
path required	string The path to the field that the operation should be performed on.
value	string If adding or updating an attribute, this property indicates the value that should be set for that property.

Responses

200

Success

400

Bad formatting

patch/tenant/mixins/{MIXIN_ID}

Request samples

Payload

application/json

[{"op": "add",
"path": "/definitions/property/properties/_{TENANT_ID}/properties/propertyCity",
"value": {"title": "Property Country",
"description": "The country where the property is located.",
"type": "string"
}
}
]

Delete a custom mixinDeprecated

NOTE: This endpoint is deprecated. For future implementations, please use the equivalent operation for the field groups endpoint instead.

Request

path Parameters

MIXIN_ID

required

string

The meta:altId or URL-encoded $id of the mixin in question.

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 IMS 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 for more information.

Responses

204

No content

404

Not found

500

Internal server error

delete/tenant/mixins/{MIXIN_ID}

Get credentials

Schema Registry API (1.0)

Stats

Retrieve your tenant ID and other usage information related to the Schema Registry.

header Parameters

Schemas

List schemas

path Parameters

query Parameters

header Parameters

Retrieve a schema

path Parameters

header Parameters

Create a custom schema

header Parameters

Request Body schema: application/jsonrequired

Update a custom schema

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Update one or more attributes of a custom schema

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Delete a custom schema

path Parameters

header Parameters

Behaviors

List behaviors

header Parameters

Retrieve a behavior

path Parameters

header Parameters

Classes

List classes

path Parameters

query Parameters

header Parameters

Retrieve a class

path Parameters

header Parameters

Create a custom class

header Parameters

Request Body schema: application/jsonrequired

Update a custom class

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Update one or more attributes of a custom class

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Delete a custom class

path Parameters

header Parameters

Field groups

List field groups

path Parameters

query Parameters

header Parameters

Retrieve a field group

path Parameters

header Parameters

Create a custom field group

header Parameters

Request Body schema: application/jsonrequired

Update a custom field group

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Update a custom field group

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Delete a custom field group

path Parameters

header Parameters

Data types

List data types

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

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