쿼리 템플릿 끝점

샘플 API 호출

다음 섹션에서는 Query Service API. 각 호출에는 일반 API 형식, 필수 헤더를 보여주는 샘플 요청 및 샘플 응답이 포함되어 있습니다.

자세한 내용은 UI 쿼리 템플릿 설명서 Experience Platform UI를 통한 템플릿 만들기에 대한 정보입니다.

쿼리 템플릿 목록 검색

IMS 조직에 대해 GET 요청을 수행하여 모든 쿼리 템플릿 목록을 검색할 수 있습니다 /query-templates 엔드포인트.

API 형식

GET /query-templates
GET /query-templates?{QUERY_PARAMETERS}
속성 설명
{QUERY_PARAMETERS} (선택 사항입니다) 응답에서 반환된 결과를 구성하는 요청 경로에 매개 변수가 추가되었습니다. 여러 매개 변수를 앰퍼샌드( )로 구분하여 포함할 수 있습니다&). 사용 가능한 매개 변수는 아래에 나와 있습니다.

쿼리 매개 변수

다음은 쿼리 템플릿을 나열하기 위해 사용할 수 있는 쿼리 매개 변수 목록입니다. 이러한 매개 변수는 모두 선택 사항입니다. 매개 변수 없이 이 종단점을 호출하면 조직에서 사용할 수 있는 모든 쿼리 템플릿을 검색합니다.

매개 변수 설명
orderby 결과를 정렬할 필드를 지정합니다. 지원되는 필드는 다음과 같습니다 created 및 updated. 예, orderby=created 은(는) 결과를 오름차순으로 정렬하게 됩니다. 추가 - 생성 전(orderby=-created)은 내림차순으로 만든 항목을 정렬합니다.
limit 페이지에 포함된 결과 수를 제어할 페이지 크기 제한을 지정합니다. (기본값: 20년)
start 영(0) 기반 번호 지정을 사용하여 응답 목록을 오프셋합니다. 예, start=2 세 번째 나열된 쿼리에서 시작하는 목록을 반환합니다. (기본값: 0)
property 필드를 기반으로 결과를 필터링합니다. 필터 반드시 HTML 이스케이프 처리됨. 쉼표는 여러 필터 세트를 결합하는 데 사용됩니다. 지원되는 필드는 다음과 같습니다 name 및 userId. 지원되는 연산자는 == (같음). 예, name==my_template 은 이름이 있는 모든 쿼리 템플릿을 반환합니다 my_template.

요청

다음 요청은 IMS 조직에 대해 만들어진 최신 쿼리 템플릿을 검색합니다.

curl -X GET https://platform.adobe.io/data/foundation/query/query-templates?limit=1
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

성공적인 응답은 지정된 IMS 조직에 대한 쿼리 템플릿 목록과 함께 HTTP 상태 200을 반환합니다. 다음 응답은 IMS 조직에 대해 만든 최신 쿼리 템플릿을 반환합니다.

{
    "templates": [
        {
            "sql": "SELECT *\nFROM\n  accounts\nLIMIT 10\n",
            "name": "Test",
            "id": "f7cb5155-29da-4b95-8131-8c5deadfbe7f",
            "updated": "2019-11-21T21:50:01.469Z",
            "userId": "{USER_ID}",
            "created": "2019-11-21T21:50:01.469Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "GET"
                },
                "delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "DELETE"
                },
                "update": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "PUT",
                    "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
                }
            }
        }
    ],
    "_page": {
        "orderby": "-created",
        "start": "2019-11-21T21:50:01.469Z",
        "next": "2019-11-21T21:50:01.469Z",
        "count": 1
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates?orderby=-created&start=2019-11-21T21:50:01.469Z"
        },
        "prev": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates?orderby=-created&start=2019-11-21T21:50:01.469Z&isPrevLink=true"
        }
    },
    "version": 1
}
노트

다음 값을 사용할 수 있습니다. _links.delete to 쿼리 템플릿 삭제.

