Se você souber o identificador exclusivo de um Catalog objeto, você pode executar uma solicitação GET para exibir os detalhes desse objeto.
Ao visualizar objetos específicos, ainda é prática recomendada filtrar por propriedades e retornam somente as propriedades em que você está interessado.
Formato da API
GET /{OBJECT_TYPE}/{OBJECT_ID}
GET /{OBJECT_TYPE}/{OBJECT_ID}?properties={PROPERTY_1},{PROPERTY_2},{PROPERTY_3}
Parâmetro | Descrição |
---|---|
{OBJECT_TYPE} |
O tipo de Catalog objeto a ser recuperado. Os objetos válidos são:
|
{OBJECT_ID} |
O identificador do objeto específico que você deseja recuperar. |
Solicitação
A solicitação a seguir recupera um conjunto de dados por sua ID, retornando seu name
, description
, state
, tags
, e files
propriedades.
curl -X GET \
'https://platform.adobe.io/data/foundation/catalog/dataSets/5ba9452f7de80400007fc52a?properties=name,description,state,tags,files' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Resposta
Uma resposta bem-sucedida retorna o conjunto de dados especificado somente com o properties
no corpo.
{
"5ba9452f7de80400007fc52a": {
"name": "Sample Dataset",
"description": "Sample dataset containing important data.",
"state": "DRAFT",
"tags": {
"adobe/pqs/table": [
"sample_dataset"
]
},
"files": "@/dataSets/5ba9452f7de80400007fc52a/views/5ba9452f7de80400007fc52b/files"
}
}
Propriedades cujos valores recebem o prefixo @
representam objetos inter-relacionados. Consulte a seção do apêndice sobre exibição de objetos inter-relacionados para obter etapas sobre como visualizar os detalhes desses objetos.