Show Menu
TOPICS×

Look up an object

If you know the unique identifier for a specific Catalog object, you can perform a GET request to view that object's details.
When viewing specific objects, it is still best practice to filter by properties and return only the properties you are interested in.
API format
GET /{OBJECT_TYPE}/{OBJECT_ID}
GET /{OBJECT_TYPE}/{OBJECT_ID}?properties={PROPERTY_1},{PROPERTY_2},{PROPERTY_3}

Parameter
Description
{OBJECT_TYPE}
The type of Catalog object to be retrieved. Valid objects are:
  • accounts
  • batches
  • connections
  • connectors
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID}
The identifier of the specific object you want to retrieve.
Request
The following request retrieves a dataset by its ID, returning its name , description , state , tags , and files properties.
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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Response
A successful response returns the specified dataset with only the requested properties in the body.
{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset",
        "description": "Sample dataset containing important data.",
        "state": "DRAFT",
        "tags": {
            "adobe/pqs/table": [
                "sample_dataset"
            ]
        },
        "files": "@/dataSets/5ba9452f7de80400007fc52a/views/5ba9452f7de80400007fc52b/files"
    }
}

Properties whose values are prefixed with @ represent interrelated objects. See the appendix section on viewing interrelated objects for steps on how to view the details of these objects.