쿼리 템플릿 만들기

에 POST 요청을 작성하여 쿼리 템플릿을 만들 수 있습니다 /query-templates 엔드포인트.

API 형식

POST /query-templates

요청

curl -X POST https://platform.adobe.io/data/foundation/query/query-templates
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
        "sql": "SELECT * FROM accounts;",
        "name": "Sample query template"
    }'
속성 설명
sql 만들 SQL 쿼리
name 쿼리 템플릿의 이름입니다.

응답

성공적인 응답은 새로 만든 쿼리 템플릿의 세부 정보와 함께 HTTP 상태 202(허용됨)를 반환합니다.

{
    "sql": "SELECT * FROM accounts;",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:20:09.670Z",
    "userId": "{USER_ID}",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
        }
    }
}
노트

다음 값을 사용할 수 있습니다. _links.delete to 쿼리 템플릿 삭제.

지정한 쿼리 템플릿 검색

에 GET 요청을 수행하여 특정 쿼리 템플릿을 검색할 수 있습니다 /query-templates/{TEMPLATE_ID} 요청 경로에 쿼리 템플릿의 ID를 제공하고 끝점입니다.

API 형식

GET /query-templates/{TEMPLATE_ID}
속성 설명
{TEMPLATE_ID} 다음 id 검색할 쿼리 템플릿의 값입니다.

요청

curl -X GET https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

성공적인 응답은 지정된 쿼리 템플릿의 세부 정보와 함께 HTTP 상태 200을 반환합니다.

{
    "sql": "SELECT * FROM accounts;",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:20:09.670Z",
    "userId": "A5A562D15E1645480A495CE1@techacct.adobe.com",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
        }
    }
}
노트

다음 값을 사용할 수 있습니다. _links.delete to 쿼리 템플릿 삭제.

지정한 쿼리 템플릿 업데이트

에 PUT 요청을 작성하여 특정 쿼리 템플릿을 업데이트할 수 있습니다 /query-templates/{TEMPLATE_ID} 요청 경로에 쿼리 템플릿의 ID를 제공하고 끝점입니다.

API 형식

PUT /query-templates/{TEMPLATE_ID}
속성 설명
{TEMPLATE_ID} 다음 id 검색할 쿼리 템플릿의 값입니다.

요청

노트

PUT 요청을 사용하려면 SQL과 이름 필드를 모두 채워야 하며 덮어쓰기 해당 쿼리 템플릿의 현재 콘텐츠입니다.

curl -X PUT https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
    "sql": "SELECT * FROM accounts LIMIT 20;",
    "name": "Sample query template"
 }'
속성 설명
sql 업데이트할 SQL 쿼리입니다.
name 예약된 쿼리의 이름입니다.

응답

성공적인 응답은 지정된 쿼리 템플릿에 대한 업데이트된 정보와 함께 HTTP 상태 202(허용됨)를 반환합니다.

{
    "sql": "SELECT * FROM accounts LIMIT 20;",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:29:20.028Z",
    "lastUpdatedBy": "{USER_ID}",
    "userId": "{USER_ID}",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
        }
    }
}
노트

다음 값을 사용할 수 있습니다. _links.delete to 쿼리 템플릿 삭제.

지정한 쿼리 템플릿 삭제

에 DELETE 요청을 작성하여 특정 쿼리 템플릿을 삭제할 수 있습니다 /query-templates/{TEMPLATE_ID} 요청 경로에 쿼리 템플릿의 ID를 제공합니다.

API 형식

DELETE /query-templates/{TEMPLATE_ID}
속성 설명
{TEMPLATE_ID} 다음 id 검색할 쿼리 템플릿의 값입니다.

요청

curl -X DELETE https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

성공적인 응답은 다음 메시지와 함께 HTTP 상태 202(허용됨)를 반환합니다.

{
    "message": "Deleted",
    "statusCode": 202
}

이 페이지에서는