Ponto de extremidade de propriedades
Uma propriedade é uma construção de container que contém a maioria dos outros recursos disponíveis na API do Reactor. Você gerencia propriedades de forma programática usando o ponto de extremidade /properties
.
Na hierarquia de recursos, uma propriedade é o proprietário do seguinte:
Uma propriedade pertence a exatamente uma empresa. Uma empresa pode ter muitas propriedades.
Para obter informações mais gerais sobre propriedades e sua função no gerenciamento de tags, consulte a visão geral em empresas e propriedades.
Introdução
O endpoint usado neste manual faz parte da API do Reactor. Antes de continuar, consulte o Guia de introdução para obter informações importantes sobre como realizar a autenticação na API.
Recuperar uma lista de propriedades list
Você pode recuperar uma lista de propriedades pertencentes à empresa incluindo a ID da empresa no caminho de uma solicitação GET.
Formato da API
GET /companies/{COMPANY_ID}/properties
COMPANY_ID
id
da empresa que detém as propriedades que você quer listar.copying
created_at
enabled
name
platform
token
updated_at
Solicitação
curl -X GET \
https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1/properties \
-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'
Resposta
Uma resposta bem-sucedida retorna uma lista de propriedades da empresa especificada.
{
"data": [
{
"id": "PR29e066628dcf4ba0a16780b2e339821c",
"type": "properties",
"attributes": {
"created_at": "2020-12-14T17:51:28.215Z",
"enabled": true,
"name": "Kessel Example Property",
"updated_at": "2020-12-14T17:51:28.215Z",
"platform": "web",
"development": false,
"token": "30a138ca7f5b",
"domains": [
"example.com"
],
"undefined_vars_return_empty": false,
"rule_component_sequencing_enabled": false
},
"relationships": {
"company": {
"links": {
"related": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/company"
},
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
},
"callbacks": {
"links": {
"related": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/callbacks"
}
},
"hosts": {
"links": {
"related": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/hosts"
}
},
"environments": {
"links": {
"related": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/environments"
}
},
"libraries": {
"links": {
"related": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/libraries"
}
},
"data_elements": {
"links": {
"related": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/data_elements"
}
},
"extensions": {
"links": {
"related": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/extensions"
}
},
"rules": {
"links": {
"related": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/rules"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/notes"
}
}
},
"links": {
"company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"data_elements": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/data_elements",
"environments": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/environments",
"extensions": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/extensions",
"rules": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c/rules",
"self": "https://reactor.adobe.io/properties/PR29e066628dcf4ba0a16780b2e339821c"
},
"meta": {
"rights": [
"approve",
"develop",
"manage_environments",
"manage_extensions",
"publish"
]
}
},
{
"id": "PR0c559a62480142a7b9be4a118d1a0448",
"type": "properties",
"attributes": {
"created_at": "2020-08-14T15:29:34.241Z",
"enabled": true,
"name": "new prop",
"updated_at": "2020-08-14T15:29:34.241Z",
"platform": "web",
"development": true,
"token": "b6cee01dedb7",
"domains": [
"google.com"
],
"undefined_vars_return_empty": false,
"rule_component_sequencing_enabled": false
},
"relationships": {
"company": {
"links": {
"related": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/company"
},
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
},
"callbacks": {
"links": {
"related": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/callbacks"
}
},
"hosts": {
"links": {
"related": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/hosts"
}
},
"environments": {
"links": {
"related": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/environments"
}
},
"libraries": {
"links": {
"related": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/libraries"
}
},
"data_elements": {
"links": {
"related": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/data_elements"
}
},
"extensions": {
"links": {
"related": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/extensions"
}
},
"rules": {
"links": {
"related": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/rules"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/notes"
}
}
},
"links": {
"company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"data_elements": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/data_elements",
"environments": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/environments",
"extensions": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/extensions",
"rules": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448/rules",
"self": "https://reactor.adobe.io/properties/PR0c559a62480142a7b9be4a118d1a0448"
},
"meta": {
"rights": [
"approve",
"develop",
"manage_environments",
"manage_extensions",
"publish"
]
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 2
}
}
}
Pesquisar uma propriedade lookup
Você pode pesquisar uma propriedade fornecendo a respectiva ID no caminho de uma solicitação GET.
Formato da API
GET /properties/{PROPERTY_ID}
PROPERTY_ID
id
da propriedade que você deseja pesquisar.Solicitação
curl -X GET \
https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1 \
-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'
Resposta
Uma resposta bem-sucedida retorna os detalhes da propriedade.
{
"data": {
"id": "PR48ade10e6acf4385ba96214e9f5d31e1",
"type": "properties",
"attributes": {
"created_at": "2020-12-14T17:51:18.725Z",
"enabled": true,
"name": "Kessel Example Property",
"updated_at": "2020-12-14T17:51:18.725Z",
"platform": "web",
"development": false,
"token": "c54ba5e843e6",
"domains": [
"example.com"
],
"undefined_vars_return_empty": false,
"rule_component_sequencing_enabled": false
},
"relationships": {
"company": {
"links": {
"related": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/company"
},
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
},
"callbacks": {
"links": {
"related": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/callbacks"
}
},
"hosts": {
"links": {
"related": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/hosts"
}
},
"environments": {
"links": {
"related": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/environments"
}
},
"libraries": {
"links": {
"related": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/libraries"
}
},
"data_elements": {
"links": {
"related": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/data_elements"
}
},
"extensions": {
"links": {
"related": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/extensions"
}
},
"rules": {
"links": {
"related": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/rules"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/notes"
}
}
},
"links": {
"company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"data_elements": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/data_elements",
"environments": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/environments",
"extensions": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/extensions",
"rules": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1/rules",
"self": "https://reactor.adobe.io/properties/PR48ade10e6acf4385ba96214e9f5d31e1"
},
"meta": {
"rights": [
"approve",
"develop",
"manage_environments",
"manage_extensions",
"publish"
]
}
}
}
Criar uma propriedade create
Você pode criar uma nova propriedade fazendo uma solicitação POST.
Formato da API
POST /company/{COMPANY_ID}/properties
COMPANY_ID
id
da empresa na qual você está definindo a propriedade.Solicitação
A solicitação a seguir cria uma nova propriedade para a propriedade especificada. A chamada também associa a propriedade a uma extensão existente por meio da propriedade relationships
. Consulte o manual sobre relacionamentos para obter mais informações.
curl -X POST \
https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1/properties \
-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": "Kessel Example Property",
"platform": "web"
"domains": [
"example.com"
],
"privacy": "gdpr",
"rule_component_sequencing_enabled": false,
"ssl_enabled": false,
"undefined_vars_return_empty": true
},
"type": "properties"
}
}'
attributes.name
attributes.platform
web
para propriedades da Web ou mobile
ou edge
para propriedades móveis.attributes.domains
attributes.development
attributes.privacy
attributes.rule_component_sequencing_enabled
attributes.ssl_enabled
attributes.undefined_vars_return_empty
type
properties
.Resposta
Uma resposta bem-sucedida retorna os detalhes da propriedade recém-criada.
{
"data": {
"id": "PR505e39de0d0042d1b22321e7767edb4d",
"type": "properties",
"attributes": {
"created_at": "2020-12-14T17:31:31.579Z",
"enabled": true,
"name": "Kessel Example Property",
"updated_at": "2020-12-14T17:31:31.579Z",
"platform": "web",
"development": false,
"token": "a969ffc6f872",
"domains": [
"example.com"
],
"undefined_vars_return_empty": false,
"rule_component_sequencing_enabled": false
},
"relationships": {
"company": {
"links": {
"related": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/company"
},
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
},
"callbacks": {
"links": {
"related": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/callbacks"
}
},
"hosts": {
"links": {
"related": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/hosts"
}
},
"environments": {
"links": {
"related": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/environments"
}
},
"libraries": {
"links": {
"related": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/libraries"
}
},
"data_elements": {
"links": {
"related": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/data_elements"
}
},
"extensions": {
"links": {
"related": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/extensions"
}
},
"rules": {
"links": {
"related": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/rules"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/notes"
}
}
},
"links": {
"company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"data_elements": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/data_elements",
"environments": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/environments",
"extensions": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/extensions",
"rules": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d/rules",
"self": "https://reactor.adobe.io/properties/PR505e39de0d0042d1b22321e7767edb4d"
},
"meta": {
"rights": [
"approve",
"develop",
"manage_environments",
"manage_extensions",
"publish"
]
}
}
}
Atualizar uma propriedade update
Você pode atualizar uma propriedade incluindo sua ID no caminho de uma solicitação PATCH.
Formato da API
PATCH /properties/{PROPERTY_ID}
PROPERTY_ID
id
da propriedade que você deseja atualizar.Solicitação
A solicitação a seguir atualiza name
e domains
para uma propriedade existente.
curl -X PATCH \
https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740 \
-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": "Kessel Property B",
"domains": [
"example.com"
]
},
"id": "PR541dbb24bad54dceb04710d7a9e7a740",
"type": "properties"
}
}'
attributes
Um objeto cujas propriedades representam os atributos que serão atualizados para a propriedade. Os atributos a seguir podem ser atualizados para uma propriedade:
development
domains
name
platform
privacy
rule_component_sequencing_enabled
ssl_enabled
undefined_vars_return_empty
id
id
da propriedade que você deseja atualizar. Ele deve corresponder ao valor {PROPERTY_ID}
fornecido no caminho da solicitação.type
properties
.Resposta
Uma resposta bem-sucedida retorna os detalhes da propriedade atualizada.
{
"data": {
"id": "PR541dbb24bad54dceb04710d7a9e7a740",
"type": "properties",
"attributes": {
"created_at": "2020-12-14T17:51:37.386Z",
"enabled": true,
"name": "Kessel Property B",
"updated_at": "2020-12-14T17:51:43.062Z",
"platform": "web",
"development": false,
"token": "3f2d8630a8d3",
"domains": [
"example.com"
],
"undefined_vars_return_empty": false,
"rule_component_sequencing_enabled": false
},
"relationships": {
"company": {
"links": {
"related": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/company"
},
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
},
"callbacks": {
"links": {
"related": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/callbacks"
}
},
"hosts": {
"links": {
"related": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/hosts"
}
},
"environments": {
"links": {
"related": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/environments"
}
},
"libraries": {
"links": {
"related": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/libraries"
}
},
"data_elements": {
"links": {
"related": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/data_elements"
}
},
"extensions": {
"links": {
"related": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/extensions"
}
},
"rules": {
"links": {
"related": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/rules"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/notes"
}
}
},
"links": {
"company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"data_elements": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/data_elements",
"environments": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/environments",
"extensions": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/extensions",
"rules": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740/rules",
"self": "https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740"
},
"meta": {
"rights": [
"approve",
"develop",
"manage_environments",
"manage_extensions",
"publish"
]
}
}
}
Excluir uma propriedade da
Você pode excluir uma propriedade incluindo sua ID no caminho de uma solicitação DELETE.
Formato da API
DELETE /properties/{PROPERTY_ID}
PROPERTY_ID
id
da propriedade que você deseja excluir.Solicitação
curl -X DELETE \
https://reactor.adobe.io/properties/PR541dbb24bad54dceb04710d7a9e7a740 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}'
Resposta
Uma resposta bem-sucedida retorna o status HTTP 204 (Sem conteúdo) sem corpo de resposta, indicando que a propriedade foi excluída.
Gerenciar notas de uma propriedade notes
As propriedades são recursos "notáveis", o que significa que você pode criar e recuperar notas baseadas em texto em cada recurso individual. Consulte o manual de ponto de extremidade de notas para obter mais informações sobre como gerenciar notas para propriedades e outros recursos compatíveis.
Recuperar recursos relacionados de uma propriedade related
As chamadas a seguir demonstram como recuperar os recursos relacionados de uma propriedade. Quando procurar uma propriedade, esses relacionamentos são listados na propriedade relationships
.
Consulte o manual de relacionamentos para obter mais informações sobre relacionamentos na API do reator.
Listar retornos de chamada relacionados de uma propriedade callbacks
Você pode listar os retornos de chamada que estão registrados em uma propriedade anexando /callbacks
ao caminho de uma solicitação de pesquisa.
Formato da API
GET /properties/{PROPERTY_ID}/callbacks
{PROPERTY_ID}
id
da propriedade cujos retornos de chamada você deseja listar.Solicitação
curl -X GET \
https://reactor.adobe.io/properties/PR66a3356c73fc4aabb67ee22caae53d70/callbacks \
-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'
Resposta
Uma resposta bem-sucedida retorna uma lista de retornos de chamada que são de propriedade da propriedade especificada.
{
"data": [
{
"id": "CB26edef8d709243579589107bcda034da",
"type": "callbacks",
"attributes": {
"created_at": "2020-12-14T17:34:47.082Z",
"subscriptions": [
"rule.created"
],
"updated_at": "2020-12-14T17:34:47.082Z",
"url": "https://www.example.com"
},
"relationships": {
"property": {
"links": {
"related": "https://reactor.adobe.io/callbacks/CB26edef8d709243579589107bcda034da/property"
},
"data": {
"id": "PR66a3356c73fc4aabb67ee22caae53d70",
"type": "properties"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR66a3356c73fc4aabb67ee22caae53d70",
"self": "https://reactor.adobe.io/callbacks/CB26edef8d709243579589107bcda034da"
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Listar os elementos de dados relacionados de uma propriedade data-elements
Você pode listar os elementos de dados que pertencem a uma propriedade anexando /data_elements
ao caminho de uma solicitação de pesquisa.
Formato da API
GET /properties/{PROPERTY_ID}/data_elements
{PROPERTY_ID}
id
da propriedade cujos elementos de dados você deseja listar.Solicitação
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'
Resposta
Uma resposta bem-sucedida retorna uma lista de elementos de dados pertencentes à propriedade especificada.
{
"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
}
}
}
Listar os ambientes relacionados de uma propriedade environments
Você pode listar os ambientes que pertencem a uma propriedade anexando /environments
ao caminho de uma solicitação de pesquisa.
Formato da API
GET /properties/{PROPERTY_ID}/environments
{PROPERTY_ID}
id
da propriedade cujos ambientes você deseja listar.Solicitação
curl -X GET \
https://reactor.adobe.io/properties/PR06c9196bc57048dd8ff169c27baeeca8/environments \
-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'
Resposta
Uma resposta bem-sucedida retorna uma lista de ambientes que pertencem à propriedade especificada.
{
"data": [
{
"id": "ENbe322acb4fc64dfdb603254ffe98b5d3",
"type": "environments",
"attributes": {
"archive": false,
"created_at": "2020-12-14T17:38:51.047Z",
"library_path": "f9fd106ab399/cb29d726b35e",
"library_name": "launch-c0331746ae03-development.min.js",
"library_entry_points": [
{
"library_name": "launch-c0331746ae03-development.min.js",
"minified": true,
"references": [
"f9fd106ab399/cb29d726b35e/launch-c0331746ae03-development.min.js"
],
"license_path": "f9fd106ab399/cb29d726b35e/launch-c0331746ae03-development.js"
},
{
"library_name": "launch-c0331746ae03-development.js",
"minified": false,
"references": [
"f9fd106ab399/cb29d726b35e/launch-c0331746ae03-development.js"
]
}
],
"name": "Development Environment A",
"path": "https://assets.adobedtm.com/staging",
"stage": "development",
"updated_at": "2020-12-14T17:38:51.047Z",
"status": "succeeded",
"token": "c0331746ae03"
},
"relationships": {
"library": {
"links": {
"related": "https://reactor.adobe.io/environments/ENbe322acb4fc64dfdb603254ffe98b5d3/library"
},
"data": null
},
"builds": {
"links": {
"related": "https://reactor.adobe.io/environments/ENbe322acb4fc64dfdb603254ffe98b5d3/builds"
}
},
"host": {
"links": {
"related": "https://reactor.adobe.io/environments/ENbe322acb4fc64dfdb603254ffe98b5d3/host",
"self": "https://reactor.adobe.io/environments/ENbe322acb4fc64dfdb603254ffe98b5d3/relationships/host"
},
"data": {
"id": "HTc5cae9ce1e3943aab185bdba939f98bd",
"type": "hosts"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/environments/ENbe322acb4fc64dfdb603254ffe98b5d3/property"
},
"data": {
"id": "PR06c9196bc57048dd8ff169c27baeeca8",
"type": "properties"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR06c9196bc57048dd8ff169c27baeeca8",
"self": "https://reactor.adobe.io/environments/ENbe322acb4fc64dfdb603254ffe98b5d3"
},
"meta": {
"archive_encrypted": false
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Listar as extensões relacionadas de uma propriedade extensions
Você pode listar as extensões que pertecem a uma propriedade anexando /extensions
ao caminho de uma solicitação de pesquisa.
Formato da API
GET /properties/{PROPERTY_ID}/extensions
{PROPERTY_ID}
id
da propriedade cujas extensões você deseja listar.Solicitação
curl -X GET \
https://reactor.adobe.io/properties/PRee071cb5b7794f42b74c913e1ad2e325/extensions \
-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'
Resposta
Uma resposta bem-sucedida retorna uma lista de extensões pertencentes à propriedade especificada.
{
"data": [
{
"id": "EXd9d80c87afb6432ba823a58d3e78299b",
"type": "extensions",
"attributes": {
"created_at": "2020-12-14T17:40:21.000Z",
"deleted_at": null,
"dirty": false,
"enabled": true,
"name": "kessel-test",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:40:21.000Z",
"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/EXd9d80c87afb6432ba823a58d3e78299b/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/extensions/EXd9d80c87afb6432ba823a58d3e78299b/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/extensions/EXd9d80c87afb6432ba823a58d3e78299b/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/extensions/EXd9d80c87afb6432ba823a58d3e78299b/property"
},
"data": {
"id": "PRee071cb5b7794f42b74c913e1ad2e325",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/extensions/EXd9d80c87afb6432ba823a58d3e78299b/origin"
},
"data": {
"id": "EXd9d80c87afb6432ba823a58d3e78299b",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/extensions/EXd9d80c87afb6432ba823a58d3e78299b/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"extension_package": {
"links": {
"related": "https://reactor.adobe.io/extensions/EXd9d80c87afb6432ba823a58d3e78299b/extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PRee071cb5b7794f42b74c913e1ad2e325",
"origin": "https://reactor.adobe.io/extensions/EXd9d80c87afb6432ba823a58d3e78299b",
"self": "https://reactor.adobe.io/extensions/EXd9d80c87afb6432ba823a58d3e78299b",
"extension_package": "https://reactor.adobe.io/extension_packages/EP75db2452065b44e2b8a38ca883ce369a",
"latest_extension_package": "https://reactor.adobe.io/extension_packages/EP75db2452065b44e2b8a38ca883ce369a"
},
"meta": {
"latest_revision_number": 1
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Listar os hosts relacionados de uma propriedade hosts
Você pode listar os hosts que são usados por uma propriedade anexando /hosts
ao caminho de uma solicitação de pesquisa.
Formato da API
GET /properties/{PROPERTY_ID}/hosts
{PROPERTY_ID}
id
da propriedade cujos hosts você deseja listar.Solicitação
curl -X GET \
https://reactor.adobe.io/properties/PRd428c2a25caa4b32af61495f5809b737/hosts \
-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'
Resposta
Uma resposta bem-sucedida retorna uma lista de hosts usados por uma propriedade especificada.
{
"data": [
{
"id": "HT405b8d9306004eb38106e66c8a4afc09",
"type": "hosts",
"attributes": {
"created_at": "2020-12-14T17:42:35.239Z",
"server": null,
"name": "Example Akamai Host",
"path": null,
"port": null,
"status": "succeeded",
"type_of": "akamai",
"updated_at": "2020-12-14T17:42:35.239Z",
"username": null
},
"relationships": {
"property": {
"links": {
"related": "https://reactor.adobe.io/hosts/HT405b8d9306004eb38106e66c8a4afc09/property"
},
"data": {
"id": "PRd428c2a25caa4b32af61495f5809b737",
"type": "properties"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PRd428c2a25caa4b32af61495f5809b737",
"self": "https://reactor.adobe.io/hosts/HT405b8d9306004eb38106e66c8a4afc09"
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Listar as regras relacionadas de uma propriedade rules
Você pode listar as regras que são usadas por uma propriedade anexando /rules
ao caminho de uma solicitação de pesquisa.
Formato da API
GET /properties/{PROPERTY_ID}/rules
{PROPERTY_ID}
id
da propriedade cujas regras você deseja listar.Solicitação
curl -X GET \
https://reactor.adobe.io/properties/PR41f64d2a9d9b4862b0582c5ff6a07504/rules \
-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'
Resposta
Uma resposta bem-sucedida retorna uma lista de regras usadas por uma propriedade especificada.
{
"data": [
{
"id": "RL8429f3fee98b44c68f7a538e68e21747",
"type": "rules",
"attributes": {
"created_at": "2020-12-14T17:56:44.109Z",
"deleted_at": null,
"dirty": true,
"enabled": true,
"name": "Example Rule",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:56:44.109Z",
"review_status": "unsubmitted"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/rules/RL8429f3fee98b44c68f7a538e68e21747/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/rules/RL8429f3fee98b44c68f7a538e68e21747/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/rules/RL8429f3fee98b44c68f7a538e68e21747/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/rules/RL8429f3fee98b44c68f7a538e68e21747/property"
},
"data": {
"id": "PR41f64d2a9d9b4862b0582c5ff6a07504",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/rules/RL8429f3fee98b44c68f7a538e68e21747/origin"
},
"data": {
"id": "RL8429f3fee98b44c68f7a538e68e21747",
"type": "rules"
}
},
"rule_components": {
"links": {
"related": "https://reactor.adobe.io/rules/RL8429f3fee98b44c68f7a538e68e21747/rule_components"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR41f64d2a9d9b4862b0582c5ff6a07504",
"origin": "https://reactor.adobe.io/rules/RL8429f3fee98b44c68f7a538e68e21747",
"self": "https://reactor.adobe.io/rules/RL8429f3fee98b44c68f7a538e68e21747",
"rule_components": "https://reactor.adobe.io/rules/RL8429f3fee98b44c68f7a538e68e21747/rule_components"
},
"meta": {
"latest_revision_number": 0
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Procurar uma propriedade na empresa relacionada company
Você pode procurar a empresa que detém uma propriedade anexando /company
ao caminho de uma solicitação de pesquisa.
Formato da API
GET /properties/{PROPERTY_ID}/company
{PROPERTY_ID}
id
da propriedade cuja empresa você deseja procurar.Solicitação
curl -X GET \
https://reactor.adobe.io/properties/HT5d90148e72224224aac9bc0b01498b84/company \
-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'
Resposta
Uma resposta bem-sucedida retorna os detalhes da empresa da propriedade especificada.
{
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies",
"attributes": {
"created_at": "2020-08-13T17:13:30.711Z",
"name": "Reactor QE",
"org_id": "08364A825824E04F0A494115@AdobeOrg",
"updated_at": "2020-08-13T17:13:30.711Z",
"token": "f9fd106ab399",
"cjm_enabled": true,
"edge_enabled": false,
"edge_events_allotment": null,
"edge_fanout_ratio": null
},
"relationships": {
"properties": {
"links": {
"related": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1/properties"
}
}
},
"links": {
"self": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"properties": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1/properties"
},
"meta": {
"rights": [
"develop_extensions",
"manage_properties",
"manage_app_configurations"
],
"platform_rights": {
"web": [
"develop_extensions",
"manage_properties",
"manage_app_configurations"
],
"mobile": [
"develop_extensions",
"manage_properties",
"manage_app_configurations"
]
}
}
}
}