プロジェクトに関連付くサービスと役割の照会
リクエスト
エンドポイント
実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。
| HTTPメソッド | APIパス | 用途 | マスタ管理プラスオプション必須 |
|---|---|---|---|
| GET | /api/v22.10/projectAuthorities | 利用可能なプロジェクトに関連付く業務アセットと権限セットの取得 | ー |
クエリパラメータ
| 項目名 | 必須 | データ形式 | デフォルト値 | 説明 |
|---|---|---|---|---|
| date | ー | 文字列（YYYY-MM-DD形式） | 実行日を表す文字列 | 情報取得日 |
リクエストヘッダ
「APIリクエストヘッダ」をご覧ください。
リクエストボディ
不要
レスポンス
レスポンスボディ
| 項目名 | データ形式 | 説明 |
|---|---|---|
| projects | projectsオブジェクトの配列 ※各要素の属性は、「projectsオブジェクト」をご覧ください | 利用可能なプロジェクトの情報 |
projectsオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| project | projectオブジェクトの配列 ※各要素の属性は、「projectオブジェクト」をご覧ください | プロジェクトの情報 |
| authorities | authorityオブジェクトの配列 ※各要素の属性は、「authoritiesオブジェクト」をご覧ください | 対象プロジェクトに割り当てられている業務アセットの情報 |
| expectedRoles | expectedRoleオブジェクトの配列 ※各要素の属性は、「expectedRoleオブジェクト」をご覧ください | 対象プロジェクトに割り当てられるサービス権限情報 |
projectオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| date | 文字列（YYYY-MM-DD形式） | プロジェクト情報の情報取得日 |
| id | 文字列 | プロジェクトのID |
| type | 文字列 | プロジェクトであることを示す値「project」が設定 |
| name | 文字列 | プロジェクトの名前 |
| code | 文字列 | プロジェクトコード |
| depth | 整数値 | プロジェクトが作成されている深さ |
| attributes | attributeオブジェクトの配列 ※各要素の属性は、「attributeオブジェクト」をご覧ください | プロジェクトの属性の情報 |
| parent | parentオブジェクト ※各要素の属性は、「parentオブジェクト」をご覧ください | 親プロジェクトの情報 親プロジェクトが無い場合、「null」となる |
attributeオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| entityId | 文字列 | 「project」パラメータの「id」と同じ値 |
| entityType | 文字列 | 「project」パラメータの「type」と同じ値 プロジェクトであることを示す値「project」が設定 |
| dataType | 文字列 | 属性値の形式を規定 |
| attributeId | 文字列 | 属性のID |
| attributeLabel | 文字列 | 属性名 |
| value | 「dataType」に規定の形式 | 属性値の内容 |
authoritiesオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| authority | authorityオブジェクト ※項目は、「authorityオブジェクト」をご覧ください | 対象プロジェクトが割り当てられている権限セットの情報 |
| relations | relationオブジェクトの配列 ※各要素の項目は、「relationオブジェクト」をご覧ください | 権限セットで割り当てられているオブジェクトの情報 |
| connections | connectionsオブジェクトの配列 ※各要素の項目は、「connectionsオブジェクト」をご覧ください | 権限セットで設定されている業務アセットの情報 |
authorityオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 権限セットのID |
| type | 文字列 | 権限セットであることを示す値「authority」が設定 |
| name | 文字列 | 権限セットの名称 |
| code | 文字列 | 権限セットコード (作成者が設定可能) |
| generateTasks | boolean (true / false) | 権限セットでのタスク生成設定 |
| checkAttributeAvailabilities | 文字列の配列 | タスク生成の前提となる属性 原則「TYJ5hHDZSnugN4Lv6e45kw」（「メールアドレス」属性）のみが設定されている |
relationオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 権限セットが直接関連付けされているオブジェクト |
| type | 以下のいずれかの文字列
| 取得したオブジェクトの種別 |
| name | 文字列 | 取得したオブジェクトの名称 |
| code | 文字列 | 取得したオブジェクトのコード (作成者が設定可能) |
| depth | 整数値 | 取得したオブジェクトが作成されている階層の深さ 「type」が「member」の時、削除される |
| parent | parentオブジェクト ※各要素の属性は、「parentオブジェクト」をご覧ください | 親プロジェクトの情報 親プロジェクトが無い場合、「null」となる |
connectionsオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| connection | connectionオブジェクト ※項目は、「connectionオブジェクト」をご覧ください | 業務アセットの情報 |
| roles | roleオブジェクトの配列 ※各要素の項目は、「roleオブジェクト」をご覧ください | 権限セットで設定されている役割の情報 |
expectedRoleオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| connection | connectionオブジェクト ※項目は、「connectionオブジェクト」をご覧ください | 業務アセットの情報 |
| roles | roleオブジェクトの配列 ※各要素の項目は、「roleオブジェクト」をご覧ください | 役割の優先順位に従い、実際に適用される役割の情報 |
共通オブジェクト
parentオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| date | 文字列（YYYY-MM-DD形式） | 親プロジェクト情報の情報取得日 |
| id | 文字列 | 親プロジェクトのID |
| type | 文字列 | プロジェクトであることを示す値「project」が設定 |
| name | 文字列 | 親プロジェクトの名前 |
| code | 文字列 | 親プロジェクトのプロジェクトコード |
| depth | 整数値 | 親プロジェクトが作成されている深さ |
connectionオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 業務アセットのID |
| type | 文字列 | 業務アセットであることを示す値「connection」が設定 |
| name | 文字列 | 業務アセットの名称 |
| code | 文字列 | 業務アセットコード |
| staffs | 文字列の配列 | 業務アセットの担当者情報 |
| generateTasks | boolean（true / false） | 業務アセットでのタスク生成設定 |
| shiftAuthority | shiftAuthorityオブジェクト ※項目は、「shiftAuthorityオブジェクト」をご覧ください | 業務アセットでのタスク生成日の前倒し、後ろ倒し設定 |
| roleIntegrationType | 文字列 | 役割の優先順を決定する設定値 原則は「priority」が設定されている |
shiftAuthorityオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| start | 文字列 | タスク生成日の前倒し期間 ISO8601での継続時間表記で記載 |
| end | 文字列 | タスク生成日の後ろ倒し期間 ISO8601での継続時間表記で記載 |
roleオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 役割のID |
| code | 文字列 | 役割のコード |
| name | 文字列 | 役割の名称 |
| priority | 整数値 | 役割の適用優先度 |