Show Menu
トピック×

クエリ

サンプル API 呼び出し

The following sections walk through calls you can make using the /queries endpoint in the Query Service API. 各呼び出しでは一般的な API 形式、必須ヘッダーを示すリクエスト例および応答例が示されています。

クエリのリストの取得

IMS 組織に対するすべてのクエリのリストを取得するには、 /queries エンドポイントへの GET リクエストをおこないます。
API 形式
GET /queries
GET /queries?{QUERY_PARAMETERS}

  • {QUERY_PARAMETERS} :( オプション )応答に返される結果を設定するリクエストパスに追加されるパラメーター。複数のパラメーターを含め、アンパサンド( & )で区切ることができます。使用できるパラメーターは以下のとおりです。
クエリパラメータ
次に、クエリの一覧表示に使用可能なクエリパラメーターのリストを示します。これらのパラメーターはすべてオプションです。パラメーターを指定せずにこのエンドポイントを呼び出すと、組織で使用可能なすべてのクエリが取得されます。
パラメーター
説明
orderby
結果の並べ替えに使用するフィールドを指定します。サポートされているフィールドは created updated です。例えば、 orderby=created は、昇順で結果を並べ替えます。作成前に - を追加する( orderby=-created )と、項目が作成日の降順で並べ替えられます。
limit
ページサイズの制限を指定して、ページに含める結果の数を制御します。( デフォルト値:20
start
ゼロベースのナンバリングを使用して、応答リストをオフセットします。例えば、 start=2 は、3 番目のクエリから開始するリストを返します。( デフォルト値:0
property
フィールドに基づいて結果をフィルタリングします。フィルターは HTML エスケープする​ 必要があります 。複数のフィルターのセットを組み合わせるには、コンマを使用します。サポートされているフィルターは created updated state 、および id です。サポートされる演算子のリストは、 > (次より大きい)、 < (次より小さい)、 >= (次よりも大きいか等しい)、 <= (次よりも小さいか等しい)、 == (等しい)、 != (次と等しくない)、 ~ (次を含む)です。例えば、 id==6ebd9c2d-494d-425a-aa91-24033f3abeec は指定した ID を持つすべてのクエリを返します。
excludeSoftDeleted
ソフト削除されたクエリを含める必要があるかどうかを示します。例えば、 excludeSoftDeleted=false はソフト削除クエリを​ 含みます 。( ブール値、デフォルト値:true
excludeHidden
ユーザー主導でないクエリを表示するかどうかを示します。この値を false に設定すると、CURSOR 定義、FETCH、メタデータクエリなど、ユーザ主導でないクエリが​ 含まれます 。( ブール値、デフォルト値:true
リクエスト
次のリクエストで、IMS 組織用に作成された最新のクエリを取得します。
curl -X GET https://platform.adobe.io/data/foundation/query/queries?limit=1 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

応答
成功応答は、HTTP ステータス 200 とともに、JSON として指定した IMS 組織のクエリのリストを返します。次の応答は、IMS 組織用に作成された最新のクエリを返します。
{
    "queries": [
        {
            "isInsertInto": false,
            "request": {
                "dbName": "prod:all",
                "sql": "SELECT *\nFROM\n  accounts\nLIMIT 10\n"
            },
            "state": "SUCCESS",
            "rowCount": 0,
            "errors": [],
            "isCTAS": false,
            "version": 1,
            "id": "9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
            "elapsedTime": 28,
            "updated": "2019-12-06T22:00:17.390Z",
            "client": "Adobe Query Service UI",
            "userId": "{USER_ID}",
            "created": "2019-12-06T22:00:17.362Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/queries/9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
                    "method": "GET"
                },
                "soft_delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/queries/9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
                    "method": "PATCH",
                    "body": "{ \"op\": \"soft_delete\"}"
                },
                "referenced_datasets": [
                    {
                        "id": "5b2bdd32230d4401de87397c",
                        "href": "https://platform.adobe.io/data/foundation/catalog/dataSets/5b2bdd32230d4401de87397c"
                    }
                ]
            }
        }
    ],
    "_page": {
        "orderby": "-created",
        "start": "2019-12-06T22:00:17.362Z",
        "next": "2019-08-01T00:14:21.748Z",
        "count": 1
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io/data/foundation/query/queries?orderby=-created&start=2019-08-01T00:14:21.748Z"
        },
        "prev": {
            "href": "https://platform.adobe.io/data/foundation/query/queries?orderby=-created&start=2019-12-06T22:00:17.362Z&isPrevLink=true"
        }
    },
    "version": 1
}

