설명서Experience PlatformCatalog and Datasets 안내서

카탈로그 개체 나열

Last update: Wed Dec 06 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

작성 대상:

  • Developer

단일 API 호출을 통해 특정 유형의 사용 가능한 모든 오브젝트 목록을 검색할 수 있습니다. 가장 좋은 방법은 응답 크기를 제한하는 필터를 포함하는 것입니다.

API 형식

GET /{OBJECT_TYPE}
GET /{OBJECT_TYPE}?{FILTER}={VALUE}&{FILTER_2}={VALUE}
매개변수
설명
{OBJECT_TYPE}

유형 Catalog 나열할 개체입니다. 유효한 오브젝트는 다음과 같습니다.

  • batches
  • dataSets
  • dataSetFiles
{FILTER}
응답에서 반환된 결과를 필터링하는 데 사용되는 쿼리 매개 변수입니다. 여러 매개 변수는 앰퍼샌드(&). 다음 안내서를 참조하십시오 카탈로그 데이터 필터링 추가 정보.

요청

아래 샘플 요청은 데이터 세트 목록을 검색합니다. limit 응답을 5개의 결과로 줄인 필터 및 properties 각 데이터 세트에 표시되는 속성을 제한하는 필터.

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets?limit=5&properties=name,description,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}'

응답

성공적인 응답은 다음 목록을 반환합니다. Catalog 요청에 제공된 쿼리 매개 변수로 필터링된 키-값 쌍 형식의 개체입니다. 각 키-값 쌍에 대해 키는 의 고유 식별자를 나타냅니다 Catalog 해당 개체. 그런 다음 다른 호출에서 사용할 수 있습니다. 특정 개체 보기 을 참조하십시오.

NOTE
반환된 오브젝트에 로 표시된 요청된 속성이 하나 이상 포함되어 있지 않은 경우 properties 쿼리하면 다음과 같이 포함된 요청된 속성만 응답됩니다. Sample Dataset 3 및 Sample Dataset 4 아래요.
{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset 1",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5ba9452f7de80400007fc52a"
    },
    "5bb276b03a14440000971552": {
        "name": "Sample Dataset 2",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5bb276b03a14440000971552"
    },
    "5bceaa4c26c115000039b24b": {
        "name": "Sample Dataset 3"
    },
    "5bda3a4228babc0000126377": {
        "name": "Sample Dataset 4",
        "files": "@/dataSetFiles?dataSetId=5bda3a4228babc0000126377"
    },
    "5bde21511dd27b0000d24e95": {
        "name": "Sample Dataset 5",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5bde21511dd27b0000d24e95"
    }
}
recommendation-more-help
c5c02be6-79a3-4a2f-b766-136bffe8b676