スキーマリストの照会
- 印刷する
- PDF
スキーマリストの照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
作成されたスキーマの全リストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /schemas |
リクエストヘッダ
AiTEMS APIで共通して使用されるヘッダの詳細は、AiTEMSの共通ヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
datasetType | String | Optional | データセットタイプ
|
offset | Integer | Optional | 照会データのスタート位置
|
limit | Integer | Optional | 照会データの最大数
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/schemas' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
schemas | Array | - | スキーマ情報 |
offset | Integer | - | 照会データのスタート位置 |
limit | Integer | - | 照会データの最大数 |
schemas
schemas
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
datasetType | String | - | データセットタイプ
|
name | String | - | スキーマ名 |
createdDate | String | - | スキーマの作成日時 |
actionName | String | - | 照会した項目に対する Sub Account権限 |
permission | String | - | Sub Account権限を許可するかどうか |
レスポンスステータスコード
AiTEMS APIで共通して使用されるレスポンスステータスコードの詳細は、AiTEMS APIの共通レスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"schemas": [
{
"datasetType": "interaction",
"name": "interaction_schema",
"createdDate": "2024-07-30T09:08:09.221",
"actionName": "View/getSchemaDetail",
"permission": "Allow"
},
{
"datasetType": "user",
"name": "user_schema",
"createdDate": "2024-07-30T08:57:37.393",
"actionName": "View/getSchemaDetail",
"permission": "Allow"
},
{
"datasetType": "item",
"name": "item_schema",
"createdDate": "2024-07-30T08:56:29.040",
"actionName": "View/getSchemaDetail",
"permission": "Allow"
}
],
"offset": 0,
"limit": 1000
}
この記事は役に立ちましたか?