案件情報処理系API共通リクエストボディ情報¶

案件処理系APIのリクエストボディ情報の説明です。

項目

処理パラメータ ¶

各APIごとに指定可能なプロパティを記載します。
ワークフローの処理系REST APIでは、未指定の場合に内部で補完を行うプロパティが存在します。
また、指定不可能なプロパティを指定した場合、エラーが発生するため、注意してください。

凡例

指定可能： [1] 等
- マークがついているパラメータは、未指定の場合、エラーが発生します。
- 未指定の場合、空情報として処理を進める情報と、処理内で値が補完される情報があります。
  
  詳細は下記表の各パラメータのリンク先を参照してください。
指定不可： -
- 指定した場合、エラーが発生します。

	一時保存登録	一時保存更新	申請	起票案件の申請	再申請	取り止め	承認	承認終了	差し戻し	否認	保留	保留解除	確認	引戻し	振替
applyAuthUserCd	[1]	[1]	[1]	-	-	-	-	-	-	-	-	-	-	-	-
applyBaseDate	[2]	[2]	[2]	-	-	-	-	-	-	-	-	-	-	-	-
authUserCd	[3]	[3]	-	[3]	[3]	[3]	[3]	[3]	[3]	[3]	[3]	[3]	-	[3]	[3]
authUserDepartmentInfo	-	-	[4]	[4]	[4]	[4]	[4]	[4]	[4]	[4]	-	-	[4]	-	-
branchSelects	-	-	[5]	[5]	[5]	-	[5]	-	-	-	-	-	-	-	-
confirmComment	-	-	-	-	-	-	-	-	-	-	-	-	[6]	-	-
confirmNodeConfigs	-	-	[7]	[7]	[7]	-	[7]	-	-	-	-	-	-	-	-
dynamicNodeConfigs	-	-	[8]	[8]	[8]	-	[8]	-	-	-	-	-	-	-	-
filesForDelete	-	-	-	-	[9]	-	[9]	-	-	-	-	-	-	-	-
flowId	[10]	-	[10]	-	-	-	-	-	-	-	-	-	-	-	-
horizontalNodeConfigs	-	-	[11]	[11]	[11]	-	[11]	-	-	-	-	-	-	-	-
mailSend	-	-	-	-	-	-	-	-	-	-	-	-	-	-	[12]
matterName	[13]	[13]	[13]	[13]	[13]	-	-	-	-	-	-	-	-	-	-
nego	-	-	[14]	[14]	[14]	[14]	[14]	[14]	[14]	[14]	[14]	[14]	-	[14]	-
nodeId	-	-	-	[15]	[15]	[15]	[15]	[15]	[15]	[15]	[15]	[15]	[15]	[15]	[15]
noticeComment	-	-	-	-	-	-	-	-	-	-	-	-	-	-	[16]
priority	-	-	[17]	[17]	[17]	-	-	-	-	-	-	-	-	-	-
processComment	[18]	[18]	[18]	[18]	[18]	[18]	[18]	[18]	[18]	[18]	[18]	[18]	-	[18]	-
sendBackNodeIds	-	-	-	-	-	-	-	-	[19]	-	-	-	-	-	-
systemMatterId	-	-	-	[20]	[20]	[20]	[20]	[20]	[20]	[20]	[20]	[20]	[20]	[20]	[20]
temporaryDirectoryKey	-	-	[21]	[21]	[21]	-	[21]	[21]	-	-	-	-	-	-	-
transferTargetPlugin	-	-	-	-	-	-	-	-	-	-	-	-	-	-	[22]
userDataId	[23]	-	[23]	-	-	-	-	-	-	-	-	-	-	-	-
verticalNodeConfigs	-	-	[24]	[24]	[24]	-	[24]	-	-	-	-	-	-	-	-

[1] applyAuthUserCd ¶

論理名	型	説明
申請権限者コード	string	（補完）アカウントコンテキストのユーザコード

[2] applyBaseDate ¶

論理名	型	説明
申請基準日	string	（補完）アカウントタイムゾーンにおける現在日付 yyyy/MM/dd 形式で指定してください。

[3] authUserCd ¶

論理名	型	説明
処理権限者コード	string	（補完）アカウントコンテキストのユーザコード

[4] authUserDepartmentInfo ¶

