11.5.13　業務ステップの一覧取得 : uCosminexus Service Coordinator Interactive Workflow BPMN連携機能　使用の手引

メソッドとURL

GET /v1/activity-instance

クエリパラメタ

項番	名前	型	指定要否	内容
1	userdescription	文字列	省略可	ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。
2	filter	文字列	省略可	業務ステップ一覧を取得する場合のフィルター条件を指定します。省略した場合はフィルター条件を指定しません。空文字列は指定できません。
3	sort	文字列	省略可	取得した業務ステップ一覧をソートする場合の条件を指定します。省略した場合はソート条件を指定しません。空文字列は指定できません。
4	offset	数値	省略可	業務ステップ一覧を取得する場合のオフセットを指定します。先頭は0になります。省略した場合は0が指定されます。0未満の値は指定できません。
5	maxcount	数値	省略可	業務ステップ一覧を取得する場合の最大取得数を指定します。省略した場合はデフォルト値が指定されます。すべてを取得する場合は，-1を指定します。-1未満の値は指定できません。

リクエスト例

リクエストURL

GET http://restserver/csciwws/v1/activity-instance?filter=ID%3E10000

レスポンス

業務ステップ一覧を返します。個々の業務ステップのプロパティを次に示します。

項番	名前	型	内容
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	ActivityInstances			1
2		ActivityInstance		0または1以上
3			ActivityDefinitionID	1
4			ActivityDefinitionName	1
5			ActivityTypeCode	1
6			ClosedDate	1
7			Deadline	1
8			ID	1
9			Name	1
10			Priority	1
11			ProcessDefinitionID	1
12			ProcessInstanceID	1
13			ProcessInstanceName	1
14			StartDate	1
15			StateCode	1

ステータスコード

項番	ステータスコード	内容
1	200	成功（データが0件の場合も成功）
2	400	リクエストパラメタの不正
3	500	内部処理エラー

レスポンス例

レスポンス（XMLの場合）

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ActivityInstances>
  <ActivityInstance>
    <ActivityDefinitionID>3003</ActivityDefinitionID>
    <ActivityDefinitionName>QuotationHandling_UTask1</ActivityDefinitionName>
    <ActivityTypeCode>0</ActivityTypeCode>
    <ClosedDate>2016-12-09T15:00:42+09:00</ClosedDate>
    <Deadline></Deadline>
    <ID>10001</ID>
    <Name></Name>
    <Priority></Priority>
    <ProcessDefinitionID>3001</ProcessDefinitionID>
    <ProcessInstanceID>5002</ProcessInstanceID>
    <ProcessInstanceName>案件20160609103241625</ProcessInstanceName>
    <StartDate>2016-12-09T15:00:41+09:00</StartDate>
    <StateCode>t</StateCode>
  </ActivityInstance>
  <ActivityInstance>
    <ActivityDefinitionID>3001</ActivityDefinitionID>
    <ActivityDefinitionName>VerifyCreditHistory_UTask1</ActivityDefinitionName>
    <ActivityTypeCode>0</ActivityTypeCode>
    <ClosedDate></ClosedDate>
    <Deadline></Deadline>
    <ID>10002</ID>
    <Name></Name>
    <Priority></Priority>
    <ProcessDefinitionID>3001</ProcessDefinitionID>
    <ProcessInstanceID>5002</ProcessInstanceID>
    <ProcessInstanceName>案件20160609103241625</ProcessInstanceName>
    <StartDate>2016-12-09T15:00:42+09:00</StartDate>
    <StateCode>d</StateCode>
  </ActivityInstance>
</ActivityInstances>

レスポンス（JSONの場合）

{
  "ActivityInstance" : [
    {
      "ActivityDefinitionID" : "3003",
      "ActivityDefinitionName" : "QuotationHandling_UTask1",
      "ActivityTypeCode" : "0",
      "ClosedDate" : "2016-12-09T15:00:42+09:00",
      "Deadline" : "",
      "ID" : "10001",
      "Name" : "",
      "Priority" : "",
      "ProcessDefinitionID" : "3001",
      "ProcessInstanceID" : "5002",
      "ProcessInstanceName" : "案件20160609103241625",
      "StartDate" : "2016-12-09T15:00:41+09:00",
      "StateCode" : "t"
    },
    {
      "ActivityDefinitionID" : "3001",
      "ActivityDefinitionName" : "VerifyCreditHistory_UTask1",
      "ActivityTypeCode" : "0",
      "ClosedDate" : "",
      "Deadline" : "",
      "ID" : "10002",
      "Name" : "",
      "Priority" : "",
      "ProcessDefinitionID" : "3001",
      "ProcessInstanceID" : "5002",
      "ProcessInstanceName" : "案件20160609103241625",
      "StartDate" : "2016-12-09T15:00:42+09:00",
      "StateCode" : "d"
    }
  ]
}

11.5.13 業務ステップの一覧取得

11.5.13　業務ステップの一覧取得