この API を呼び出して、組織部門のリストをクエリします。
サポートされているエディション | Enterprise Dedicated Edition |
サービスエンドポイント
サービスエンドポイントを取得し、API リクエスト構文の {domain}
を エンドポイント に置き換えます。
認証情報
製品 | リソース | 必要な権限 |
組織管理 | 組織部門 | 読み取り専用 |
リクエスト構文
GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/departments
リクエストの説明 | 組織部門リストのクエリ
特定の部門下のすべてのサブ部門のクエリ
|
リクエストヘッダー (Headers) | |
アクセストークン。 詳細については、アクセストークン をご参照ください。 例: pt-0fh3****0fbG_35af****0484. | |
リクエストパラメーター | |
organizationId 組織 ID。 組織管理コンソールの [システム管理] ページに移動して、組織 ID (organizationId) を取得できます。 | |
parentId 親部門 ID。 | |
page 現在のページ。 | |
perPage 1 ページあたりのエントリ数。 有効な値: |
レスポンスパラメーター | サンプル レスポンス
|
creatorId 作成者 ID。 | |
hasSub 部門にサブ部門があるかどうかを示します。 | |
id 部門 ID。 | |
name 部門名。 | |
organizationId 組織 ID。 | |
parentId 親部門 ID。 |
レスポンスヘッダー
パラメーター | 説明 | サンプル値 |
x-next-page | 次のページ。 | 1 |
x-page | 現在のページ。 | 2 |
x-per-page | 1 ページあたりのエントリ数。 | 1 |
x-prev-page | 前のページ。 | 2 |
x-total | エントリの総数。 | 1 |
x-total-pages | ページの総数。 | 10 |
エラーコード
詳細については、「エラーコード」をご参照ください。