Hitachi

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

11.5.19　作業の一覧取得

指定したフィルター条件を満たす，作業の一覧を取得します。このAPIを実行すると，CSCIW Java APIのCIWServer.getWorkItemsListインタフェースが呼び出されます。

メソッドとURL

GET /v1/work-item

クエリパラメタ

項番

名前

型

指定要否

内容

1

userdescription

文字列

省略可

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

2

filter

文字列

省略可

作業一覧を取得する場合のフィルター条件を指定します。省略した場合はフィルター条件を指定しません。空文字列は指定できません。

3

sort

文字列

省略可

取得した作業一覧をソートする場合の条件を指定します。省略した場合はソート条件を指定しません。空文字列は指定できません。

4

offset

数値

省略可

作業一覧を取得する場合のオフセットを指定します。先頭は0になります。省略した場合は0が指定されます。0未満の値は指定できません。

5

maxcount

数値

省略可

作業一覧を取得する場合の最大取得数を指定します。省略した場合はデフォルト値が指定されます。すべてを取得する場合は，-1を指定します。-1未満の値は指定できません。

リクエスト例

リクエストURL

GET http://restserver/csciwws/v1/work-item?filter=ID%3E10000

レスポンス

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

項番

名前

型

内容

1

ActivityInstanceID

数値

作業が所属する業務ステップのID

2

ClosedDate

日付

作業の終了日時

3

CreationDate

日付

作業の発生日時

4

Deadline

日付

作業の処理期限の絶対日時

5

ID

数値

作業のID

6

Name

文字列

作業の名称（作業キー）

7

Participant

文字列

作業の作業者ID

8

Priority

数値

作業の優先度

9

ProcessDefinitionID

数値

作業が所属するビジネスプロセス定義のID

10

ProcessInstanceID

数値

作業が所属する案件のID

11

ProcessInstanceName

文字列

作業の案件名（案件キー）

12

StartDate

日付

作業の開始日時

13

StateCode

文字列

作業の状態

14

WorkDefinitionID

数値

作業定義のID

15

WorkDefinitionName

文字列

作業定義の名称

16

WorkTypeCode

文字列

作業の種類

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

項番

名前

出現回数

1

WorkItems

1

2

WorkItem

0または1以上

3

ActivityInstanceID

1

4

ClosedDate

1

5

CreationDate

1

6

Deadline

1

7

ID

1

8

Name

1

9

Participant

1

10

Priority

1

11

ProcessDefinitionID

1

12

ProcessInstanceID

1

13

ProcessInstanceName

1

14

StartDate

1

15

StateCode

1

16

WorkDefinitionID

1

17

WorkDefinitionName

1

18

WorkTypeCode

1

ステータスコード

項番

ステータスコード

内容

1

200

成功（データが0件の場合も含む）

2

400

リクエストパラメタの不正

3

500

内部処理エラー

レスポンス例

レスポンス（XMLの場合）

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<WorkItems>
  <WorkItem>
    <ActivityInstanceID>10001</ActivityInstanceID>
    <ClosedDate>2016-12-09T15:00:41+09:00</ClosedDate>
    <CreationDate>2016-12-09T15:00:40+09:00</CreationDate>
    <Deadline></Deadline>
    <ID>10001</ID>
    <Name></Name>
    <Participant>User001</Participant>
    <Priority>0</Priority>
    <ProcessDefinitionID>3001</ProcessDefinitionID>
    <ProcessInstanceID>5002</ProcessInstanceID>
    <ProcessInstanceName>案件20160609103241625</ProcessInstanceName>
    <StartDate>2016-12-09T15:00:41+09:00</StartDate>
    <StateCode>r</StateCode>
    <WorkDefinitionID>3003</WorkDefinitionID>
    <WorkDefinitionName>QuotationHandling_UTask1</WorkDefinitionName>
    <WorkTypeCode>0</WorkTypeCode>
  </WorkItem>
  <WorkItem>
    <ActivityInstanceID>10002</ActivityInstanceID>
    <ClosedDate>2016-12-09T15:25:22+09:00</ClosedDate>
    <CreationDate>2016-12-09T15:00:41+09:00</CreationDate>
    <Deadline></Deadline>
    <ID>10002</ID>
    <Name></Name>
    <Participant>User001</Participant>
    <Priority>0</Priority>
    <ProcessDefinitionID>3001</ProcessDefinitionID>
    <ProcessInstanceID>5002</ProcessInstanceID>
    <ProcessInstanceName>案件20160609103241625</ProcessInstanceName>
    <StartDate>2016-12-09T15:25:22+09:00</StartDate>
    <StateCode>r</StateCode>
    <WorkDefinitionID>3001</WorkDefinitionID>
    <WorkDefinitionName>VerifyCreditHistory_UTask1</WorkDefinitionName>
    <WorkTypeCode>0</WorkTypeCode>
  </WorkItem>
</WorkItems>

レスポンス（JSONの場合）

{
  "WorkItem" : [
    {
      "ActivityInstanceID" : "10001",
      "ClosedDate" : "2016-12-09T15:00:41+09:00",
      "CreationDate" : "2016-12-09T15:00:40+09:00",
      "Deadline" : "",
      "ID" : "10001",
      "Name" : "",
      "Participant" : "User001",
      "Priority" : "0",
      "ProcessDefinitionID" : "3001",
      "ProcessInstanceID" : "5002",
      "ProcessInstanceName" : "案件20160609103241625",
      "StartDate" : "2016-12-09T15:00:41+09:00",
      "StateCode" : "r",
      "WorkDefinitionID" : "3003",
      "WorkDefinitionName" : "QuotationHandling_UTask1",
      "WorkTypeCode" : "0"
    },
    {
      "ActivityInstanceID" : "10002",
      "ClosedDate" : "2016-12-09T15:25:22+09:00",
      "CreationDate" : "2016-12-09T15:00:41+09:00",
      "Deadline" : "",
      "ID" : "10002",
      "Name" : "",
      "Participant" : "User001",
      "Priority" : "0",
      "ProcessDefinitionID" : "3001",
      "ProcessInstanceID" : "5002",
      "ProcessInstanceName" : "案件20160609103241625",
      "StartDate" : "2016-12-09T15:25:22+09:00",
      "StateCode" : "r",
      "WorkDefinitionID" : "3001",
      "WorkDefinitionName" : "VerifyCreditHistory_UTask1",
      "WorkTypeCode" : "0"
    }
  ]
}

ページの先頭へ