Group リスト照会
- 印刷する
- PDF
Group リスト照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Groupリストを照会します。
リクエスト
- GET /groups
リクエストパラメータ
| パラメータ | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| searchColumn | N | String | groupName, groupNrn, groupId | - 検索カラム groupName, groupNrn, groupId |
| searchWord | N | String | 検索キーワード | |
| page | N | int | - ページ番号 デフォルト値: 0 | |
| size | N | int | - 結果リストのサイズ デフォルト値: 20 |
レスポンス
レスポンスボディ
{
"page" : "integer",
"totalPages" : "integer",
"totalItems" : "integer",
"hasPrevious" : "boolean",
"hasNext" : "boolean",
"items" : [ {
"groupId":"String",
"groupName":"String",
"nrn":"String",
"createdAt":"String",
"updatedAt":"String",
"description":"String"
}
],
"isFirst" : "boolean",
"isLast" : "boolean"
}
| パラメータ | タイプ | 説明 | 制約事項 |
|---|---|---|---|
| page | Number | page(required) 返された結果の page | |
| totalPages | Number | totalPages(required) 返された結果の totalPage | |
| totalItems | Number | totalItems(required) 返された結果の totalItems | |
| hasPrevious | Boolean | hasPrevious(required) 現在のページ基準で前のページの存在有無 | |
| hasNext | Boolean | hasNext(required) 現在のページ基準で次のページの存在有無 | |
| isFirst | Boolean | isFirst(required) 全ページ基準で現在のページのトップページ有無 | |
| isLast | Boolean | isLast(required) 全ページ基準で現在のページの最終ページ有無 | |
| items.[].groupId | String | グループ ID(UUID) | |
| items.[].groupName | String | グループ名 | |
| items.[].nrn | String | グループ nrn | |
| items.[].description | String | グループの説明 | |
| items.[].createdAt | String | 作成日時(UTC、ex. 2023-04-25T13:11:50Z) | |
| items.[].updatedAt | String | 修正日時(UTC、ex. 2023-04-25T13:11:50Z) |
エラー
以下のエラーコードは、このアクション(Action)で発生する特徴的なエラーです。エラーレスポンス形式は ErrorResponseをご参照ください。
よく発生するエラーについての詳細は、NAVER Cloud Platform APIをご参照ください。
| HTTP status code | エラーコード | エラーメッセージ |
|---|---|---|
| 400 | 不正なリクエスト |
この記事は役に立ちましたか?