クエリエンドポイント
サンプル API 呼び出し
以降の節では、 /queries
エンドポイント Query Service API. 各呼び出しでは一般的な API 形式、必須ヘッダーを示すリクエスト例および応答例が示されています。
クエリのリストの取得
組織に対するすべてのクエリのリストを取得するには、 /queries
endpoint.
API 形式
GET /queries
GET /queries?{QUERY_PARAMETERS}
{QUERY_PARAMETERS}
:(オプション)応答に返される結果を設定するリクエストパスに追加されるパラメーター。複数のパラメーターを含め、アンパサンド(&
)で区切ることができます。使用できるパラメーターは以下のとおりです。
クエリパラメータ
次に、クエリの一覧表示に使用可能なクエリパラメーターのリストを示します。これらのパラメーターはすべてオプションです。パラメーターを指定せずにこのエンドポイントを呼び出すと、組織で使用可能なすべてのクエリが取得されます。
orderby
created
と updated
です。例えば、orderby=created
は、昇順で結果を並べ替えます。作成前に -
を追加する(orderby=-created
)と、項目が作成日の降順で並べ替えられます。limit
start
ISO タイムスタンプは、日時の様々な精度レベルを許可します。 基本的な ISO タイムスタンプの形式は次のとおりです。
2020-09-07
日付を表すには、2020 年 9 月 7 日。 より複雑な例は次のように記述されます。 2022-11-05T08:15:30-05:00
2022 年 11 月 5 日 (PT)、8 日 (PT) に相当:15:午前 30 時、米国東部標準時。 タイムゾーンは UTC オフセットで指定でき、サフィックス「Z」(2020-01-01T01:01:01Z
) をクリックします。 タイムゾーンを指定しない場合、デフォルトは 0 に設定されます。property
created
、updated
、state
、および id
です。サポートされる演算子のリストは、>
(次より大きい)、<
(次より小さい)、>=
(次よりも大きいか等しい)、<=
(次よりも小さいか等しい)、==
(等しい)、!=
(次と等しくない)、~
(次を含む)です。例えば、id==6ebd9c2d-494d-425a-aa91-24033f3abeec
は指定した ID を持つすべてのクエリを返します。excludeSoftDeleted
excludeSoftDeleted=false
はソフト削除クエリを 含みます。(ブール値、デフォルト値:true)excludeHidden
isPrevLink
isPrevLink
ページネーションにはクエリパラメーターが使用されます。 API 呼び出しの結果は、 created
タイムスタンプと orderby
プロパティ。 結果のページを移動する場合、 isPrevLink
が true に設定されている場合、逆方向にページングします。 クエリの順序を逆にします。 例として、「次へ」および「前へ」リンクを参照してください。リクエスト
次のリクエストは、組織用に作成された最新のクエリを取得します。
curl -X GET https://platform.adobe.io/data/foundation/query/queries?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}'
応答
正常な応答は、HTTP ステータス 200 と、指定された組織のクエリのリストを JSON として返します。 次の応答は、組織用に作成された最新のクエリを返します。
{
"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
リクエスト
次のリクエストは、ペイロードで指定された SQL ステートメントを使用して、新しいクエリを作成します。
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: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"dbName": "prod:all",
"sql": "SELECT account_balance FROM user_data WHERE user_id='$user_id';",
"queryParameters": {
user_id : {USER_ID}
}
"name": "Sample Query",
"description": "Sample Description"
}
次のリクエストの例では、既存のクエリテンプレート ID を使用して新しいクエリを作成します。
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: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"dbName": "prod:all",
"templateID": "f7cb5155-29da-4b95-8131-8c5deadfbe7f",
"name": "Sample Query",
"description": "Sample Description"
}
dbName
sql
name
description
queryParameters
templateId
insertIntoParameters
ctasParameters
応答
成功応答は 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: {ORG_ID}' \
-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
から 作成したクエリをキャンセル.クエリのキャンセルまたはソフト削除
に対してPATCHリクエストを実行することで、指定したクエリのキャンセルまたはソフト削除をリクエストできます。 /queries
エンドポイントを作成し、クエリの 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: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '{
"op": "cancel"
}'
op
cancel
および soft_delete
です。クエリをキャンセルするには、op パラメーターに値を設定する必要があります cancel
. ソフト削除操作では、GETリクエストでクエリが返されるのを停止しますが、システムからは削除されません。応答
成功応答は、HTTP ステータス 202(許可済み)とともに次のメッセージを返します。
{
"message": "Query cancel request received",
"statusCode": 202
}