11.5.16　業務ステップの差し戻しまたは引き戻し : uCosminexus Service Coordinator Interactive Workflow BPMN連携機能　使用の手引

指定したIDの業務ステップを差し戻します（引き戻します）。このAPIを実行すると，BPMN連携ライブラリ Java APIのCIWBPMNLib.makeBackwardTransitionAIインタフェースが呼び出されます。業務ステップが差し戻し（引き戻し）済みだった場合は，リクエストは成功します（何もしないでステータスコード200を返します）。詳細については，「5.3　Java API利用時の注意事項」の「べき等性について」の説明を参照してください。

メソッドとURL

PUT /v1/activity-instance/<案件ID>/<業務ステップID>/make-backward-transition

<案件ID>：差し戻す業務ステップの案件ID（必須）

<業務ステップID>：差し戻す業務ステップのID（必須）

リクエストボディ

項番	名前	型	指定要否	内容
1	UserDescription	文字列	省略可	ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。
2	ProcessDataList	配列	省略可	プロセスデータ一覧を指定します。省略した場合はプロセスデータを更新しません。
3	ProcessData	オブジェクト	必須	プロセスデータオブジェクトを指定します。次の2つの要素（KeyおよびValue）から構成されています。
4	Key	文字列	必須	プロセスデータキー名を指定します。空文字列は定できません。
5	Value	文字列	省略可	プロセスデータ値を指定します。省略した場合，Keyに対応する値は未設定となります。空文字列は指定できません。
6	ActivityDefinitionName	文字列	必須	差し戻し先または引き戻し先の業務ステップ定義名を指定します。空文字列は指定できません。

リクエストボディの構造を次に示します。

項番	名前				出現回数
1	Parameter				1
2		UserDescription			0または1
3		ProcessDataList			0または1
4			ProcessData		1以上
5				Key	1
6				Value	0または1
7		ActivityDefinitionName			1

リクエスト例

リクエストURL

PUT http://restserver/csciwws/v1/activity-instance/5002/10002/make-backward-transition

リクエストボディ（XMLの場合）

<?xml version="1.0" encoding="UTF-8" ?>
<Parameter>
  <ProcessDataList>
    <ProcessData>
      <Key>$Sdata1</Key>
      <Value>stringvalue1</Value>
    </ProcessData>
    <ProcessData>
      <Key>$Ndata2</Key>
      <Value>100</Value>
    </ProcessData>
  </ProcessDataList>
  <ActivityDefinitionName>QuotationHandling_UTask1</ActivityDefinitionName>
</Parameter>

リクエストボディ（JSONの場合）

{
  "ProcessDataList" : {
    "ProcessData" : [
      {
        "Key" : "$SData1",
        "Value" : "stringvalue1"
      },
      {
        "Key" : "$Ndata2",
        "Value" : "100"
      }
    ]
  },
  "ActivityDefinitionName" : "QuotationHandling_UTask1"
}

レスポンス

差し戻した業務ステップを返します。業務ステップのプロパティを次に示します。

項番	名前	型	内容
1	ActivityDefinitionID	数値	業務ステップ定義のID
2	ActivityDefinitionName	文字列	業務ステップ定義の名称
3	ActivityTypeCode	文字列	業務ステップの種類
4	ClosedDate	日付	業務ステップの終了日時
5	Deadline	日付	業務ステップの処理期限の絶対日時
6	ID	数値	業務ステップのID
7	Name	文字列	業務ステップの名称（業務ステップキー）
8	Priority	数値	業務ステップの優先度
9	ProcessDefinitionID	数値	業務ステップが所属するビジネスプロセス定義のID
10	ProcessInstanceID	数値	業務ステップが所属する案件のID
11	ProcessInstanceName	文字列	業務ステップの案件名（案件キー）
12	StartDate	日付	業務ステップの開始日時
13	StateCode	文字列	業務ステップの状態

レスポンスの構造を次に示します。

項番	名前		出現回数
1	ActivityInstance		1
2		ActivityDefinitionID	1
3		ActivityDefinitionName	1
4		ActivityTypeCode	1
5		ClosedDate	1
6		Deadline	1
7		ID	1
8		Name	1
9		Priority	1
10		ProcessDefinitionID	1
11		ProcessInstanceID	1
12		ProcessInstanceName	1
13		StartDate	1
14		StateCode	1

ステータスコード

項番	ステータスコード	内容
1	200	成功
2	400	リクエストパラメタの不正
3	404	データが見つからなかった
4	500	内部処理エラー

レスポンス例

レスポンス（XMLの場合）

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ActivityInstance>
  <ActivityDefinitionID>3001</ActivityDefinitionID>
  <ActivityDefinitionName>QuotationHandling_UTask1</ActivityDefinitionName>
  <ActivityTypeCode>0</ActivityTypeCode>
  <ClosedDate>2016-12-09T16:00:42+09:00</ClosedDate>
  <Deadline></Deadline>
  <ID>10002</ID>
  <Name></Name>
  <Priority></Priority>
  <ProcessDefinitionID>3002</ProcessDefinitionID>
  <ProcessInstanceID>5002</ProcessInstanceID>
  <ProcessInstanceName></ProcessInstanceName>
  <StartDate>2016-12-09T15:00:42+09:00</StartDate>
  <StateCode>u</StateCode>
</ActivityInstance>

レスポンス（JSONの場合）

{
  "ActivityDefinitionID" : "3001",
  "ActivityDefinitionName" : "QuotationHandling_UTask1",
  "ActivityTypeCode" : "0",
  "ClosedDate" : "2016-12-09T16:00:42+09:00",
  "Deadline" : "",
  "ID" : "10002",
  "Name" : "",
  "Priority" : "",
  "ProcessDefinitionID" : "3002",
  "ProcessInstanceID" : "5002",
  "ProcessInstanceName" : "",
  "StartDate" : "2016-12-09T15:00:42+09:00",
  "StateCode" : "u"
}

11.5.16 業務ステップの差し戻しまたは引き戻し

11.5.16　業務ステップの差し戻しまたは引き戻し