11.5.7　案件（メッセージ）を生成して開始 : uCosminexus Service Coordinator Interactive Workflow BPMN連携機能　使用の手引

メソッドとURL

POST /v1/process-instance/create-and-start-message

リクエストボディ

項番	名前	型	指定要否	内容
1	UserDescription	文字列	省略可	ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。
2	Name	文字列	省略可	案件名を指定します。省略した場合は案件名が設定されません。空文字列は指定できません。
3	Deadline	日付	省略可	処理期限を指定します。省略した場合は処理期限が設定されません。
4	Priority	数値	省略可	優先度を指定します。省略した場合は優先度が設定されません。
5	ProcessDataList	配列	省略可	プロセスデータ一覧を指定します。省略した場合はプロセスデータが設定されません。
6	ProcessData	オブジェクト	必須	プロセスデータオブジェクトを指定します。次の2つの要素（KeyおよびValue）から構成されています。
7	Key	文字列	必須	プロセスデータキー名を指定します。空文字列は指定できません。
8	Value	文字列	省略可	プロセスデータ値を指定します。省略した場合はキーに対応する値は未設定となります。空文字列は指定できません。
9	MessageRef	文字列	必須	案件投入する開始（メッセージ）のMessageRefを指定します。空文字列は指定できません。
10	DefinitionName	文字列	必須	ビジネスプロセス定義の名称を指定します。空文字列は指定できません。
11	DefinitionVersion	数値	省略可	ビジネスプロセス定義のバージョンを指定します。省略した場合は指定したビジネスプロセス定義の中で投入できる（状態が活性かつ案件投入期間内である）最新バージョンとなります。

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

項番	名前				出現回数
1	Parameter				1
2		UserDescription			0または1
3		Name			0または1
4		Deadline			0または1
5		Priority			0または1
6		ProcessDataList			0または1
7			ProcessData		1以上
8				Key	1
9				Value	0または1
10		MessageRef			1
11		DefinitionName			1
12		DefinitionVersion			0または1

リクエスト例

リクエストURL

POST http://restserver/csciwws/v1/process-instance/create-and-start-message

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

<?xml version="1.0" encoding="UTF-8" ?>
<Parameter>
  <UserDescription>csciwuser</UserDescription>
  <Deadline>2017-06-09T10:32:42+09:00</Deadline>
  <Priority>5</Priority>
  <ProcessDataList>
    <ProcessData>
      <Key>$Sdata1</Key>
      <Value>stringvalue1</Value>
    </ProcessData>
    <ProcessData>
      <Key>$Ndata2</Key>
      <Value>100</Value>
    </ProcessData>
  </ProcessDataList>
  <MessageRef>message1</MessageRef>
  <DefinitionName>販売業務</DefinitionName>
  <DefinitionVersion>3</DefinitionVersion>
</Parameter>

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

{
  "UserDescription" : "csciwuser",
  "Deadline" : "2017-06-09T10:32:42+09:00",
  "Priority" : "5",
  "ProcessDataList" : {
    "ProcessData" : [
      {
        "Key" : "$Sdata1",
        "Value" : "stringvalue1"
      },
      {
        "Key" : "$Ndata2",
        "Value" : "100"
      }
    ]
  },
  "MessageRef" : "message1",
  "DefinitionName" : "販売業務",
  "DefinitionVersion" : "3"
}

レスポンス

作成した案件を返します。案件のプロパティを次に示します。

項番	名前	型	内容
1	ClosedDate	日付	案件の終了日時
2	Creator	文字列	案件の投入者
3	Deadline	日付	案件の処理期限の絶対日時
4	ID	数値	案件のID
5	MovedDate	日付	案件の乗せ替え日時
6	Name	文字列	案件の名称（案件キー）
7	Priority	数値	案件の優先度
8	ProcessDefinitionID	数値	案件が所属するビジネスプロセス定義のID
9	ProcessDefinitionName	文字列	案件が所属するビジネスプロセス定義の名称
10	StartDate	日付	案件の開始日時
11	StateCode	文字列	案件の状態

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

項番	名前		出現回数
1	ProcessInstance		1
2		ClosedDate	1
3		Creator	1
4		Deadline	1
5		ID	1
6		MovedDate	1
7		Name	1
8		Priority	1
9		ProcessDefinitionID	1
10		ProcessDefinitionName	1
11		StartDate	1
12		StateCode	1

ステータスコード

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

レスポンス例

レスポンス（XMLの場合）

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProcessInstance>
  <ClosedDate></ClosedDate>
  <Creator>csciwuser</Creator>
  <Deadline>2017-06-09T10:32:42+09:00</Deadline>
  <ID>2001</ID>
  <MovedDate></MovedDate>
  <Name>案件A</Name>
  <Priority>5</Priority>
  <ProcessDefinitionID>3001</ProcessDefinitionID>
  <ProcessDefinitionName>販売業務</ProcessDefinitionName>
  <StartDate>2016-12-15T12:11:45+09:00</StartDate>
  <StateCode>d</StateCode>
</ProcessInstance>

レスポンス（JSONの場合）

{
  "ClosedDate" : "",
  "Creator" : "csciwuser",
  "Deadline" : "2017-06-09T10:32:42+09:00",
  "ID" : "2001",
  "MovedDate" : "",
  "Name" : "案件A",
  "Priority" : "5",
  "ProcessDefinitionID" : "3001",
  "ProcessDefinitionName" : "販売業務",
  "StartDate" : "2016-12-15T12:11:45+09:00",
  "StateCode" : "d"
}

11.5.7 案件（メッセージ）を生成して開始

11.5.7　案件（メッセージ）を生成して開始