プロパティ名	論理名	型	説明
`authUserDepartmentInfo`	権限者組織情報	objet	（補完）以下の優先順位（処理可能な組織に基づく）申請時に選択した組織（再申請時のみ）ユーザコンテキストのカレント組織（代理時は利用しない）主所属処理可能な組織の先頭（処理対象者プラグインの実装に依存する）内包プロパティの会社コード、組織コード、組織セットコードには、組織情報取得APIで取得した値を利用できます。処理のケースにあわせて以下を参照してください。申請時「案件を申請する際に選択可能な所属組織情報取得」確認（未完了案件）時「特定の未完了案件確認時に選択可能な所属組織情報取得」確認（完了案件）時「特定の完了案件確認時に選択可能な所属組織情報取得」上記以外「特定の案件処理時に指定ユーザ権限で選択可能な所属組織情報取得」
- `companyCd`	会社コード	string
- `departmentCd`	組織コード	string
- `departmentSetCd`	組織セットコード	string

[5] branchSelects ¶

プロパティ名	論理名	型	説明
`branchSelects`	分岐先選択情報	array<object>	処理対象のノードを分岐先設定可能ノードとして設定している分岐開始ノードが存在する場合のみ必須です。
- `branchStartNodeId`	分岐開始ノードID	string	処理対象のノードを分岐先設定可能ノードとして設定している分岐開始ノードのノードIDを指定してください。
- `forwardNodeIds`	分岐先ノードIDリスト	array<string>	分岐先として指定可能なノードのノードIDを指定してください。

[6] confirmComment ¶

論理名	型	説明
確認コメント	string

[7] confirmNodeConfigs ¶

プロパティ名	論理名	型	説明
`confirmNodeConfigs`	確認ノード設定情報	array<object>	（補完）以下の優先順位トランザクションデータの設定情報ルート定義の当該ノードに対する設定情報
- `nodeId`	ノードID	string	処理対象のノードを確認対象者設定可能ノードとして設定している確認ノードのノードIDを指定してください。
- `processTargetConfigs`	処理対象者情報	array<object>
- `extensionPointId`	拡張ポイントID	string	設定対象のノードに対応する拡張ポイントIDを指定してください。詳細は「確認対象者プラグインの指定方法」を参照してください。
- `pluginId`	プラグインID	string	設定対象のノードに対応するプラグインIDを指定してください。詳細は「確認対象者プラグインの指定方法」を参照してください。
- `parameter`	パラメータ	string	プラグインに対するパラメータを指定してください。詳細は「確認対象者プラグインの指定方法」を参照してください。

[8] dynamicNodeConfigs ¶

プロパティ名	論理名	型	説明
`dynamicNodeConfigs`	動的承認ノード設定情報	array<object>	（補完）以下の優先順位トランザクションデータの設定情報ルート定義の当該ノードに対する設定情報
- `nodeId`	ノードID	string	処理対象のノードを処理対象者設定可能ノードとして設定している確認ノードのノードIDを指定してください。
- `processTargetConfigs`	処理対象者情報	array<object>
- `extensionPointId`	拡張ポイントID	string	設定対象のノードに対応する拡張ポイントIDを指定してください。詳細は「処理権限者プラグインの指定方法」を参照してください。
- `pluginId`	プラグインID	string	設定対象のノードに対応するプラグインIDを指定してください。詳細は「処理権限者プラグインの指定方法」を参照してください。
- `parameter`	パラメータ	string	プラグインに対するパラメータを指定してください。詳細は「処理権限者プラグインの指定方法」を参照してください。

[9] filesForDelete ¶

論理名	型	説明
削除対象ファイルID配列	array<string>	「案件添付ファイル一覧取得」で取得した値を利用できます。

[10] flowId ¶

論理名	型	説明
フローID	string

[11] horizontalNodeConfigs ¶

プロパティ名	論理名	型	説明
`horizontalNodeConfigs`	横配置ノード設定情報	array<object>	（補完）以下の優先順位トランザクションデータの設定情報この際の展開ノード数は、フロー定義で設定された割当可能最小ノード数分とするルート定義の当該ノードに対する設定情報
- `nodeId`	ノードID	string	処理対象のノードを処理対象者設定可能ノードとして設定している横配置ノードのノードIDを指定してください。
- `matterNodeExpansions`	ノード展開情報	array<object>	横配置ノード内に展開するノード毎の情報を表します。
- `nodeName`	展開ノード名	string	展開するノードのノード名を指定してください。
- `processTargetConfigs`	処理対象者情報	array<object>	[8] dynamicNodeConfigs を参照してください。

[12] mailSend ¶

論理名	型	説明
振替通知フラグ	boolean	振替通知を利用する場合は `true` を指定してください。

[13] matterName ¶

論理名	型	説明
案件名	string	（補完）トランザクションデータの案件名

[14] nego ¶

