グラフ・サーバーのREST APIバージョン2

19.1.1 認証トークンの取得

POST https://localhost:7007/auth/token

REST APIリクエストの認証に使用できる認証トークンを取得します。

リクエスト

リクエスト・ヘッダー

Accept: application/json; charset=UTF-8
Content-Type: application/json

表19-1 リクエスト本文のパラメータ

パラメータ	型	説明	必須
`username`	string	ユーザー名	はい
`password`	string	ユーザーのパスワード	はい
`createSession`	boolean	セッションを作成する必要があるかどうかを確認する	オプション。グラフ・サーバー(PGX)に対して問合せを実行する場合は、`true`に設定します。
`source`	string	クライアントを識別する説明文字列	オプション。スペースなしでソース値を入力します(たとえば、"commandLine"、"shellWithJava"など)。
`sessionId`	string	グラフ・サーバーへの接続時に既存のセッションを再利用します	オプション。セッションを再利用する場合は、既存のセッション`ID`に設定します。

サンプル・リクエスト本文

{
    "username": "graphuser",
    "password": "<password_for_graphuser>",
    "createSession": true,
    "source": "<source-value-for-pgx-session>",
    "sessionId": "<session-id>"
}

レスポンス

201 Created
Content-Type: application/json

サンプル・レスポンス本文

{
    "access_token": "<token>"
    "token_type": "bearer",
    "expires_in": 3600
}

cURLの例

curl --location 'https://localhost:7007/auth/token' \
--header 'Content-Type: application/json' \
--data '{ 
    "username": "graphuser",
    "password": "<password_for_graphuser>",
    "createSession": true,
    "source": "commandLine",
    "sessionId": "<session-id>"
}'

親トピック: グラフ・サーバーのREST APIバージョン2

19.1.2 認証トークンのリフレッシュ

PUT https://localhost:7007/auth/token

有効なアクセス・トークンをリフレッシュします。

リクエスト

リクエスト・ヘッダー

Accept: application/json; charset=UTF-8
Content-Type: application/json

表19-2 リクエスト本文のパラメータ

パラメータ	型	説明	必須
`token`	string	アクセス・トークン値	はい
`createSession`	boolean	セッションを作成する必要があるかどうかを決定するフラグ	オプション。グラフ・サーバー(PGX)に対して問合せを実行する場合は、`true`に設定します。
`sessionId`	string	グラフ・サーバーへの接続時に既存のセッションを再利用します	オプション。セッションを再利用する場合は、既存のセッション`ID`に設定します。

サンプル・リクエスト本文

{
    "token": "<token>",
    "createSession": true,
    "sessionId": "<session-id>"
}

レスポンス

201 Created
Content-Type: application/json

サンプル・レスポンス本文

{
    "access_token": "<token>"
    "token_type": "bearer",
    "expires_in": 3600
}

cURLの例

curl --location --request PUT 'https://localhost:7007/auth/token' \
--header 'Content-Type: application/json' \
--data '{
    "token": "<token_value>",
    "createSession": true,
    "sessionId": "<session-id>"
}'

親トピック: グラフ・サーバーのREST APIバージョン2

19.1.3 グラフの取得

GET https://localhost:7007/v2/graphs

指定されたドライバのグラフのリストを取得します。

バージョン: v2

リクエスト

リクエスト・ヘッダー

Accept: application/json; charset=UTF-8
Header: Authorization: Bearer <token>
Content-Type: application/json

リクエスト問合せのパラメータ

driver (必須): PGQLドライバ値を指定します。これは必須パラメータです。サポートされる値は次のとおりです。
- GRAPH_SERVER_PGX: グラフ・サーバー(PGX)にロードされるグラフ
- PGQL_IN_DATABASE: データベース内のPGQLプロパティ・グラフ
- SQL_IN_DATABASE: データベース内のSQLプロパティ・グラフ

レスポンス

200 OK
Content-Type: application/json

サンプル・レスポンス本文

[
    {
        "schema": <value>,
        "graphName": <value>
    }
]

schemaパラメータは、グラフ・サーバー(PGX)で作成されたグラフの場合、NULLになることに注意してください。

cURLの例

curl --location --request GET 'https://localhost:7007/v2/graphs?driver=<driver-value>' \
--header 'Authorization: Bearer <token>'

親トピック: グラフ・サーバーのREST APIバージョン2

19.1.4 PGQL問合せの実行

POST https://localhost:7007/v2/runQuery

指定したドライバに対して1つ以上の文を実行します。

バージョン: v2

リクエスト

リクエスト・ヘッダー