クエリの作成

/queries エンドポイントに POST リクエストをおこなうことで、新しいクエリを作成できます。
API 形式
POST /queries

リクエスト
次のリクエストは、ペイロードで指定された値によって設定された新しいクエリを作成します。
curl -X POST https://platform.adobe.io/data/foundation/query/queries \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '{
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Query"
        "description": "Sample Description"
    }  

プロパティ
説明
dbName
SQL データベースを作成する対象のクエリの名前。
sql
作成する SQL クエリ。
name
SQL クエリの名前。
description
SQL クエリの説明。
応答
成功応答は HTTP ステータス(許可済み)とともに、作成したクエリの詳細を返します。クエリのアクティブ化が完了し、正常に実行されたら、 state SUBMITTED から SUCCESS に変更されます。
{
    "isInsertInto": false,
    "request": {
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Query",
        "description": "Sample Description"
    },
    "state": "SUBMITTED",
    "rowCount": 0,
    "errors": [],
    "isCTAS": false,
    "version": 1,
    "id": "4d64cd49-cf8f-463a-a182-54bccb9954fc",
    "elapsedTime": 0,
    "updated": "2020-01-08T21:47:46.865Z",
    "client": "API",
    "userId": "{USER_ID}",
    "created": "2020-01-08T21:47:46.865Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "GET"
        },
        "soft_delete": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"soft_delete\"}"
        },
        "cancel": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"cancel\"}"
        }
    }
}

_links.cancel の値を使用して、 作成したクエリをキャンセル できます。

ID によるクエリの取得

特定のクエリに関する詳細な情報を取得するには、 /queries エンドポイントに GET リクエストを送信し、リクエストパスにクエリの id の値を指定します。
API 形式
GET /queries/{QUERY_ID}

プロパティ
説明
{QUERY_ID}
取得するクエリの id 値。
リクエスト
curl -X GET https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

応答
成功応答は、HTTP ステータス 200 とともに、指定された応答に関する詳細な情報を返します。
{
    "isInsertInto": false,
    "request": {
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Query",
        "description": "Sample Description"
    },
    "state": "SUBMITTED",
    "rowCount": 0,
    "errors": [],
    "isCTAS": false,
    "version": 1,
    "id": "4d64cd49-cf8f-463a-a182-54bccb9954fc",
    "elapsedTime": 0,
    "updated": "2020-01-08T21:47:46.865Z",
    "client": "API",
    "userId": "{USER_ID}",
    "created": "2020-01-08T21:47:46.865Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "GET"
        },
        "soft_delete": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"soft_delete\"}"
        },
        "cancel": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"cancel\"}"
        }
    }
}

_links.cancel の値を使用して、 作成したクエリをキャンセル できます。

クエリのキャンセル

/queries エンドポイントに PATCH リクエストを送信し、リクエストパスでクエリの id 値を指定することで、指定したクエリを削除するようリクエストできます。
API 形式
PATCH /queries/{QUERY_ID}

プロパティ
説明
{QUERY_ID}
キャンセルするクエリの id 値。
リクエスト
この API リクエストは、ペイロードに JSON パッチ構文を使用します。JSON パッチの仕組みについて詳しくは、API の基本ドキュメントを参照してください。
curl -X PATCH https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json',
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
   "op": "cancel"  
 }'

プロパティ
説明
op
クエリをキャンセルするには、op パラメーターに値 cancel を設定する必要があります。
応答
成功応答は、HTTP ステータス 202(許可済み)とともに次のメッセージを返します。
{
    "message": "Query cancel request received",
    "statusCode": 202
}