プロパティ名	論理名	型	説明
`nego`	根回し情報	object
- `userCdsTo`	宛先（TO）に指定するユーザコード配列	array<string>	必須です。
- `userCdsCc`	CCに指定するユーザコード配列	array<string>
- `userCdsBcc`	BCCに指定するユーザコード配列	array<string>
- `subject`	件名	string
- `text`	本文	string

[15] nodeId ¶

論理名	型	説明
ノードID	string	APIを実行する対象ノードのノードIDを指定してください。

[16] noticeComment ¶

論理名	型	説明
振替通知コメント	string

[17] priority ¶

論理名	型	説明
優先度	string	（補完）申請：標準再申請：トランザクションデータの優先度

[18] processComment ¶

論理名	型	説明
処理コメント	string

[19] sendBackNodeIds ¶

論理名	型	説明
差戻し先ノードID配列	array<string>	（補完）申請ノードのノードIDを含むサイズ1の配列

[20] systemMatterId ¶

論理名	型	説明
システム案件ID	string

[21] temporaryDirectoryKey ¶

論理名	型	説明
添付ファイル一時領域ディレクトリキー	string	添付ファイルを追加する場合に指定してください。「添付ファイルアップロード」で取得した値を利用してください。

[22] transferTargetPlugin ¶

プロパティ名	論理名	型	説明
`transferTargetPlugin`	振替先処理権限者プラグイン情報	array<object>
- `extensionPointId`	拡張ポイントID	string	対応する拡張ポイントIDを指定してください。詳細は「処理権限者プラグインの指定方法」を参照してください。
- `parameter`	パラメータ	string	プラグインに対するパラメータを指定してください。詳細は「処理権限者プラグインの指定方法」を参照してください。
- `pluginId`	プラグインID	string	対応するプラグインIDを指定してください。詳細は「処理権限者プラグインの指定方法」を参照してください。

[23] userDataId ¶

論理名	型	説明
ユーザデータID	string	（補完一時保存時） Identifier#get を利用して取得した値（補完申請時）「ユーザデータID設定方式」に設定した方式で取得した値一時保存情報を利用して申請する場合は当該情報のユーザデータIDを指定してください。

[24] verticalNodeConfigs ¶

プロパティ名	論理名	型	説明
`verticalNodeConfigs`	縦配置ノード設定情報	array<object>	（補完）以下の優先順位トランザクションデータの設定情報この際の展開ノード数は、フロー定義で設定された割当可能最小ノード数分とするルート定義の当該ノードに対する設定情報
プロパティ名	論理名	型	説明
`nodeId`	ノードID	string	処理対象のノードを処理対象者設定可能ノードとして設定している縦配置ノードのノードIDを指定してください。
`matterNodeExpansions`	ノード展開情報	array<object>	縦配置ノード内に展開するノード毎の情報を表します。
- `nodeName`	展開ノード名	string	展開するノードのノード名を指定してください。
- `processTargetConfigs`	処理対象者情報	array<object>	[8] dynamicNodeConfigs を参照してください。

オプショナルパラメータ ¶

JSON ¶

{
  "optionalParameter": {
      "userParameter": {
          "imwStampId": "string",
          "xxxx": "string"
      },
      "formaParam": {
          "items": {
            "textbox1": "string"
          }
      }
  }
}

userParameter¶

userParameterには、アクション処理に受け渡したいパラメータを指定してください。

印影を指定する場合、imwStampIdを指定してください。

印影を利用していて、imwStampIdを指定しない場合、常用印が利用されます。

formaParam¶

formaParamには IM-FormaDesigner ／ IM-BIS で作成したワークフローに対して、登録したいアプリケーションデータを指定できます。

詳細は以下のリンクを参照してください。

IM-FormaDesigner ／ IM-BIS 連携フローの追加処理

目次

案件情報処理系API共通リクエストボディ情報¶

処理パラメータ ¶

[1] applyAuthUserCd ¶

[2] applyBaseDate ¶

[3] authUserCd ¶

[4] authUserDepartmentInfo ¶

[5] branchSelects ¶

[6] confirmComment ¶

[7] confirmNodeConfigs ¶

[8] dynamicNodeConfigs ¶

[9] filesForDelete ¶

[10] flowId ¶

[11] horizontalNodeConfigs ¶

[12] mailSend ¶

[13] matterName ¶

[14] nego ¶

[15] nodeId ¶

[16] noticeComment ¶

[17] priority ¶

[18] processComment ¶

[19] sendBackNodeIds ¶

[20] systemMatterId ¶

[21] temporaryDirectoryKey ¶

[22] transferTargetPlugin ¶

[23] userDataId ¶

[24] verticalNodeConfigs ¶

オプショナルパラメータ ¶

JSON ¶

userParameter¶

formaParam¶

目次