タスク情報の参照
リクエスト
エンドポイント
実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。
| HTTPメソッド | APIパス | 用途 | マスタ管理プラスオプション必須 |
|---|---|---|---|
| GET | /api/v22.10/authorityTasks | 従業員の所属や属性の変更によって作成されたタスクの参照 | ー |
クエリパラメータ
| 項目名 | 必須 | データ形式 | デフォルト値 | 説明 |
|---|---|---|---|---|
| from | ー | 文字列（YYYY-MM-DD形式） | 実行日の1週間前を示す文字列 | タスクの検索期間の開始日 このパラメータで設定された日付以降に生成されたタスクの情報を参照する |
| days | ー | 整数値 | 7 | タスクの検索日数 |
リクエストヘッダ
「APIリクエストヘッダ」をご覧ください。
リクエストボディ
不要
レスポンス
レスポンスボディ
| 項目名 | データ形式 | 説明 |
|---|---|---|
| tasks | tasksオブジェクトの配列 ※各要素の属性は、「tasksオブジェクト」をご覧ください | 検索結果 |
tasksオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| task | taskオブジェクト ※項目は、「taskオブジェクト」をご覧ください | 各タスクの情報 |
| changeRequest | changeRequestオブジェクト ※項目は、「changeRequestオブジェクト」をご覧ください | タスクを生成した変更の情報 |
| member | memberオブジェクト ※項目は、「memberオブジェクト」をご覧ください | 対象従業員の情報 |
| connection | connectionオブジェクト ※項目は、「connectionオブジェクト」をご覧ください | 業務アセットの情報 |
| staffs | staffオブジェクトの配列 ※各要素の属性は、「staffオブジェクト」をご覧ください | タスク担当者の情報 |
| action | actionオブジェクト ※項目は、「actionオブジェクト」をご覧ください | タスクの内容 |
| relatedTasks | relatedTaskオブジェクトの配列 | 関連タスクの情報 |
| job | jobオブジェクト ※項目は、「jobオブジェクト」をご覧ください | タスクの自動実行に関する情報 |
taskオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | タスクID |
| applicationDate | 文字列（YYYY-MM-DD形式） | 変更申請が行われた日付 |
| status | 文字列 | タスクのステータス |
| taskNumber | 文字列 | タスク番号 |
| changeDate | 文字列（YYYY-MM-DD形式） | タスクの実行期限 |
changeRequestオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | タスクが作成された変更の内部ID |
| approveAt | 文字列（ISO8601形式） | 変更の承認日時（JSTで記載） |
| name | 文字列 | 変更の管理名 |
memberオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| date | 文字列（YYYY-MM-DD形式） | 従業員情報の情報取得日 |
| id | 文字列 | 従業員のID |
| type | 文字列 | 従業員であることを示す値「member」が設定 |
| name | 文字列 | 従業員の名前 |
| 文字列 | 従業員のメールアドレス | |
| identificationNumber | 文字列 | 従業員の個人ID |
| attributes | attributeオブジェクトの配列 ※各要素の属性は、「attributeオブジェクト」をご覧ください | 業務アセットごとに指定された従業員関連の属性の情報 |
| companies | groupオブジェクトの配列 ※各要素の属性は、「groupオブジェクト」をご覧ください | 従業員が所属している会社の情報 |
| organizations | groupオブジェクトの配列 ※各要素の属性は、「groupオブジェクト」をご覧ください | 従業員が所属している組織の情報 |
| offices | groupオブジェクトの配列 ※各要素の属性は、「groupオブジェクト」をご覧ください | 従業員が所属している事務所の情報 |
| projects | groupオブジェクトの配列 ※各要素の属性は、「groupオブジェクト」をご覧ください | 従業員が所属しているプロジェクトの情報 |
groupオブジェクト
項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 参照しているエンティティのID |
| type | 以下のいずれかの文字列
| 取得したエンティティの種別 |
| name | 文字列 | 取得したエンティティの名称 |
| code | 文字列 | 取得したエンティティのコード (顧客が設定可能) |
| depth | 整数値 | 取得したエンティティが作成されている階層の深さ |
| employeeNumber | 文字列 | 社員番号 (顧客が設定可能) 「type」が「company」の時のみこの項目が表示される |
| attributes | attributeオブジェクトの配列 ※各要素の属性は、「attributeオブジェクト」をご覧ください | 業務アセットごとに指定された出力属性のうち、取得したエンティティに関連する属性の情報 |
| parent | parentオブジェクト ※項目は、「parentオブジェクト」をご覧ください | 取得したエンティティの親に当たるエンティティの情報 親エンティティがある時のみこの項目が表示される |
parentオブジェクト
項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 参照している親エンティティのID |
| type | 以下のいずれかの文字列
| 取得した親エンティティの種別 groupエンティティの「type」と同じ値になる |
| name | 文字列 | 取得した親エンティティの名称 |
| code | 文字列 | 取得した親エンティティのコード（お客様が設定可能） |
| depth | 整数値 | 取得した親エンティティが作成されている階層の深さ groupエンティティの「depth」より1小さい値となる |
connectionオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 業務アセットのID |
| type | 文字列 | 業務アセットであることを示す値「connection」が設定 |
| name | 文字列 | 業務アセットの名称 |
| code | 文字列 | 業務アセットコード |
staffオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | タスク担当者のID |
| name | 文字列 | タスク担当者の名前 |
| 文字列 または null | タスク担当者のメールアドレス 設定されていない場合はnull | |
| type | 以下のいずれかの文字列
| 設定されているエンティティの種別 |
actionオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| type | 以下のいずれかの文字列
| 行う操作の種別
|
| allocation | allocationオブジェクト ※項目は、「allocationオブジェクト」をご覧ください | 割当種別の情報 |
| roles | roleオブジェクトの配列 ※各要素の属性は、「roleオブジェクト」をご覧ください | 権限の種類 |
allocationオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 割当種別のID |
| name | 文字列 | 割当種別名 |
| integrationType | 以下のいずれかの文字列
| 割当種別によって行う操作
|
roleオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 権限のID |
| code | 文字列 | 権限コード |
| name | 文字列 | 権限名 |
| priority | 整数値 | 権限の優先度 |
relatedTaskオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| task | relatedTaskInfoオブジェクト | 関連付けられているタスクの情報 |
| relation | relationオブジェクト ※項目は、「relationオブジェクト」をご覧ください | 関連付けの内容 |
relatedTaskInfoオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | タスクのID |
| taskNumber | 文字列 | タスク番号 |
relationオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| code | 文字列 | 関連付けコード
|
| message | 文字列 | タスク番号 |
jobオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | ジョブのID |
| code | 文字列 | ジョブのステータス |
| message | 文字列 | ジョブのメッセージ |
共通オブジェクト
attributeオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| entityId | 文字列 | 属性が関連するエンティティのID |
| entityType | 以下のいずれかの文字列
| 属性が関連するエンティティの種別 |
| dataType | 文字列 | 属性値のデータ形式 |
| attributeId | 文字列 | 属性のID 「attributeExpression」項目が設定されている場合、項目が表示されない |
| attributeLabel | 文字列 | 属性の表示名 「attributeExpression」項目が設定されている場合、項目が表示されない |
| attributeExpression | 文字列 | 指定された属性式 本項目が設定されている場合のみ、この項目は表示される |
| connectionAttributeKey | 文字列 | 設定で属性に対して指定されたキーや管理名 |
| value | 「entityType」に応じた形式 | 属性値または属性式の結果 |