Accept: application/json; charset=UTF-8
Header: Authorization: Bearer <token>
Content-Type: application/json

表19-3 リクエスト本文のパラメータ

パラメータ	型	説明	必須
`statements`	string [ ]	1つ以上の文	はい
`driver`	string	PGQLドライバを指定します。サポートされる値は次のとおりです。 `GRAPH_SERVER_PGX`: グラフ・サーバー(PGX)に対してPGQL問合せを実行する `PGQL_IN_DATABASE`: データベースに対してPGQL文または問合せを実行する `SQL_IN_DATABASE`: データベースに対してグラフ問合せを実行する	はい
`formatter`	string	サポートされる値は次のとおりです。 DATASTUDIO GVT	はい
`parameters`	object `dynamicSampling:` integer `parallel:` integer `start:` integer `size:` integer	パラメータは次のとおりです: 動的サンプリング値並列度問合せ結果のフェッチ・サイズ(=行数)	パラメータはすべてオプションです。動的サンプリングのデフォルト値は2です。パラレル化のデフォルト値は、`driver`によって異なります。 startのデフォルト値は`0`です。 sizeのデフォルト値は`100`です。
`visualize`	boolean	ビジュアライゼーションを設定するフラグ	オプション。デフォルト値は`true`

サンプル・リクエスト本文

{
  "statements": [
    "DROP PROPERTY GRAPH TEST_GRAPH",
    "CREATE PROPERTY GRAPH TEST_GRAPH VERTEX TABLES( Male KEY (id) LABEL Male PROPERTIES ARE ALL COLUMNS EXCEPT (gender), Female KEY (id) LABEL Female PROPERTIES ARE ALL COLUMNS EXCEPT (gender) ) EDGE TABLES( knowsmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), knowsfm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), friendOfmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength), friendOffm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength) ) OPTIONS ( pg_pgql )", 
    "SELECT v FROM MATCH (v) ON TEST_GRAPH LIMIT 1"
  ],
  "driver": "PGQL_IN_DATABASE",
  "formatter": "GVT",
  "parameters": {
    "dynamicSampling": 2,
    "parallel": 8,
    "start": 0,
    "size": 100
  },
  "visualize": true

レスポンス

200 OK
Content-Type: application/json

サンプル・レスポンス本文

{
    "results": [
        {
            "pgqlStatement": "DROP PROPERTY GRAPH TEST_GRAPH",
            "result": "Graph successfully dropped",
            "success": true,
            "error": null,
            "started": 1689656429130,
            "ended": 1689656429198
        },
        {
            "pgqlStatement": "CREATE PROPERTY GRAPH TEST_GRAPH VERTEX TABLES( Male KEY (id) LABEL Male PROPERTIES ARE ALL COLUMNS EXCEPT (gender), Female KEY (id) LABEL Female PROPERTIES ARE ALL COLUMNS EXCEPT (gender) ) EDGE TABLES( knowsmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), knowsfm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), friendOfmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength), friendOffm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength) ) OPTIONS ( pg_pgql )",
            "result": "Graph successfully created",
            "success": true,
            "error": null,
            "started": 1689656429198,
            "ended": 1689656429458
        },
        {
            "pgqlStatement": "SELECT v FROM MATCH (v) ON TEST_GRAPH LIMIT 1",
            "result": "{\"schema\":\"GRAPHUSER\",\"name\":\"TEST_GRAPH\",\"resultSetId\":\"\",\"graph\":{\"vertices\":[{\"id\":\"MALE(0)\",\"properties\":{\"AGE\":\"40\",\"BVAL\":\"Y\",\"LNAME\":\"Brown\",\"FNAME\":\"Bill\",\"PREFERENCES\":\"{ \\\"color\\\": \\\"blue\\\", \\\"number\\\": \\\"5\\\" }\",\"ID\":\"0\",\"TEXT\":\"the cat sat on the mat\",\"MVAL\":\"y\"}}],\"edges\":[],\"numResults\":1},\"table\":\"V\\nMALE(0)\"}",
            "success": true,
            "error": null,
            "started": 1689656429458,
            "ended": 1689656430029
        }
    ]
}

cURLの例

curl --location --request POST 'https://localhost:7007/v2/runQuery' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
  "statements": [
    "DROP PROPERTY GRAPH TEST_GRAPH",
    "CREATE PROPERTY GRAPH TEST_GRAPH VERTEX TABLES( Male KEY (id) LABEL Male PROPERTIES ARE ALL COLUMNS EXCEPT (gender), Female KEY (id) LABEL Female PROPERTIES ARE ALL COLUMNS EXCEPT (gender) ) EDGE TABLES( knowsmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), knowsfm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), friendOfmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength), friendOffm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength) ) OPTIONS ( pg_pgql )",
    "SELECT v FROM MATCH (v) ON TEST_GRAPH LIMIT 1"
  ],
  "driver": "PGQL_IN_DATABASE",
  "formatter": "GVT",
  "parameters": {
    "dynamicSampling": 2,
    "parallel": 8,
    "start": 0,
    "size": 100  
  },
  "visualize": true
}'

