11.5.34　ビジネスプロセス定義の取得 : uCosminexus Service Coordinator Interactive Workflow BPMN連携機能　使用の手引

メソッドとURL

GET /v1/process-definition/<ビジネスプロセス定義のID>

<ビジネスプロセス定義のID>：取得するビジネスプロセス定義のID（必須）

クエリパラメタ

項番	名前	型	指定要否	内容
1	userdescription	文字列	省略可	ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。

リクエスト例

リクエストURL

GET http://restserver/csciwws/v1/process-definition/3

レスポンス

ビジネスプロセス定義を返します。レスポンスとして返されるプロパティを次に示します。

項番	名前	型	内容
1	Author	文字列	ビジネスプロセス定義の作成者
2	CreationDate	日付	ビジネスプロセス定義の作成日
3	Description	文字列	ビジネスプロセス定義の説明
4	ID	数値	ビジネスプロセス定義のID
5	Name	文字列	ビジネスプロセス定義の名称
6	Responsible	文字列	ビジネスプロセス定義の管理者ID
7	StateCode	文字列	ビジネスプロセス定義の状態
8	ValidFromDate	日付	ビジネスプロセス定義の有効となる日
9	ValidToDate	日付	ビジネスプロセス定義の無効となる日
10	Version	数値	ビジネスプロセス定義のバージョン

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

項番	名前		出現回数
1	ProcessDefinition		1
2		Author	1
3		CreationDate	1
4		Description	1
5		ID	1
6		Name	1
7		Responsible	1
8		StateCode	1
9		ValidFromDate	1
10		ValidToDate	1
11		Version	1

ステータスコード

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

レスポンス例

レスポンス（XMLの場合）

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProcessDefinition>
  <Author>user1</Author>
  <CreationDate>2016-12-06T15:18:35+09:00</CreationDate>
  <Description></Description>
  <ID>3</ID>
  <Name>販売業務</Name>
  <Responsible>user1</Responsible>
  <StateCode>b</StateCode>
  <ValidFromDate>ORIGIN</ValidFromDate>
  <ValidToDate>BEYOND</ValidToDate>
  <Version>2</Version>
</ProcessDefinition>

レスポンス（JSONの場合）

{
  "Author" : "user1",
  "CreationDate" : "2016-12-06T15:18:35+09:00",
  "Description" : "",
  "ID" : "3",
  "Name" : "販売業務",
  "Responsible" : "user1",
  "StateCode" : "b",
  "ValidFromDate" : "ORIGIN",
  "ValidToDate" : "BEYOND",
  "Version" : "2"
}

11.5.34 ビジネスプロセス定義の取得

11.5.34　ビジネスプロセス定義の取得