intra-mart Accel Platform IM-Workflow 仕様書第37版 2024-04-01

目次 ≪ 6.1.9.14.5. ノード情報取得 6.1.9.14.7. ノード処理対象者取得 ≫

6.1.9.14.6. ノード関係情報取得¶

ノード関係情報を取得します。

案件の状態（未完了、完了、過去）に関わらず取得できます。

項目

HTTP リクエスト
パスパラメータ
レスポンスデータ
- JSON
- 詳細
エラーコード

6.1.9.14.6.1. HTTP リクエスト ¶

GET /api/workflow/matters/{systemMatterId}/nodes-relationship

6.1.9.14.6.2. パスパラメータ ¶

プロパティ名	論理名	説明
`systemMatterId`	システム案件ID

6.1.9.14.6.3. レスポンスデータ ¶

6.1.9.14.6.3.1. JSON ¶

"data": {
  "comments": [
    {
      "comment": "string",
      "commentedNodeIds": [
        "string"
      ],
      "commentId": "string",
      "height": 0,
      "width": 0,
      "x": 0,
      "y": 0
    }
  ],
  "links": [
    {
      "source": "string",
      "target": "string"
    }
  ],
  "nodes": [
    {
      "authUserPlugins": [
        {
          "extensionPointId": "string",
          "parameter": "string",
          "pluginId": "string",
          "pluginName": "string"
        }
      ],
      "nextNodeIds": [
        "string"
      ],
      "nodeId": "string",
      "nodeName": "string",
      "nodeType": "string",
      "parentNode": {},
      "previousNodeIds": [
        "string"
      ],
      "processInfo": {
        "authUserCd": "string",
        "authUserName": "string",
        "defaultFormatExecuteDate": "string",
        "delegation": true,
        "departmentInfo": {
          "companyCd": "string",
          "companyName": "string",
          "departmentCd": "string",
          "departmentName": "string",
          "departmentSetCd": "string"
        },
        "executeDateTime": "string",
        "executeUserCd": "string",
        "executeUserName": "string",
        "nodeId": "string",
        "type": "string",
        "typeName": "string"
      },
      "progress": "string",
      "replaceType": "string",
      "routeTraceId": "string",
      "x": 0,
      "y": 0
    }
  ],
  "swimlanes": [
    {
      "height": 0,
      "swimlaneId": "string",
      "title": "string",
      "width": 0,
      "x": 0,
      "y": 0
    }
  ]
}

6.1.9.14.6.3.2. 詳細 ¶

プロパティ名	論理名	型	説明
`comments`	コメント情報リスト	array<object>	各プロパティの詳細はコメント情報を参照してください。
`links`	ノード接続情報リスト	array<object>	各プロパティの詳細はノード接続情報を参照してください。
`nodes`	ノード情報リスト	array<object>	各プロパティの詳細はノード情報を参照してください。
`swimlanes`	スイムレーン情報リスト	array<object>	各プロパティの詳細はスイムレーン情報を参照してください。

コメント情報
プロパティ名	論理名	型	説明
`comment`	コメント	string
`commentedNodeIds`	コメントノードと繋がっているノードのID	array<string>
`commentId`	コメントID	string	コメント情報リストで一意になる値 API実行毎に採番されます。
`height`	高さ	number	px指定
`width`	横幅	number	px指定
`x`	x座標	number	px指定
`y`	y座標	number	px指定

ノード接続情報
プロパティ名	論理名	型	説明
`source`	開始ノード方向に配置しているノードのID	string
`target`	終了ノード方向に配置しているノードのID	string

ノード情報
プロパティ名	論理名	型	説明
`authUserPlugins`	処理権限者プラグイン情報リスト	array<object>	各プロパティの詳細は処理権限者プラグイン情報を参照してください。
`nextNodeIds`	次ノードIDリスト	array<string>
`nodeId`	ノードID	string
`nodeName`	ノード名	string
`nodeType`	ノード種別	string	「 CodeList 」のコード値がセットされます。
`parentNode`	親ノード情報	object	親ノードが存在する場合のみセットされます。これらの情報と同様のプロパティを持ちます。
`previousNodeIds`	前ノードIDリスト	array<string>
`processInfo`	処理情報	object	各プロパティの詳細は処理情報を参照してください。
`progress`	ノード進捗	string	`none` 、 `started` 、 `reserved` 、 `finished` のいずれかがセットされます。
`replaceType`	ノード置換種別	string	`none` 、 `horizontal` 、 `vertical` 、 `template` のいずれかがセットされます。
`routeTraceId`	ルート追跡ID	string
`x`	x座標	number
`y`	y座標	number

処理権限者プラグイン情報
プロパティ名	論理名	型	説明
`extensionPointId`	拡張ポイントID	string
`parameter`	プラグインパラメータ	string
`pluginId`	プラグインID	string
`pluginName`	プラグイン名	string	拡張ポイントID/プラグインID の組み合わせで一意に特定される情報の名称例: 「ユーザ」、「組織」など

処理情報
プロパティ名	論理名	型	説明
`authUserCd`	処理権限者コード	string
`authUserName`	処理権限者名	string
`defaultFormatExecuteDate`	実行日（デフォルトフォーマット）	string	yyyy/MM/dd HH:mm:ss.SSS 形式の値
`delegation`	代理フラグ	boolean	この処理履歴が代理者による実行であれば `true`
`departmentInfo`	組織情報	object	各プロパティの詳細は組織情報を参照してください。
`executeDateTime`	実行日時刻	string	アカウントコンテキストの日付時刻表示形式の値アカウントのタイムゾーンへ変換しています。
`executeUserCd`	実行者コード	string
`executeUserName`	実行者名	string
`nodeId`	ノードID	string
`type`	処理種別	string
`typeName`	処理種別名	string

組織情報
プロパティ名	論理名	型	説明
`companyCd`	会社コード	string
`companyName`	会社名	string
`departmentCd`	組織コード	string
`departmentName`	組織名	string
`departmentSetCd`	組織セットコード	string

スイムレーン情報
プロパティ名	論理名	型	説明
`height`	高さ	number	px指定
`swimlaneId`	スイムレーンID	string	コメント情報リストで一意になる値 API実行毎に採番されます。
`title`	スイムレーン名	string
`width`	横幅	number	px指定
`x`	x座標	number	px指定
`y`	y座標	number	px指定

6.1.9.14.6.4. エラーコード ¶

エラーコード	エラーメッセージ	備考
6051	案件が見つかりませんでした。
6052	案件情報が取得できません。

6059	API利用権限が判定できません。
6053	権限がありません。

6058	案件のフロー情報が取得できません。
6068	案件のフロー情報がありません。

6062	開始ノードが存在しません。
6067	案件のノード処理情報が取得できません。

6060	案件のノード進捗情報が取得できません。
6064	案件のノード進捗情報がありません。

目次 ≪ 6.1.9.14.5. ノード情報取得 6.1.9.14.7. ノード処理対象者取得 ≫