6.1.9.18.3. 一時保存情報のフロー設定情報取得¶
一時保存案件に必要なフロー情報を取得します。
一時保存時のフローバージョンが存在しない場合はエラーを返却します。
指定した申請基準日に有効なフローの情報の変更可能範囲を取得します。
有効なフロー、コンテンツ、ルートのいづれかがない場合はエラーを返却します。
申請基準日を省略した場合はシステム日付で処理を行います。
6.1.9.18.3.1. HTTP リクエスト¶
PUT /api/workflow/temporary-saves/{userDataId}/config-set
6.1.9.18.3.2. パスパラメータ¶
| プロパティ名 | 論理名 | 型 | 必須 | 説明 |
|---|---|---|---|---|
| userDataId | ユーザデータID | string | 必須 |
6.1.9.18.3.3. クエリパラメータ¶
| プロパティ名 | 論理名 | 型 | 必須 | 説明 |
|---|---|---|---|---|
| flowId | フローID | string | - | 取得対象フローのフローIDを指定してください。 |
| nodeId | ノードID | string | - | |
| authUserCode | 処理権限者コード | string | - | |
| applyBaseDate | 申請基準日 | string | - | アカウントタイムゾーンにおける現在日付
yyyy/MM/dd 形式で指定してください。
省略した場合はシステム日付で処理を行います。
|
6.1.9.18.3.4. リクエストボディ¶
6.1.9.18.3.4.1. JSON¶
{
"data": {
"flowId": "string",
"flowVersionId": "string",
"contentsId": "string",
"routeId": "string",
"authUserCode": "string",
"sysDateTargetExpand": true,
"applicableRangeStartDate": "string",
"applicableRangeLimitDate": "string",
"defaultFormatApplicableRangeStartDate": "string",
"defaultFormatApplicableRangeLimitDate": "string"
}
}
6.1.9.18.3.5. 詳細¶
| プロパティ名 | 論理名 | 型 | 説明 |
|---|---|---|---|
| flowId | フローID | string | |
| flowVersionId | フローバージョンID | string | |
| contentsId | コンテンツID | string | フローに設定されているコンテンツID |
| routeId | ルートID | string | フローに設定されているルートID |
| authUserCode | 処理権限者コード | string | |
| sysDateTargetExpand | システム日で対象者を展開するフラグ | boolean | |
| applicableRangeStartDate | 申請可能範囲開始日 | string | アカウントコンテキストの日付表示形式の値
アカウントのタイムゾーンへ変換しています。
|
| applicableRangeLimitDate | 申請可能範囲終了日 | string | アカウントコンテキストの日付表示形式の値
アカウントのタイムゾーンへ変換しています。
|
| defaultFormatApplicableRangeStartDate | 申請可能範囲開始日（デフォルトフォーマット） | string | yyyy/MM/dd の形式です。
例） 0000/00/00
|
| defaultFormatApplicableRangeLimitDate | 申請可能範囲終了日（デフォルトフォーマット） | string | yyyy/MM/dd の形式です。
例） 0000/00/00
|
6.1.9.18.3.6. エラーコード¶
| エラーコード | エラーメッセージ | 備考 |
|---|---|---|
| 6330 | 有効なフロー情報が存在しません。 | 指定したユーザデータIDのフロー情報が存在しなかった場合 |
| 6331 | フロー情報の取得処理で失敗しました。 | 指定したユーザデータIDでフロー情報の取得に失敗した場合 |
| 6332 | 指定日で有効なコンテンツ情報取得で失敗しました。 | 指定した申請基準日でコンテンツ情報の取得に失敗した場合 |
| 6333 | 指定日で有効なコンテンツ情報が存在しません。 | 指定した申請基準日にコンテンツ情報が存在しなかった場合 |
| 6334 | 指定日で有効なルート情報取得で失敗しました。 | 指定した申請基準日でルート情報の取得に失敗した場合 |
| 6335 | 指定日で有効なルート情報が存在しません。 | 指定した申請基準日にルート情報が存在しなかった場合 |
| 6336 | 申請基準日のフォーマットが不正です。 | クエリパラメータ - applyBaseDate のフォーマットが yyyy/MM/dd ではない場合 |
| 6342 | 一時保存情報が存在しません。 | 指定した検索条件で一時保存情報が存在しなかった場合。 |
| 6343 | 指定日で有効なフロー情報取得で失敗しました。 | 指定した申請基準日でフロー情報が存在しなかった場合 |
| 6344 | 指定日で有効なフロー情報が存在しません。 | 指定した申請基準日にフロー情報が存在しなかった場合 |