🌐

タスク照会API

 
 

役割変更データの照会

ユーザの属性や、所属する組織、プロジェクト等の変更に伴う、関連付けられるサービスとその役割の変更タスクを照会する。
 

1. YESODへのリクエスト

下記項目のCSVデータをPOSTする

リクエストURL

パラメータ

 

Header

Body

なし

2. レスポンス

 
  • タスクリスト(tasks)
    • タスク(task)
      • タスクID(id)
      • 申請日付(applicationDate)
      • ステータス(status)
      • タスク番号(taskNumber)
      • タスクの実行期限(changeDate)
    • タスクのリクエスト(changeRequest)
      • タスクが作成された変更の内部ID(id)
      • 変更の承認日時(approvedAt)
      • 変更の管理名(name)
    • 対象者(member)
      • データの日付(date) ・・・ このデータがいつ時点の情報かを表す日付(基本はタスク実行日だが、タスク実行日が入社日前なら入社日、退社日後なら退社日となる)
      • YESODの内部ID(id)
      • タイプ(type)
      • 氏名(name)
      • サービス毎に指定された出力属性(attributes)
        • エンティティID(entityId) ・・・ メンバのYESOD内部ID
        • エンティティ型(entityType) ・・・ この階層は ”member” のみ
        • 属性型(dataType) ・・・ ”TEXT”、”NUMBER” 等、属性値の型
        • 属性ID(attributeId) ・・・ 属性のYESOD内部ID
        • 属性ラベル(attributeLabel) ・・・ 属性のラベル
        • 指定された属性キー(connectionAttributeKey) ・・・ 設定で属性に対して指定されたキーや管理名
        • 属性値(value) ・・・ 属性値
      • 会社(companies)
        • YESODの内部id(id)
        • タイプ(type)
        • 会社名(name)
        • 階層(depth)
        • 会社コード(code)
        • 社員番号(employeeNumber)
        • サービス毎に指定された出力属性(attributes)
          • エンティティID(entityId) ・・・ メンバもしくは会社のYESOD内部ID
          • エンティティ型(entityType) ・・・ この階層は ”member” もしくは “company”
          • 属性型(dataType) ・・・ ”TEXT”、”NUMBER” 等、属性値の型
          • 属性ID(attributeId) ・・・ 属性のYESOD内部ID
          • 属性ラベル(attributeLabel) ・・・ 属性のラベル
          • 指定された属性キー(connectionAttributeKey) ・・・ 設定で属性に対して指定されたキーや管理名
          • 属性値(value) ・・・ 属性値
      • 組織(organizations)
        • YESODの内部id(id)
        • タイプ(type)
        • 所属組織名(name)
        • 組織コード(code)
        • 組織の階層(depth)
        • サービス毎に指定された出力属性(attributes)
          • エンティティID(entityId) ・・・ メンバもしくは組織のYESOD内部ID
          • エンティティ型(entityType) ・・・ この階層は ”member” もしくは “organization”
          • 属性型(dataType) ・・・ ”TEXT”、”NUMBER” 等、属性値の型
          • 属性ID(attributeId) ・・・ 属性のYESOD内部ID
          • 属性ラベル(attributeLabel) ・・・ 属性のラベル
          • 指定された属性キー(connectionAttributeKey) ・・・ 設定で属性に対して指定されたキーや管理名
          • 属性値(value) ・・・ 属性値
        • 親組織(parent)
          • YESODの内部id(id)
          • タイプ(type)
          • 所属組織名(name)
          • 組織コード(code)
          • 組織の階層(depth)
      • 事業所(offices)
        • YESODの内部id(id)
        • タイプ(type)
        • 所属事業所名(name)
        • 事業所コード(code)
        • 事業所の階層(depth)
        • サービス毎に指定された出力属性(attributes)
          • エンティティID(entityId) ・・・ メンバもしくは事業所のYESOD内部ID
          • エンティティ型(entityType) ・・・ この階層は ”member” もしくは “office”
          • 属性型(dataType) ・・・ ”TEXT”、”NUMBER” 等、属性値の型
          • 属性ID(attributeId) ・・・ 属性のYESOD内部ID
          • 属性ラベル(attributeLabel) ・・・ 属性のラベル
          • 指定された属性キー(connectionAttributeKey) ・・・ 設定で属性に対して指定されたキーや管理名
          • 属性値(value) ・・・ 属性値
      • プロジェクト(projects)
        • YESODの内部id(id)
        • タイプ(type)
        • 所属プロジェクト名(name)
        • プロジェクトコード(code)
        • 階層(depth)
        • サービス毎に指定された出力属性(attributes)
          • エンティティID(entityId) ・・・ メンバもしくはプロジェクトのYESOD内部ID
          • エンティティ型(entityType) ・・・ この階層は ”member” もしくは “project”
          • 属性型(dataType) ・・・ ”TEXT”、”NUMBER” 等、属性値の型
          • 属性ID(attributeId) ・・・ 属性のYESOD内部ID
          • 属性ラベル(attributeLabel) ・・・ 属性のラベル
          • 指定された属性キー(connectionAttributeKey) ・・・ 設定で属性に対して指定されたキーや管理名
          • 属性値(value) ・・・ 属性値
        • 親プロジェクト(parent)
          • YESODの内部id(id)
          • タイプ(type)
          • 所属プロジェクト名(name)
          • プロジェクトコード(code)
          • 階層(depth)
      • メールアドレス(email)
      • 人ID(identificationNumber)
    • サービス(connections)
      • サービスのid(id)
      • サービスのタイプ(type)
      • サービス名(name)
      • サービスコード(code)
      • サービスの担当者(staffs)
      • サービスのタスク生成の有効/無効(generateTasks)
      • タスク生成日の前倒し、後ろ倒し(shiftAuthority)
        • 入社日からの前倒し(start)
    • タスク内容(action)
      • 操作タイプ(type)
        • grant ・・・ 権限付与
        • revoke ・・・ 権限剥奪
        • modify ・・・ 権限変更
      • 権限リスト(roles)
        • 権限のid(id)
        • 権限コード(code)
        • 権限名(name)
        • 権限の優先度(priority)
    • 関連タスク(relatedTask)・・・新規タスクにのみ付与される
      • タスク(task)
        • YESODの内部ID(id)
        • タスク番号(taskNumber)
      • 関連付け内容(relation)
        • 関連付けコード(code)
          • 0001 ・・・ 当タスクの生成に伴い、取り消す必要がある先行タスク
          • 0002 ・・・ 当タスクの実行の前に、優先すべき先行タスク
        • メッセージ(message)
    • タスク自動実行時情報(job)
      • ジョブid(id)
      • ジョブのステータス(status)
      • ジョブのメッセージ(message)
 

サービス毎に指定された出力属性について

YESODのサービス設定画面上で、APIを通じて出力したい属性を指定することができます。
属性を指定する際に、JSONで値を識別するのに使用する、 を指定することができます(下記画像の , 等 )。
 
属性のうち、
  • メンバの直接の属性(姓名等)は、 に出力されます
  • 組織やプロジェクトの属性(組織名、プロジェクト名、組織コード、プロジェクトコード等)および、組織やプロジェクトとメンバの間の属性(組織内での立場(組織長、組織長代理)、プロジェクト内での立場(プロジェクトリーダー等))は、 , に出力されます
    • このとき、「組織やプロジェクトの属性」か「組織やプロジェクトとメンバの間の属性」かを判断するには、 の値( , , , , )で判断してください
 
 

レスポンス例