親トピック: グラフ・サーバーのREST APIバージョン2

19.1.5 データベース・バージョンの取得

GET https://localhost:7007/v2/dbVersion

グラフ・サーバーが接続されているデータベース・バージョンを取得します。

バージョン: v2

リクエスト

リクエスト・ヘッダー

Accept: application/json; charset=UTF-8
Header: Authorization: Bearer <token>
Content-Type: application/json

レスポンス

200 OK
Content-Type: application/json

サンプル・レスポンス本文

{
    "dbVersion": "23.0"
}

cURLの例


curl --location --request GET 'https://localhost:7007/v2/dbVersion' \
--header 'Authorization: Bearer <token>'

親トピック: グラフ・サーバーのREST APIバージョン2

19.1.6 ユーザーの取得

GET https://localhost:7007/v2/user

グラフ・サーバーに現在接続されているユーザー名を取得します(ユーザー名はトークンに関連付けられています)。

バージョン: v2

リクエスト

リクエスト・ヘッダー

Accept: application/json; charset=UTF-8
Header: Authorization: Bearer <token>
Content-Type: application/json

レスポンス

200 OK
Content-Type: application/json

サンプル・レスポンス本文

{
    "username": "graphuser"
}

cURLの例

curl --location --request GET 'https://localhost:7007/v2/user' \
--header 'Authorization: Bearer <token>'

親トピック: グラフ・サーバーのREST APIバージョン2

19.1.7 非同期RESTエンドポイント

グラフ・サーバーのRESTエンドポイントは、問合せの取消しをサポートしています。

問合せを取り消すには、次の非同期RESTエンドポイントを使用して問合せを送信する必要があります。

親トピック: グラフ・サーバーのREST APIバージョン2

19.1.7.1 非同期PGQL問合せの実行

POST https://localhost:7007/v2/runQueryAsync

プロパティ・グラフでPGQL問合せを非同期で実行します。

バージョン: v2

リクエスト

リクエスト・ヘッダー

Accept: application/json; charset=UTF-8
Header: Authorization: Bearer <token>
Content-Type: application/json

リクエスト問合せのパラメータ: 詳細は、表19-3を参照してください。

サンプル・リクエスト本文

{
  "statements": [
    "DROP PROPERTY GRAPH TEST_GRAPH",
    "CREATE PROPERTY GRAPH TEST_GRAPH VERTEX TABLES( Male KEY (id) LABEL Male PROPERTIES ARE ALL COLUMNS EXCEPT (gender), Female KEY (id) LABEL Female PROPERTIES ARE ALL COLUMNS EXCEPT (gender) ) EDGE TABLES( knowsmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), knowsfm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), friendOfmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength), friendOffm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength) ) OPTIONS ( pg_pgql )", 
    "SELECT v FROM MATCH (v) ON TEST_GRAPH LIMIT 1"
  ],
  "driver": "PGQL_IN_DATABASE",
  "formatter": "GVT",
  "parameters": {
    "dynamicSampling": 2,
    "parallel": 8,
    "start": 0,
    "size": 100
  },
  "visualize": true

レスポンス

202 OK
Content-Type: application/json

サンプル・レスポンス本文

{
    "message": "Query execution started.",
    "result_id": 0
}

cURLの例

curl --location --request POST 'https://localhost:7007/v2/runQueryAsync' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
  "statements": [
    "DROP PROPERTY GRAPH TEST_GRAPH",
    "CREATE PROPERTY GRAPH TEST_GRAPH VERTEX TABLES( Male KEY (id) LABEL Male PROPERTIES ARE ALL COLUMNS EXCEPT (gender), Female KEY (id) LABEL Female PROPERTIES ARE ALL COLUMNS EXCEPT (gender) ) EDGE TABLES( knowsmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), knowsfm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), friendOfmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength), friendOffm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength) ) OPTIONS ( pg_pgql )",
    "SELECT v FROM MATCH (v) ON TEST_GRAPH LIMIT 1"
  ],
  "driver": "PGQL_IN_DATABASE",
  "formatter": "GVT",
  "parameters": {
    "dynamicSampling": 2,
    "parallel": 8,
    "start": 0,
    "size": 100  
  },
  "visualize": true
}'

