intra-mart Accel Platform IM-Workflow 仕様書 第38版 2024-10-01

6.1.9.3.8. ノード関係情報取得

ノード(ノード、コメント、スイムレーン)とノード接続情報を取得します。

6.1.9.3.8.1. HTTP リクエスト

GET /api/workflow/applications/{flowId}/nodes-relationship

6.1.9.3.8.2. パスパラメータ

パラメータ 論理名 説明
flowId フローID  

6.1.9.3.8.3. クエリパラメータ

パラメータ 論理名 必須 説明
applyBaseDate 申請基準日 String 必須 「yyyy/MM/dd」フォーマット

6.1.9.3.8.4. レスポンスデータ

6.1.9.3.8.4.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.3.8.4.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指定
ノード情報
プロパティ名 論理名 説明
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 nonestartedreservedfinished のいずれかがセットされます。
replaceType ノード置換種別 string nonehorizontalverticaltemplate のいずれかがセットされます。
routeTraceId ルート追跡ID string  
x x座標 number  
y y座標 number  
処理権限者プラグイン情報
プロパティ名 論理名 説明
extensionPointId 拡張ポイントID string  
parameter プラグインパラメータ string  
pluginId プラグインID string  
pluginName プラグイン名 string
拡張ポイントID/プラグインID の組み合わせで一意に特定される情報の名称
例: 「ユーザ」、「組織」など
スイムレーン情報
プロパティ名 論理名 説明
height 高さ number px指定
swimlaneId スイムレーンID string
コメント情報リストで一意になる値
API実行毎に採番されます。
title スイムレーン名 string  
width 横幅 number px指定
x x座標 number px指定
y y座標 number px指定

6.1.9.3.8.5. エラーコード

エラーコード エラーメッセージ 備考
0001 基準日 {0} を {1} 形式で入力してください。  
0002 フロー情報が取得できません。  
0003 権限がありません。  
0006 API利用権限が判定できません。  
0009 開始ノードが存在しません。  
5029 申請基準日が未指定です。  
5052 日付の認識に失敗しました。管理者に連絡してください。