Hitachi

uCosminexus Service Coordinator Interactive Workflow BPMN連携機能 使用の手引


11.5.8 案件(タイマー)を生成して開始

指定された作業定義名の開始(タイマー)から,案件を生成して開始します。このAPIを実行すると,BPMN連携ライブラリ Java APIのCIWBPMNLib.createAndStartPIForTimerインタフェースが呼び出されます。

メソッドとURL

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

リクエストボディ

項番

名前

指定要否

内容

1

UserDescription

文字列

省略可

ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。

2

ProcessDefinitionName

文字列

必須

ビジネスプロセス定義の名称を指定します。空文字列は指定できません。

3

ProcessDefinitionVersion

数値

省略可

ビジネスプロセス定義のバージョンを指定します。省略した場合は指定したビジネスプロセス定義の中で投入可能(状態が活性かつ案件投入期間内)な最新バージョンになります。

4

WorkDefinitionName

文字列

必須

開始(タイマー)の作業定義名を指定します。空文字列は指定できません。

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

項番

名前

出現回数

1

Parameter

1

2

UserDescription

0または1

3

ProcessDefinitionName

1

4

ProcessDefinitionVersion

0または1

5

WorkDefinitionName

1

リクエスト例

リクエストURL

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

リクエストボディ(XMLの場合)

<?xml version="1.0" encoding="UTF-8" ?>
<Parameter>
  <UserDescription>csciwuser</UserDescription>
  <ProcessDefinitionName>販売業務</ProcessDefinitionName>
  <ProcessDefinitionVersion>5</ProcessDefinitionVersion>
  <WorkDefinitionName>Timer_Timer1</WorkDefinitionName>
</Parameter>

リクエストボディ(JSONの場合)

{
  "UserDescription" : "csciwuser",
  "ProcessDefinitionName" : "販売業務",
  "ProcessDefinitionVersion" : "5",
  "WorkDefinitionName" : "Timer_Timer1"
}

レスポンス

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

項番

名前

内容

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>2000</ID>
  <MovedDate></MovedDate>
  <Name>OrderProcess_0001_20170601120000</Name>
  <Priority>10</Priority>
  <ProcessDefinitionID>3001</ProcessDefinitionID>
  <ProcessDefinitionName>販売業務</ProcessDefinitionName>
  <StartDate>2016-12-15T11:50:51+09:00</StartDate>
  <StateCode>d</StateCode>
</ProcessInstance>

レスポンス(JSONの場合)

{
  "ClosedDate" : "",
  "Creator" : "csciwuser",
  "Deadline" : "2017-06-09T10:32:42+09:00",
  "ID" : "2000",
  "MovedDate" : "",
  "Name" : "OrderProcess_0001_20170601120000",
  "Priority" : "10",
  "ProcessDefinitionID" : "3001",
  "ProcessDefinitionName" : "販売業務",
  "StartDate" : "2016-12-15T11:50:51+09:00",
  "StateCode" : "d"
}