数据元素具有变量功能,指向应用程序中的重要数据段。 数据元素用在 规则 和 扩展 配置。 在运行时在浏览器或应用程序中触发规则时,数据元素的值将被解析并在规则中使用。 数据元素的功能与扩展配置相同。
将多个数据元素一起使用会导致数据字典或数据映射。 该词典代表Adobe Experience Platform知道并且可以利用的数据。
数据元素只属于一个 属性. 资产可以有许多数据元素。
有关数据元素及其在标记中的使用的更多常规信息,请参阅 数据元素指南 在UI文档中。
本指南中使用的端点是 Reactor API. 在继续之前,请查看 快速入门指南 有关如何对API进行身份验证的重要信息。
通过在GET请求的路径中包含资产的ID,可以检索资产的数据元素列表。
API格式
GET /properties/{PROPERTY_ID}/data_elements
参数 | 描述 |
---|---|
PROPERTY_ID |
此 id 拥有数据元素的属性的ID。 |
使用查询参数,可以根据以下属性筛选列出的数据元素:
created_at
dirty
enabled
name
origin_id
published
published_at
revision_number
updated_at
请求
curl -X GET \
https://reactor.adobe.io/properties/PR97d92a379a5f48758947cdf44f607a0d/data_elements \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
响应
成功的响应将返回指定属性的数据元素列表。
{
"data": [
{
"id": "DE5d11b3ed301d4ce99b530a5121e392b2",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:36:09.045Z",
"deleted_at": null,
"dirty": true,
"enabled": true,
"name": "My Data Element 2020-12-14 17:36:08 +0000",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:36:09.045Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementProperty\":\"html\",\"elementSelector\":\".target-element\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/property"
},
"data": {
"id": "PR97d92a379a5f48758947cdf44f607a0d",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/origin"
},
"data": {
"id": "DE5d11b3ed301d4ce99b530a5121e392b2",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/extension"
},
"data": {
"id": "EX0348d463358c4c89afe726245576f112",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/updated_with_extension"
},
"data": {
"id": "EX1cc78b39339242da82a0e0752fa53375",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR97d92a379a5f48758947cdf44f607a0d",
"origin": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2",
"self": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2",
"extension": "https://reactor.adobe.io/extensions/EX0348d463358c4c89afe726245576f112"
},
"meta": {
"latest_revision_number": 0
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
您可以通过在GET请求的路径中提供数据元素的ID来查找该数据元素。
删除数据元素时,会将它们标记为已删除,但实际上并不从系统中将其删除。 因此,可以查找已删除的数据元素。 删除的数据元素可以通过存在 data.meta.deleted_at
属性。
API格式
GET /data_elements/{DATA_ELEMENT_ID}
参数 | 描述 |
---|---|
DATA_ELEMENT_ID |
此 id 要查找的数据元素的ID。 |
请求
curl -X GET \
https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
响应
成功响应将返回数据元素的详细信息。
{
"data": {
"id": "DE8097636264104451ac3a18c95d5ff833",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:35:54.956Z",
"deleted_at": null,
"dirty": true,
"enabled": true,
"name": "My Data Element 2020-12-14 17:35:54 +0000",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:35:54.956Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementProperty\":\"html\",\"elementSelector\":\".target-element\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/property"
},
"data": {
"id": "PRa5621686159f44c880557e12af412a95",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/origin"
},
"data": {
"id": "DE8097636264104451ac3a18c95d5ff833",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/extension"
},
"data": {
"id": "EX085a465793b54be39b5408d13b50b46e",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/updated_with_extension"
},
"data": {
"id": "EXf9a32699efde42e9b9410b43bd660848",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PRa5621686159f44c880557e12af412a95",
"origin": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833",
"self": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833",
"extension": "https://reactor.adobe.io/extensions/EX085a465793b54be39b5408d13b50b46e"
},
"meta": {
"latest_revision_number": 0
}
}
}
您可以通过发出POST请求来创建新的数据元素。
API格式
POST /properties/{PROPERTY_ID}/data_elements
参数 | 描述 |
---|---|
PROPERTY_ID |
此 id 的 属性 下定义数据元素的位置。 |
请求
以下请求为指定的属性创建新数据元素。 该调用还会通过 relationships
属性。 请参阅指南,网址为 关系 了解更多信息。
curl -X POST \
https://reactor.adobe.io/properties/PR97d92a379a5f48758947cdf44f607a0d/data_elements \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"attributes": {
"name": "My Data Element 2020-12-14 17:33:21 +0000",
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"settings": "{\"elementSelector\":\".target-element\",\"elementProperty\":\"html\"}",
"default_value": "general_label",
"enabled": true,
"force_lower_case": true,
"clean_text": true,
},
"relationships": {
"extension": {
"data": {
"id": "EX28788723a8e24a2f927fce1b55eb7ffc",
"type": "extensions"
}
}
},
"type": "data_elements"
}
}'
属性 | 描述 |
---|---|
attributes.name |
(必需) 易于用户识别的数据元素名称。 |
attributes.delegate_descriptor_id |
(必需) 将数据元素与扩展包关联的带格式的字符串。 首次创建扩展包时,所有数据元素都必须与扩展包关联,因为每个扩展包都为其委托数据元素定义了兼容类型及其预期行为。 请参阅指南,网址为 委托描述符ID 了解更多信息。 |
attributes.settings |
以字符串表示的设置JSON对象。 |
attributes.default_value |
数据元素的计算结果为 undefined . |
attributes.enabled |
指示是否启用数据元素的布尔值。 |
attributes.force_lower_case |
布尔值,指示在存储数据元素值之前是否应将其转换为小写。 |
attributes.clean_text |
布尔值,指示在存储之前是否应从数据元素值中删除前导和尾随空格。 |
type |
正在更新的资源类型。 对于此端点,值必须为 data_elements . |
响应
成功的响应将返回新创建的数据元素的详细信息。
{
"data": {
"id": "DE8667bc64ceba4b599e8458ea4ab58b8f",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:33:21.774Z",
"deleted_at": null,
"dirty": true,
"enabled": true,
"name": "My Data Element 2020-12-14 17:33:21 +0000",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:33:21.774Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementSelector\":\".target-element\",\"elementProperty\":\"html\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/property"
},
"data": {
"id": "PR05ad70a8078f44c1a229ecf0da2802f2",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/origin"
},
"data": {
"id": "DE8667bc64ceba4b599e8458ea4ab58b8f",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/extension"
},
"data": {
"id": "EX28788723a8e24a2f927fce1b55eb7ffc",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/updated_with_extension"
},
"data": {
"id": "EXd6bf04b143e64fe0ae7efe55a6655fa9",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR05ad70a8078f44c1a229ecf0da2802f2",
"origin": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f",
"self": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f",
"extension": "https://reactor.adobe.io/extensions/EX28788723a8e24a2f927fce1b55eb7ffc"
},
"meta": {
"latest_revision_number": 0
}
}
}
您可以通过在PATCH请求的路径中包含数据元素的ID来更新该数据元素。
API格式
PATCH /data_elements/{DATA_ELEMENT_ID}
参数 | 描述 |
---|---|
DATA_ELEMENT_ID |
此 id 要更新的数据元素的ID。 |
请求
以下请求将更新 name
(对于现有数据元素)。
curl -X PATCH \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"attributes": {
"name": "New Data Element Name"
},
"id": "DE3fab176ccf8641838b3da59f716fc42b",
"type": "data_elements"
}
}'
属性 | 描述 |
---|---|
attributes |
一个对象,其属性表示数据元素要更新的属性。 可以更新所有数据元素属性。 查看的示例调用 创建数据元素 以获取属性及其用例的列表。 |
id |
此 id 要更新的数据元素的ID。 这应该与 {DATA_ELEMENT_ID} 请求路径中提供的值。 |
type |
正在更新的资源类型。 对于此端点,值必须为 data_elements . |
响应
成功响应将返回已更新数据元素的详细信息。
{
"data": {
"id": "DE3fab176ccf8641838b3da59f716fc42b",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:36:24.552Z",
"deleted_at": null,
"dirty": true,
"enabled": true,
"name": "New Data Element Name",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:36:25.578Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementSelector\":\".target-element-b\",\"elementProperty\":\"html\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/property"
},
"data": {
"id": "PR85e261fb61ce44c9b2498807a6e6410b",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/origin"
},
"data": {
"id": "DE3fab176ccf8641838b3da59f716fc42b",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/extension"
},
"data": {
"id": "EX71f31a3eeec249dfb77fedd6c5ce6387",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/updated_with_extension"
},
"data": {
"id": "EX1f4df32a850c48a4930fb3e1dfa83536",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR85e261fb61ce44c9b2498807a6e6410b",
"origin": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b",
"self": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b",
"extension": "https://reactor.adobe.io/extensions/EX71f31a3eeec249dfb77fedd6c5ce6387"
},
"meta": {
"latest_revision_number": 0
}
}
}
修订数据元素时,将使用当前(标题)修订创建数据元素的新修订版本。 数据元素的每个修订版都将拥有自己的ID。 可以通过原始链接发现原始数据元素。
您可以通过提供 meta.action
具有值的属性 revise
在PATCH请求正文中。
API格式
PATCH /data_elements/{DATA_ELEMENT_ID}
参数 | 描述 |
---|---|
DATA_ELEMENT_ID |
此 id 要修订的数据元素的ID。 |
请求
curl -X PATCH \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"attributes": {
"name": "New Data Element Name"
},
"meta": {
"action": "revise"
},
"id": "DE7d7284657ee540ee8f402277860e9f8a",
"type": "data_elements"
}
}'
属性 | 描述 |
---|---|
attributes |
一个对象,其属性表示数据元素要更新的属性。 可以更新所有数据元素属性。 查看的示例调用 创建数据元素 以获取属性及其用例的列表。 |
meta.action |
当包含值时 revise ,此属性指示应为数据元素创建新的修订版本。 |
id |
此 id 要修订的数据元素的ID。 这应该与 {DATA_ELEMENT_ID} 请求路径中提供的值。 |
type |
正在修订的资源的类型。 对于此端点,值必须为 data_elements . |
响应
成功响应将返回数据元素的新修订的详细信息,如增量所示 meta.latest_revision_number
属性。
{
"data": {
"id": "DE3fab176ccf8641838b3da59f716fc42b",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:36:24.552Z",
"deleted_at": null,
"dirty": true,
"enabled": true,
"name": "New Data Element Name",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:36:25.578Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementSelector\":\".target-element-b\",\"elementProperty\":\"html\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/property"
},
"data": {
"id": "PR85e261fb61ce44c9b2498807a6e6410b",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/origin"
},
"data": {
"id": "DE3fab176ccf8641838b3da59f716fc42b",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/extension"
},
"data": {
"id": "EX71f31a3eeec249dfb77fedd6c5ce6387",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/updated_with_extension"
},
"data": {
"id": "EX1f4df32a850c48a4930fb3e1dfa83536",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR85e261fb61ce44c9b2498807a6e6410b",
"origin": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b",
"self": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b",
"extension": "https://reactor.adobe.io/extensions/EX71f31a3eeec249dfb77fedd6c5ce6387"
},
"meta": {
"latest_revision_number": 1
}
}
}
您可以在DELETE请求的路径中包含数据元素的ID来删除该数据元素。
API格式
DELETE /data_elements/{DATA_ELEMENT_ID}
参数 | 描述 |
---|---|
DATA_ELEMENT_ID |
此 id 要删除的数据元素的ID。 |
请求
curl -X DELETE \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}'
响应
成功的响应返回不带响应正文的HTTP状态204(无内容),这表示数据元素已被删除。
数据元素是“重要的”资源,这意味着您可以创建和检索每个单独资源中基于文本的注释。 请参阅 注释端点指南 有关如何管理数据元素和其他兼容资源的注释的更多信息。
以下调用演示了如何检索数据元素的相关资源。 时间 查找数据元素,这些关系列在 relationships
属性。
请参阅 关系指南 有关Reactor API中关系的更多信息。
您可以通过附加来列出利用数据元素的库 /libraries
到查找请求的路径。
API格式
GET /data_elements/{DATA_ELEMENT_ID}/libraries
参数 | 描述 |
---|---|
{DATA_ELEMENT_ID} |
此 id 要列出其库的数据元素的。 |
请求
curl -X GET \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/libraries \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
响应
成功响应将返回使用指定数据元素的库列表。
{
"data": [
{
"id": "LB62d20ad807a949e6b13b0a2c7299eb65",
"type": "libraries",
"attributes": {
"created_at": "2020-12-14T17:50:19.589Z",
"name": "My Library",
"published_at": null,
"state": "development",
"updated_at": "2020-12-14T17:50:19.589Z",
"build_required": true
},
"relationships": {
"builds": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/builds"
}
},
"environment": {
"links": {
"self": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/relationships/environment"
},
"data": null
},
"data_elements": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/data_elements",
"self": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/relationships/data_elements"
}
},
"extensions": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/extensions",
"self": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/relationships/extensions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/notes"
}
},
"rules": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/rules",
"self": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/relationships/rules"
}
},
"upstream_library": {
"data": null
},
"property": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/property"
},
"data": {
"id": "PR241ba9cd56324ac192de68d658f20cb0",
"type": "properties"
}
},
"last_build": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/last_build"
},
"data": null
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR241ba9cd56324ac192de68d658f20cb0",
"self": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65"
},
"meta": {
"build_status": null,
"build_required_detail": "No build found since last state change"
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
您可以通过附加来列出数据元素的先前修订版本 /revisions
到查找请求的路径。
API格式
GET /data_elements/{DATA_ELEMENT_ID}/revisions
参数 | 描述 |
---|---|
{DATA_ELEMENT_ID} |
此 id 要列出其修订的数据元素的ID。 |
请求
curl -X GET \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/revisions \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
响应
成功的响应将返回指定数据元素的修订列表。
{
"data": [
{
"id": "DEaeceb5164d494c768c18e37ec6f3b091",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:37:06.488Z",
"deleted_at": null,
"dirty": false,
"enabled": true,
"name": "My Data Element 2020-12-14 17:37:05 +0000",
"published": false,
"published_at": null,
"revision_number": 1,
"updated_at": "2020-12-14T17:37:06.488Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementProperty\":\"html\",\"elementSelector\":\".target-element\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/property"
},
"data": {
"id": "PR52072581500b44cd808e03e36c38e005",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/origin"
},
"data": {
"id": "DE5172417ff56e43d2a99ca149021bf65a",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/extension"
},
"data": {
"id": "EXdd53073348ef467683365286a33ade02",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/updated_with_extension"
},
"data": {
"id": "EXf9d7d1ca8e6f436b900659ce499c09ce",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR52072581500b44cd808e03e36c38e005",
"origin": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a",
"self": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091",
"extension": "https://reactor.adobe.io/extensions/EXdd53073348ef467683365286a33ade02"
},
"meta": {
"latest_revision_number": 1
}
},
{
"id": "DE5172417ff56e43d2a99ca149021bf65a",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:37:05.920Z",
"deleted_at": null,
"dirty": false,
"enabled": true,
"name": "My Data Element 2020-12-14 17:37:05 +0000",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:37:05.920Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementProperty\":\"html\",\"elementSelector\":\".target-element\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/property"
},
"data": {
"id": "PR52072581500b44cd808e03e36c38e005",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/origin"
},
"data": {
"id": "DE5172417ff56e43d2a99ca149021bf65a",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/extension"
},
"data": {
"id": "EXdd53073348ef467683365286a33ade02",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/updated_with_extension"
},
"data": {
"id": "EXf9d7d1ca8e6f436b900659ce499c09ce",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR52072581500b44cd808e03e36c38e005",
"origin": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a",
"self": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a",
"extension": "https://reactor.adobe.io/extensions/EXdd53073348ef467683365286a33ade02"
},
"meta": {
"latest_revision_number": 1
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 2
}
}
}
您可以通过附加来查找使用数据元素的扩展 /extension
到GET请求的路径。
API格式
GET /data_elements/{DATA_ELEMENT_ID}/extension
参数 | 描述 |
---|---|
{DATA_ELEMENT_ID} |
此 id 要查找其扩展的数据元素的。 |
请求
curl -X GET \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/extension \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
响应
成功的响应将返回使用指定数据元素的扩展的详细信息。
{
"data": {
"id": "EX9c7f9f1e826149978f2dadaf4c639679",
"type": "extensions",
"attributes": {
"created_at": "2020-12-14T17:37:31.952Z",
"deleted_at": null,
"dirty": false,
"enabled": true,
"name": "kessel-test",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:37:31.952Z",
"delegate_descriptor_id": null,
"display_name": "Kessel Test",
"review_status": "unsubmitted",
"version": "1.2.0",
"settings": "{}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/property"
},
"data": {
"id": "PR5c15543ef7bb403abc79d65fee0bf1f9",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/origin"
},
"data": {
"id": "EX9c7f9f1e826149978f2dadaf4c639679",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"extension_package": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR5c15543ef7bb403abc79d65fee0bf1f9",
"origin": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679",
"self": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679",
"extension_package": "https://reactor.adobe.io/extension_packages/EP75db2452065b44e2b8a38ca883ce369a",
"latest_extension_package": "https://reactor.adobe.io/extension_packages/EP75db2452065b44e2b8a38ca883ce369a"
},
"meta": {
"latest_revision_number": 1
}
}
}
您可以通过附加来查找数据元素的来源 /origin
到GET请求的路径。 数据元素的来源是进行更新以创建当前修订版的先前修订版。
API格式
GET /data_elements/{DATA_ELEMENT_ID}/origin
参数 | 描述 |
---|---|
{DATA_ELEMENT_ID} |
此 id 要查找其来源的数据元素的。 |
请求
curl -X GET \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/origin \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
响应
成功响应将返回指定数据元素原点的详细信息。
{
"data": {
"id": "DE790cb76f91594c2082a727b9f97024f6",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:37:19.891Z",
"deleted_at": null,
"dirty": false,
"enabled": true,
"name": "My Data Element 2020-12-14 17:37:19 +0000",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:37:19.891Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementProperty\":\"html\",\"elementSelector\":\".target-element\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/property"
},
"data": {
"id": "PRf1ac400fb1e04c689e28d5efcd675c94",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/origin"
},
"data": {
"id": "DE790cb76f91594c2082a727b9f97024f6",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/extension"
},
"data": {
"id": "EX2345dba2c8b34d1cbe2795e29c62bf27",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/updated_with_extension"
},
"data": {
"id": "EXad7ebb72d721478483b741eebfffda6a",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PRf1ac400fb1e04c689e28d5efcd675c94",
"origin": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6",
"self": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6",
"extension": "https://reactor.adobe.io/extensions/EX2345dba2c8b34d1cbe2795e29c62bf27"
},
"meta": {
"latest_revision_number": 1
}
}
}
您可以通过附加来查找拥有数据元素的属性 /property
到GET请求的路径。
API格式
GET /data_elements/{DATA_ELEMENT_ID}/property
参数 | 描述 |
---|---|
{DATA_ELEMENT_ID} |
此 id 要查找其属性的数据元素的。 |
请求
curl -X GET \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/property \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
响应
成功响应将返回拥有指定数据元素的属性的详细信息。
{
"data": {
"id": "PRae9440b0f3234c4286569485f2b7a6a2",
"type": "properties",
"attributes": {
"created_at": "2020-12-14T17:52:40.829Z",
"enabled": true,
"name": "Kessel Example Property",
"updated_at": "2020-12-14T17:52:40.829Z",
"platform": "web",
"development": false,
"token": "42daac072e1e",
"domains": [
"example.com"
],
"undefined_vars_return_empty": false,
"rule_component_sequencing_enabled": false
},
"relationships": {
"company": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/company"
},
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
},
"callbacks": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/callbacks"
}
},
"hosts": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/hosts"
}
},
"environments": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/environments"
}
},
"libraries": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/libraries"
}
},
"data_elements": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/data_elements"
}
},
"extensions": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/extensions"
}
},
"rules": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/rules"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/notes"
}
}
},
"links": {
"company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"data_elements": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/data_elements",
"environments": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/environments",
"extensions": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/extensions",
"rules": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/rules",
"self": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2"
},
"meta": {
"rights": [
"approve",
"develop",
"manage_environments",
"manage_extensions",
"publish"
]
}
}
}