親トピック: 非同期RESTエンドポイント

19.1.7.2 非同期問合せ完了の確認

GET https://localhost:7007/v2/isAsyncQueryExecutionComplete/<result_id>

非同期問合せの実行が完了しているかどうかを確認します。

バージョン: v2

リクエスト・ヘッダー

Accept: application/json; charset=UTF-8
Header: Authorization: Bearer <token>
Content-Type: application/json

リクエスト・パスのパラメータ:

result_id: PGQL問合せ実行結果ID。

レスポンス

200 OK
Content-Type: application/json

サンプル・レスポンス本文

true

cURLの例

curl --location --request GET 'https://localhost:7007/v2/isAsyncQueryExecutionComplete/<result-id>' \
--header 'Authorization: Bearer <token>'

親トピック: 非同期RESTエンドポイント

19.1.7.3 非同期問合せ結果の取得

GET https://localhost:7007/v2/runQueryAsync/<result_id>

非同期問合せの結果を取得します。

バージョン: v2

リクエスト

リクエスト・ヘッダー

Accept: application/json; charset=UTF-8
Header: Authorization: Bearer <token>
Content-Type: application/json

リクエスト・パスのパラメータ:

result_id: PGQL問合せ実行結果ID。

レスポンス

200 OK
Content-Type: application/json

サンプル・レスポンス本文

{
    "results": [
        {
            "pgqlStatement": "DROP PROPERTY GRAPH TEST_GRAPH",
            "result": "Graph successfully dropped",
            "success": true,
            "error": null,
            "started": 1689656429130,
            "ended": 1689656429198
        },
        {
            "pgqlStatement": "CREATE PROPERTY GRAPH TEST_GRAPH VERTEX TABLES( Male KEY (id) LABEL Male PROPERTIES ARE ALL COLUMNS EXCEPT (gender), Female KEY (id) LABEL Female PROPERTIES ARE ALL COLUMNS EXCEPT (gender) ) EDGE TABLES( knowsmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), knowsfm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL knows PROPERTIES (mval, firstMetAt, since), knowsff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL knows PROPERTIES (mval, firstMetAt, since), friendOfmm KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfmf KEY (id) SOURCE KEY (sid) REFERENCES Male DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength), friendOffm KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Male LABEL friendOf PROPERTIES (strength), friendOfff KEY (id) SOURCE KEY (sid) REFERENCES Female DESTINATION KEY (did) REFERENCES Female LABEL friendOf PROPERTIES (strength) ) OPTIONS ( pg_pgql )",
            "result": "Graph successfully created",
            "success": true,
            "error": null,
            "started": 1689656429198,
            "ended": 1689656429458
        },
        {
            "pgqlStatement": "SELECT v FROM MATCH (v) ON TEST_GRAPH LIMIT 1",
            "result": "{\"schema\":\"GRAPHUSER\",\"name\":\"TEST_GRAPH\",\"resultSetId\":\"\",\"graph\":{\"vertices\":[{\"id\":\"MALE(0)\",\"properties\":{\"AGE\":\"40\",\"BVAL\":\"Y\",\"LNAME\":\"Brown\",\"FNAME\":\"Bill\",\"PREFERENCES\":\"{ \\\"color\\\": \\\"blue\\\", \\\"number\\\": \\\"5\\\" }\",\"ID\":\"0\",\"TEXT\":\"the cat sat on the mat\",\"MVAL\":\"y\"}}],\"edges\":[],\"numResults\":1},\"table\":\"V\\nMALE(0)\"}",
            "success": true,
            "error": null,
            "started": 1689656429458,
            "ended": 1689656430029
        }
    ]
}

cURLの例

curl --location --request GET 'https://localhost:7007/v2/runQueryAsync/<result-id>' \
--header 'Authorization: Bearer <token>'

親トピック: 非同期RESTエンドポイント

19.1.7.4 非同期問合せ実行の取消し

DELETE https://localhost:7007/v2/runQueryAsync/<result_id>

非同期問合せの実行を取り消します。

バージョン: v2

リクエスト

リクエスト・ヘッダー

Accept: application/json; charset=UTF-8
Header: Authorization: Bearer <token>
Content-Type: application/json

リクエスト・パスのパラメータ:

result_id: PGQL問合せ実行結果id。

レスポンス

200 Accepted
Content-Type: application/json

cURLの例

curl --location --request DELETE 'https://localhost:7007/v2/runQueryAsync/<result-id>' /
--header 'Authorization: Bearer <token>'

親トピック: 非同期RESTエンドポイント