ワークフローAPI

説明概要

プロセスの開始/タスクの確認/タスクの処理/モニタリングを操作するワークフローAPIを説明します。
APIによっては、GET/POSTリクエストに対してJSONやXMLをレスポンスします。

ワークフローAPIの種類

プロセス開始API	プロセスの開始を行うAPIです。
タスク確認API	マイタスク/引き受け待ち(オファータスク)情報を取得するAPIです。
タスク処理API	タスク処理を行うAPIです。
モニタリングAPI	プロセス/タスク処理履歴を取得するAPIです。
オープンチャットAPI	オープンチャットに関するAPIです。

プロセス開始API

操作	GET	POST	リクエストURL	レスポンス(JSON)	実行に必要な権限
新規開始できるプロセス一覧を取得する	○	○	<ContextRoot>/API/PE/ProcessModel/listStartable	count、ActivityEntryのリスト	全ログインユーザ
新規プロセスを開始する	-	○	<ContextRoot>/API/PE/ProcessInstance/start	WorkitemEntry	全ログインユーザ

「<ContextRoot>」は、DataSpider BPMのルートURIである「http(s)://<ホスト名>:<ポート番号>/userweb」を意味します。

プロセス開始APIのレスポンス

ActivityEntryの構造

属性	型	説明
id	整数	タスクのID
nodeName	文字列	タスクの名前
nodeNumber	整数	ノード番号
processModelActivateDatetime	日時	アプリのこのバージョンがリリースされた日時
processModelId	整数	アプリのバージョン別のID
processModelInfoCategory	文字列	アプリのカテゴリ名
processModelInfoId	整数	アプリのID バージョンにかぎらず変わりません。
processModelInfoName	文字列	アプリの名前
processModelInfoShortExplanation	文字列	アプリの概要
processModelInfoViewPriority	整数	アプリの表示優先度「0」～「5」
processModelVersion	整数	アプリのバージョン番号

正常応答の例(ActivityEntry)


 {
   "count":1,
   "startableActivities":[
     {
       "id":2086,
       "nodeName":"テストタスク",
       "nodeNumber":3,
       "processModelActivateDatetime":"2010-01-07T18:13:40+0900",
       "processModelId":2081,
       "processModelInfoCategory":"テストカテゴリ",
       "processModelInfoId":11,
       "processModelInfoName":"テストアプリ",
       "processModelInfoShortExplanation":"テスト用アプリです。",
       "processModelInfoViewPriority":5,
       "processModelVersion":1
     }
   ]
 }

WorkitemEntryの構造および正常応答の例に関する詳細は、こちらを参照してください。

プロセス開始API詳細

新規開始できるプロセス一覧を取得する: /API/PE/ProcessModel/listStartable

GET/POST リクエストパラメータ

パラメータ名	必須	説明
start	任意	取得するプロセスの開始位置を指定します。最小値は「0」、最大値は「2147483647」です。指定しなかった場合は、「0」が指定されたものとみなされます。例: 検索結果の全件が「100」、startに「10」、limitに「50」を指定した場合は、100件のうち11件目から60件目を取得します。
limit	任意	取得するプロセスの最大件数を指定します。最小値は「0」、最大値は「1000」です。指定しなかった場合は、「1」が指定されたものとみなされます。
category	任意	取得するプロセスのカテゴリを指定します。
query	任意	取得するプロセスのアプリ名を指定します。値が指定された場合、その値がアプリ名の一部に含まれているプロセスを検索します。

レスポンス

limitおよびstartで絞り込んだ取得件数ではありません。

startableActivities: 開始可能なプロセスの ActivityEntryのリスト

発生する可能性のあるエラー

InvalidStart: 10012
InvalidLimit: 10013

新規プロセスを開始する: /API/PE/ProcessInstance/start

POST リクエストパラメータ

パラメータ名	必須	説明
activityId	任意	対象プロセスの先頭タスクのID ActivityEntryのid属性の値
processModelInfoId	必須	アプリのID
nodeNumber	必須	タスクのノード番号

レスポンス

workitem: 開始されたプロセスの先頭タスクを表す WorkitemEntry

発生する可能性のあるエラー

InvalidActivityId: 10011
InvalidProcessModelInfoId: 10017
InvalidNodeNumber: 10018
ActivityDoesNotExistException: 20012
InstanceNumberExceeding: 30004
UserNumberExceeding: 30005
OverQuota: 30007
Forbidden: HTTP 403

タスク確認API

操作	GET	POST	リクエストURL	レスポンス(JSON)	実行に必要な権限
マイタスクの一覧を取得する	○	○	<ContextRoot>/API/PE/Workitem/listAllocated	count、WorkitemEntryのリスト	全ログインユーザ
引き受け待ち(オファータスク)の一覧を取得する	○	○	<ContextRoot>/API/PE/Workitem/listOffered	count、WorkitemEntryのリスト	全ログインユーザ
引き受け待ち(オファータスク)を引き受ける	-	○	<ContextRoot>/API/PE/Workitem/batchAccept	Resultのリスト	全ログインユーザ

「<ContextRoot>」は、DataSpider BPMのルートURIである「http(s)://<ホスト名>:<ポート番号>/userweb」を意味します。

タスク確認APIのレスポンス

WorkitemEntryの構造

属性	型	説明
id	整数	タスクのインスタンスID
allocateDatetime	日時	タスクが割り当てられた日時
allocatedQuserId	整数	タスクが割り当てられたユーザのID
allocatedQuserName	文字列	タスクが割り当てられたユーザの名前
allocatedQgroupId	整数	タスクが割り当てられた組織のID
allocatedQgroupName	文字列	タスクが割り当てられた組織の名前
endDatetime	日時	タスクの処理が終了した日時
nodeName	文字列	タスクの名前
nodeNumber	整数	タスクのノード番号
offerDatetime	日時	タスクがオファーされた日時
processInstanceEndDatetime	日時	プロセスが終了した日時
processInstanceIdForView	文字列	プロセスのIDの表示用文字列表記
processInstanceId	整数	プロセスのID
processInstanceSequenceNumber	整数	プロセス連番
processInstanceInitQgroupId	整数	プロセスを開始した組織のID
processInstanceInitQgroupName	文字列	プロセスを開始した組織の名前
processInstanceInitQuserId	整数	プロセスを開始したユーザのID
processInstanceInitQuserName	文字列	プロセスを開始したユーザの名前
processInstanceStartDatetime	日時	プロセスを開始した日時
processInstanceState	文字列	プロセスの状態
processInstanceDebug	boolean	デバッグモードかどうか(true: デバッグモード、false: 通常モード)
processInstanceTitle	文字列	プロセスの件名
processModelInfoId	整数	アプリのID
processModelInfoName	文字列	アプリの名前
processModelInfoCategory	文字列	アプリのカテゴリ
processModelVersion	整数	アプリのバージョン
startDatetime	日時	タスクを開始した日時
state	文字列	タスクの状態
failType	文字列	タスクのエラー分類
swimlaneType	文字列	タスクを配置しているスイムレーンの種別
timeLimitDatetime	日時	タスクの締め切り日時
starred	boolean	スターの有無(true: スター有、false: スター無)
read	boolean	既読の有無(true: 既読、false: 未読)
data	ProcessDataEntry	データを格納したオブジェクトモニタリングAPIでのみ有効となります。

正常応答の例(WorkitemEntry)


 {
   "workitem":{
     "allocateDatetime":"2010-08-18T14:03:18+0900",
     "allocatedQgroupId":null,
     "allocatedQgroupName":null,
     "allocatedQuserId":0,
     "allocatedQuserName":"佐藤",
     "offerDatetime":null,
     "data":null,
     "endDatetime":null,
     "failType":null,
     "id":58399,
     "nodeName":"Activity1",
     "nodeNumber":0,
     "processInstanceEndDatetime":null,
     "processInstanceId":825,
     "processInstanceIdForView":"p825",
     "processInstanceInitQgroupId":null,
     "processInstanceInitQgroupName":null,
     "processInstanceInitQuserId":0,
     "processInstanceInitQuserName":"佐藤",
     "processInstanceSequenceNumber":1,
     "processInstanceStartDatetime":"2010-08-18T14:03:16+0900",
     "processInstanceState":"STARTED",
     "processInstanceDebug":false,
     "processInstanceTitle":null,
     "processModelInfoCategory":"テストカテゴリ",
     "processModelInfoId":9,
     "processModelInfoName":"テストプロセス",
     "processModelVersion":4,
     "read":false,
     "starred":true,
     "startDatetime":null,
     "state":"ALLOCATED",
     "swimlaneType":"NORMAL",
     "timeLimitDatetime":null
   }
 }

Resultの構造

属性	型	説明
success	boolean	タスクの引き受けに成功したか失敗したか。成功はtrue。
workitemId	整数	対象タスクのID
workitem	WorkitemEntry	対象タスクの情報を格納したオブジェクト引き受けに失敗した場合、このオブジェクトがない場合もあります。
error	ErrorEntry	エラー応答のオブジェクト引き受けに失敗した場合のみ。

正常応答の例(Result)


 {
   "results":[
     {
       "success":true,
       "workitemId":58399,
       "workitem":{
         "id":58399,
         "offerDatetime":"2010-08-18T14:03:17+0900",
         "nodeName":"Activity1",
         "nodeNumber":0,
         "processInstanceId":825,
         "processInstanceIdForView":"p825",
         "processInstanceInitQgroupId":1,
         "processInstanceInitQgroupName":"全社",
         "processInstanceInitQuserId":0,
         "processInstanceInitQuserName":"佐藤",
         "processInstanceStartDatetime":"2010-08-18T14:03:16+0900",
         "processInstanceState":"STARTED",
         "processInstanceDebug":false,
         "processInstanceTitle":"",
         "processModelInfoId":9,
         "processModelInfoName":"テストプロセス",
         "processModelVersion":4,
         "startDatetime":null,
         "state":"ALLOCATED",
         "swimlaneType":"NORMAL"
       },
       {
       "success":false,
       "workitemId":58400,
       "error":{
         "errorCode":"40003",
         "type":"WorkitemDoesNotExist"
       }
     }
   ]
 }

ProcessInstanceEntryの構造および正常応答の例に関する詳細は、こちらを参照してください。

タスク確認API詳細

マイタスクの一覧を取得する: /API/PE/Workitem/listAllocated

GET/POST リクエストパラメータ

なし

レスポンス

workitems: マイタスクにある WorkitemEntryのリスト

発生する可能性のあるエラー

なし

引き受け待ち(オファータスク)の一覧を取得する: /API/PE/Workitem/listOffered

GET/POST リクエストパラメータ

なし

レスポンス

workitems: 引き受け待ち(オファータスク)にある WorkitemEntryのリスト

発生する可能性のあるエラー

なし

引き受け待ち(オファータスク)を引き受ける: /API/PE/Workitem/batchAccept

POST リクエストパラメータ

パラメータ名	必須	説明
workitemIds	必須	対象タスクのID WorkitemEntryのid属性の値。複数のタスクをまとめて引き受けることが可能です。その場合は、タスクの数だけパラメータとタスクのIDを指定してください。

レスポンス

results: 引き受けに成功したか失敗したかを格納した Resultのリスト

発生する可能性のあるエラー

InvalidId: 10001
NeedToAcceptOtherWorkitems: 40000
WorkitemIsNotOffered: 40001
WorkitemStatusAlreadyChanged: 40002
WorkitemDoesNotExist: 40003

タスク処理API

操作	GET	POST	リクエストURL	レスポンス(XML)	実行に必要な権限
入力フォーム情報を取得する	○	○	<ContextRoot>/API/PE/Workitem/Form/viewXml	XML: workitem-form	全ログインユーザ
タスクを実行する	-	○	<ContextRoot>/API/PE/Workitem/Form/save	XML: result	全ログインユーザ

「<ContextRoot>」は、DataSpider BPMのルートURIである「http(s)://<ホスト名>:<ポート番号>/userweb」を意味します。

タスク処理APIのレスポンス

XML: workitem-formの構造

要素名/属性名(XPath式)	型	説明
/workitem-form		応答XMLのルート要素
title	文字列	件名の値
title-accessibility	整数	件名のデータ編集許可設定編集可:「3」、表示のみ:「1」
title-description	文字列	件名に関する説明入力フォームに付与されるメッセージです。
title-columns	整数	件名の段組み設定
form-data		タイトル以外のデータ項目
form-data/@number	整数	データ項目番号
form-data/@id	整数	データ項目の定義ID
form-data/accessibility	整数	データ項目のデータ編集許可設定編集可:「3」、表示のみ:「1」、なし:「0」
form-data/data-type	整数	データ項目のデータ型文字型:「0」、日付型:「5」、ユーザ型:「8」、掲示板型:「9」日時型:「10」、選択型:「11」、数値型:「12」、テーブル型:「13」ファイル型:「14」、ガイドパネル:「15」、組織型:「16」
form-data/form-type	整数	入力フォームの形式テキストフィールド:「0」、テキストエリア:「1」、ラジオボタン:「2」チェックボックス:「3」、セレクトボックス:「4」、検索セレクトボックス:「5」
form-data/sub-type	整数	日付型の入力形式年月日:「0」、年月:「1」、月日:「2」、年:「3」
form-data/name	文字列	データ項目の名前
form-data/data-instance-id	整数	データ項目のID
form-data/process-instance-id	整数	プロセスのID
form-data/view-order	整数	データ項目の表示順
form-data/description	文字列	データ項目に関する説明入力フォームに付与されるメッセージです。
form-data/columns	整数	データ項目の段組み設定
form-data/required	boolean	データ項目が必須かどうか
form-data/button-direction	整数	チェックボックス・ラジオボタンで、ボタンを配置する方向横:「1」、縦:「2」選択型データ項目でのみ使用します。
form-data/button-rows	整数	1行または1列に配置するボタンの数選択型データ項目でのみ使用します。
form-data/items		選択肢の情報選択型データ項目でのみ使用します。
form-data/items/process-data-definition-detail:item		各選択肢の情報選択型データ項目でのみ使用します。
form-data/items/process-data-definition-detail:item/process-data-definition-detail:value	文字列	選択肢ID 選択型データ項目でのみ使用します。
form-data/items/process-data-definition-detail:item/process-data-definition-detail:display	文字列	選択肢の表示ラベル選択型データ項目でのみ使用します。
form-data/process-data-definition-detail:string-detail		文字型に関する定義の詳細詳細は、「文字型データ項目で含まれる設定」を参照してください。文字型データ項目でのみ使用します。
form-data/process-data-definition-detail:decimal-detail		数値型に関する定義の詳細詳細は、「数値型データ項目で含まれる設定」を参照してください。数値型データ項目でのみ使用します。
form-data/process-data-definition-detail:list-detail		テーブル型に関する定義の詳細詳細は、「テーブル型データ項目で含まれる設定」を参照してください。テーブル型データ項目でのみ使用します。
form-data/value	文字列	データの値出力のフォーマットは各データ型により異なります。各データ型の値が空の場合は、この要素は返されません。
node-number	整数	タスクのノード番号
task-name	文字列	タスクの名前
swimlane-type	整数	ノーマルタスクか、チームタスクかを判別ノーマルタスク:「0」、チームタスク:「1」
user-selects		ユーザ選択分岐に関する設定
user-selects/user-select		ユーザ選択分岐の1つのボタンに相当
user-selects/user-select/flow-id	整数	ボタンを選択した場合にトークンがたどるフローのID
user-selects/user-select/name	文字列	ボタンに表示するテキスト
executing-roles		タスク処理時の立場の選択が必要な場合の情報必要がない場合、1つに特定されている場合には含まれません。
executing-roles/executing-role		選択可能な各立場
executing-roles/executing-role/quser-id	整数	ユーザのID
executing-roles/executing-role/quser-name	文字列	ユーザの名前
executing-roles/executing-role/qgroup-id	整数	選択可能な立場、組織のID
executing-roles/executing-role/qgroup-name	文字列	選択可能な立場、組織の名前
qgroup-id	整数	選択されている組織のID
workitem-id	整数	タスクのID

文字型データ項目で含まれる設定(XML: workitem-form)

要素名/属性名(XPath式)	型	説明
process-data-definition:string-detail		文字型データ項目に関する設定
required	boolean	必須かどうか /workitem-form/form-data/requiredと同じです。
regex	文字列	正規表現式
textarea-rows	整数	複数行タイプの場合に、何行入力フォームを表示させるかの指定

数値型データ項目で含まれる設定(XML: workitem-form)

要素名/属性名(XPath式)	型	説明
process-data-definition:decimal-detail		数値型データ項目に関する設定
required	boolean	必須かどうか /workitem-form/form-data/requiredと同じです。
prefix	文字列	接頭辞
suffix	文字列	接尾辞
minimum	文字列	最小値
maximum	文字列	最大値
operation	文字列	テーブル型項目内の数値型項目にて使用ここでは使用しません。
summary	文字列	テーブル型項目内の数値型項目にて使用ここでは使用しません。
decimal-separator	文字列	小数点
grouping-separator	文字列	桁区切り文字
ref-summary	boolean	演算結果の表示項目かどうか四則演算式が入力されている項目の場合:「true」テーブル型データ項目内の数値型にて、[ふたつの項目の積が入る]の場合:「true」通常の入力可能な項目の場合:「false」
scale	整数	小数点以下の桁数

テーブル型データ項目で含まれる設定(XML: workitem-form)

要素名/属性名(XPath式)	型	説明
process-data-definition:list-detail		テーブル型データ項目に関する設定
sub-data-defs		テーブル内のデータ項目に関する定義
sub-data-defs/sub-data-def		テーブル内の各データ項目
sub-data-defs/sub-data-def/name	文字列	項目の名前
sub-data-defs/sub-data-def/data-type	整数	データ項目の型文字型:「0」、選択型:「11」、数値型:「12」
sub-data-defs/sub-data-def/string-detail		文字型に関する定義の詳細詳細は、「文字型データ項目で含まれる設定」を参照してください。
sub-data-defs/sub-data-def/decimal-detail		数値型に関する定義の詳細詳細は、「数値型データ項目で含まれる設定」参照してください。

正常応答の例(XML: workitem-form)


 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <workitem-form xmlns:ns2="process-data-definition-detail">
     <title-accessibility>3</title-accessibility>
     <title-description><font color="red">タイトルは必須入力です</font></title-description>
     <title-columns>1</title-columns>
     <form-data number="4" id="56213">
         <accessibility>3</accessibility>
         <data-type>12</data-type>
         <name>数値型</name>
         <data-instance-id>75774</data-instance-id>
         <process-instance-id>845</process-instance-id>
         <view-order>5</view-order>
         <ns2:decimal-detail>
             <ns2:required>false</ns2:required>
             <ns2:prefix>＄</ns2:prefix>
             <ns2:suffix>ユーロ</ns2:suffix>
             <ns2:minimum>100.00</ns2:minimum>
             <ns2:maximum>200.00</ns2:maximum>
             <ns2:operation></ns2:operation>
             <ns2:summary></ns2:summary>
             <ns2:decimal-separator>.</ns2:decimal-separator>
             <ns2:grouping-separator>,</ns2:grouping-separator>
             <ns2:ref-summary>false</ns2:ref-summary>
             <ns2:scale>10</ns2:scale>
         </ns2:decimal-detail>
         <description>値は 100.0000000000 以上 200.0000000000 以下にしてください。</description>
         <columns>1</columns>
         <required>false</required>
     </form-data>
     <node-number>0</node-number>
     <task-name>入力</task-name>
     <user-selects />
     <workitem-id>75778</workitem-id>
 </workitem-form>

XML: resultの構造

要素名/属性名(XPath式)	型	説明
/result		応答のルート要素
@success	boolean	タスクの処理に成功したか失敗したかを判別成功:「true」、失敗:「false」
process-data-validation-errors		データの入力チェックに失敗した場合に含まれます。
process-data-validation-errors/error		各エラー
process-data-validation-errors/error/key	文字列	どの入力でエラーが発生したかを表すキーパラメータ名に対応しています。
process-data-validation-errors/error/detail	文字列	エラーメッセージ
errors		データの入力チェック以外が原因で失敗した場合に含まれます。
errors/error		各エラー
errors/error/key	文字列	エラーの種類を表すキー
errors/error/detail	文字列	エラーメッセージ

成功時応答の例(XML: result)


 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <result success="true" />

失敗時応答の例(XML: result)


 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <result success="false">
     <process-data-validation-errors>
         <error>
             <key>data[4].input</key>
             <detail>値は 100.0000000000 以上にしてください。</detail>
         </error>
     </process-data-validation-errors>
 </result>

タスク処理API詳細

入力フォーム情報を取得する: /API/PE/Workitem/Form/viewXml

GET/POST リクエストパラメータ

パラメータ名	必須	説明
workitemId	必須	対象タスクのID

レスポンス

XML: workitem-form: 指定したタスクの入力フォーム情報を保持する XMLファイル

発生する可能性のあるエラー

なし

タスクを実行する: /API/PE/Workitem/Form/save

POST リクエストパラメータ

パラメータ名	必須	説明
workitemId	必須	対象タスクのID
title	任意	件名
データ項目ごとのパラメータ	任意	パラメータ名や指定する値は、メッセージ開始イベント(HTTP)およびメッセージ受信中間イベント(HTTP)と同じになります。メッセージ開始・受信中間イベント(HTTP)に関する詳細は、「メッセージ開始・受信中間イベント(HTTP)」を参照してください。
qgroupId	任意	組織のID タスクを実行する際の立場を指定する必要がある場合に、どの立場で実行するのかを指定します。立場の候補は、フォーム情報の取得APIによって取得する応答XMLの「/workitem-form/executing-roles」内に保持されています。指定する必要がない場合は、送信する必要はありません。
flow	任意	フローのID ユーザ選択分岐の場合、いずれのフローを選択するのかを指定します。フローの候補は、フォーム情報の取得APIによって取得する応答XMLの「/workitem-form/user-selects」内に保持されています。ユーザ選択分岐ではない場合は、送信する必要はありません。
saveOnly	任意	値を保存するだけでタスクを終了しない場合は、「true」を指定します。タスクを終了する場合は、「false」を指定するか、パラメータを指定しません。「true」を指定した場合は、qgroupIdの指定が必要な場合においても未設定で保存することができます。

レスポンス

XML: result: 実行結果を返す XMLファイル

発生する可能性のあるエラー

入力フォームに定義されている各入力条件

モニタリングAPI

操作	GET	POST	リクエストURL	レスポンス(JSON)	実行に必要な権限
タスク処理履歴を検索する	○	○	<ContextRoot>/API/OR/Workitem/list	count、WorkitemEntryのリスト	全ログインユーザ
タスク処理履歴を検索する(CSVファイル取得: UTF-8)	○	○	<ContextRoot>/API/OR/Workitem/listCsv	CSVファイル: UTF-8	全ログインユーザ
タスク処理履歴を検索する(CSVファイル取得: UTF-16)	○	○	<ContextRoot>/API/OR/Workitem/listCsvUtf16	CSVファイル: UTF-16	全ログインユーザ
すべてのプロセス履歴を検索する	○	○	<ContextRoot>/API/OR/ProcessInstance/list	count、ProcessInstanceEntryのリスト	全ログインユーザ
すべてのプロセス履歴を検索する(CSVファイル取得: UTF-8)	○	○	<ContextRoot>/API/OR/ProcessInstance/listCsv	CSVファイル: UTF-8	全ログインユーザ
すべてのプロセス履歴を検索する(CSVファイル取得: UTF-16)	○	○	<ContextRoot>/API/OR/ProcessInstance/listCsvUtf16	CSVファイル: UTF-16	全ログインユーザ
プロセスの詳細情報を取得する	○	○	<ContextRoot>/API/OR/ProcessInstance/view	ProcessInstanceEntry	全ログインユーザ
ファイル型データ項目を取得する	○	○	<ContextRoot>/API/OR/ProcessInstance/File/download	ファイル	全ログインユーザ
プロセスにスターを追加する	-	○	<ContextRoot>/API/OR/ProcessInstance/<processInstanceId>/Star/add	なし	全ログインユーザ
プロセスからスターを削除する	-	○	<ContextRoot>/API/OR/ProcessInstance/<processInstanceId>/Star/remove	なし	全ログインユーザ
タスクを強制割当する	-	○	<ContextRoot>/API/PIM/Workitem/reallocate	WorkitemEntry	コントロール権限
プロセスを強制終了する	-	○	<ContextRoot>/API/OR/ProcessInstance/stop	なし	全ログインユーザ
プロセスを削除する	-	○	<ContextRoot>/API/OR/ProcessInstance/delete	なし	全ログインユーザ

「<ContextRoot>」は、DataSpider BPMのルートURIである「http(s)://<ホスト名>:<ポート番号>/userweb」を意味します。

モニタリングAPIのレスポンス

ProcessInstanceEntryの構造

属性	型	説明
processInstanceId	整数	プロセスのID
processInstanceIdForView	文字列	プロセスのIDの表示用文字列表記
processInstanceSequenceNumber	整数	プロセス連番
processInstanceInitQgroupId	整数	プロセスを開始した組織のID
processInstanceInitQgroupName	文字列	プロセスを開始した組織の名前
processInstanceInitQuserId	整数	プロセスを開始したユーザのID
processInstanceInitQuserName	文字列	プロセスを開始したユーザの名前
processInstanceStartDatetime	日時	プロセスを開始した日時
processInstanceEndDatetime	日時	プロセスが終了した日時
processInstanceState	文字列	プロセスの状態
processInstanceDebug	boolean	デバッグモードかどうか(true: デバッグモード、false: 通常モード)
processInstanceTitle	文字列	プロセスの件名
processModelInfoId	整数	アプリのID
processModelInfoName	文字列	アプリの名前
processModelInfoCategory	文字列	アプリのカテゴリ
processModelVersion	整数	アプリのバージョン
activeTokenNodeName	文字列	トークンがあるノードの名称
starred	boolean	スターの有無(true: スター有、false: スター無)
data	ProcessDataEntry	データを格納したオブジェクト

ProcessDataEntryの構造

属性	型	説明
id	整数	データ項目のID
processDataDefinitionNumber	整数	データ項目番号
name	文字列	データ項目の名称
dataType	文字列	データ項目の型
subType	文字列	フォームタイプ(データサブタイプ)の型特定のデータ型のみで使用します。
value	文字列	値データ型によっては、各オブジェクトの型になります。
viewOrder	整数	表示順

正常応答の例(ProcessInstanceEntry)


 {
   "count":4,
   "processInstances":[
     {"processInstanceId":1319,
      "data":
       {"1":{
         "name":"選択",
         "dataType":"SELECT",
         "id":560709,
         "processDataDefinitionNumber":1,
         "subType":null,
         "value":[
           {"display":"選択肢２",
            "value":"選択肢２"}
         ],
         "viewOrder":3
        },
        "0":{
         "name":"文字",
         "dataType":"STRING",
         "id":560708,
         "processDataDefinitionNumber":0,
         "subType":null,
         "value":"選択肢１¥n選択肢２",
         "viewOrder":1
        }
       },
      ...
     },
     {"processInstanceId":1284,
      "data":
       {"1":{
         "name":"選択",
         "dataType":"SELECT",
         "id":542679,
         "processDataDefinitionNumber":1,
         "subType":null,
         "value":null,
         "viewOrder":3
        },
        "0":{
         "name":"文字",
         "dataType":"STRING",
         "id":542678,
         "processDataDefinitionNumber":0,
         "subType":null,
         "value":"選択肢１¥n選択肢２¥n選択肢３",
         "viewOrder":1
        }
       },
      ...
     }
   ]
 }

WorkitemEntryの構造および正常応答の例に関する詳細は、こちらを参照してください。

モニタリングAPI詳細

タスク処理履歴を検索する: /API/OR/Workitem/list

タスク処理履歴を検索する(CSVファイル取得: UTF-8): /API/OR/Workitem/listCsv

タスク処理履歴を検索する(CSVファイル取得: UTF-16): /API/OR/Workitem/listCsvUtf16

GET/POST リクエストパラメータ

パラメータ名	必須	説明
criteria	任意	検索条件を指定します。検索条件は、XML形式またはJSON形式で指定することができます。指定しない場合は、権限を保持している全アプリの全タスクが対象になります。検索条件にXML形式を指定する場合は、こちらを参照してください。検索条件にJSON形式を指定する場合は、こちらを参照してください。
reportId	任意	[このリストに名前をつけて保存]で保存した検索条件のレポートIDで指定します。レポートIDは、保存した検索条件を開いた際に、ブラウザに表示されるURLの[reportId]パラメータの値を使用してください。
limit	任意	取得するタスクの最大件数を指定します。最小値は「0」、最大値は「1000」です。指定しなかった場合は、「1」が指定されたものとみなされます。
start	任意	取得するタスクの開始位置を指定します。最小値は「0」、最大値は「2147483647」です。指定しなかった場合は、「0」が指定されたものとみなされます。例: 検索結果の全件が「100」、startに「10」、limitに「50」を指定した場合は、100件のうち11件目から60件目を取得します。

タスク検索条件:XML形式の構造

要素名/属性名(XPath式)	型	説明
/workitem-criteria		検索条件XMLのルート要素
process-model-info-id	整数	アプリのID 権限を保持している全アプリを検索対象とする場合は、指定しないでください。
states		対象プロセスの状態を指定します。指定しない場合は、すべての状態のプロセスが検索対象となります。
states/state	文字列	対象プロセスの状態を、以下から指定します。複数の状態を検索対象とする場合は、その数だけ要素を並べます。 STARTED: 未終了のプロセス ENDED: 正常終了したプロセス FAILED: 異常終了(強制終了)したプロセス
process-instance-id	整数	プロセスのID 指定した場合は、指定されたプロセスIDを保持したプロセスを検索します。
title	文字列	件名指定した場合は、値が件名の一部に含まれているプロセスを検索します。 title要素を複数指定することにより、AND条件での絞り込み条件を増やすことができます。
start-date-from	文字列	プロセスを開始した日時(from) 指定した場合は、指定された日時以降に開始されたプロセスを検索します(指定日時も含む)。
start-date-to	文字列	プロセスを開始した日時(to) 指定した場合は、指定された日時以前に開始されたプロセスを検索します(指定日時も含む)。
end-date-from	文字列	プロセスが終了した日時(from) 指定した場合は、指定された日時以降に終了したプロセスを検索します(指定日時も含む)。
end-date-to	文字列	プロセスが終了した日時(to) 指定した場合は、指定された日時以前に終了したプロセスを検索します(指定日時も含む)。
init-quser-id	文字列	ユーザのIDまたは自分自身(「#me」) 指定した場合は、プロセスの開始ユーザが指定したユーザまたは自分自身であるプロセスを検索します。
init-qgroup-id	整数	組織のID 指定した場合は、プロセスの開始組織が指定した組織であるプロセスを検索します。
node-number	整数	タスクのノード番号指定した場合は、合致するノード番号を持つタスクを検索します。
workitem-states		対象タスクの状態を指定します。指定しない場合は、すべての状態のタスクが検索対象となります。
workitem-states/workitem-state	文字列	対象タスクの状態を、以下から指定します。複数の状態を検索対象とする場合は、その数だけ要素を並べます。 OFFERED: 引き受け待ちのタスク ALLOCATED: 未処理のタスク STARTED: 処理中のタスク ENDED: 処理完了のタスク FAILED: エラー終了のタスク
workitem-allocated-quser-id	文字列	ユーザのIDまたは自分自身(「#me」) 指定した場合は、処理担当者が指定したユーザまたは自分自身であるタスクを検索します。
workitem-offer-date-from	文字列	タスクをオファーした日時(from) 指定した場合は、指定された日時以降にオファーされたタスクを検索します(指定日時も含む)。
workitem-offer-date-to	文字列	タスクをオファーした日時(to) 指定した場合は、指定された日時以前にオファーされたタスクを検索します(指定日時も含む)。
workitem-end-date-from	文字列	タスクが完了した日時(from) 指定した場合は、指定された日時以降に完了したタスクを検索します(指定日時も含む)。
workitem-end-date-to	文字列	タスクが完了した日時(to) 指定した場合は、指定された日時以前に完了したタスクを検索します(指定日時も含む)。
workitem-time-limit-from	文字列	タスクの締切日時(from) 指定した場合は、指定された日時以降に締切となるタスクを検索します(指定日時も含む)。
workitem-time-limit-to	文字列	タスクの締切日時(to) 指定した場合は、指定された日時以前に締切となるタスクを検索します(指定日時も含む)。
sort-property	文字列	検索結果をソートする際のキー指定しない場合は、「offerDatetime」が指定されたものとみなされます。 offerDatetime: タスクのオファー日時でソートします。 endDatetime: タスクの完了日時でソートします。 timeLimitDatetime: タスクの締め切り日時でソートします。 allocatedQuserId: 割り当てられたユーザのIDでソートします。 nodeName: タスクの名前でソートします。
sort-direction	文字列	ソートの順序指定しない場合は、「DESC」が指定されたものとみなされます。 ASC: 昇順でソートします。 DESC: 降順でソートします。
data		データ項目を検索条件や結果取得対象に含めるかどうかここで指定されたデータ項目のみ、検索結果に含まれます。
data/*/data-definition-number	整数	データ項目番号検索対象や結果取得対象にするデータ項目のデータ項目番号を指定します。「*」部分は、対象のデータ型によって異なります。
data/*/value	文字列	検索に使用する値「*」部分は、対象のデータ型によって異なります。
data/string		文字型のデータ項目を検索や結果取得対象に含める場合
data/string/empty		「値が入力されていない」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定は必要ありません。
data/string/not-empty		「値が入力されている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定は必要ありません。
data/string/contains		「値に含まれている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/discussion		掲示板型のデータ項目を検索や結果取得対象に含める場合
data/discussion/empty		「値が入力されていない」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定は必要ありません。
data/discussion/not-empty		「値が入力されている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定は必要ありません。
data/discussion/contains		「値に含まれている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/decimal		数値型のデータ項目を検索や結果取得対象に含める場合
data/decimal/equals		「等しい」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/decimal/greater-equals		「以上」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/decimal/less-equals		「以下」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/date		日付型のデータ項目を検索や結果取得対象に含める場合
data/date/equals		「等しい」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/date/after-equals		「以降」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/date/before-equals		「以前」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/datetime		日時型のデータ項目を検索や結果取得対象に含める場合
data/datetime/equals		「等しい」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/datetime/after-equals		「以降」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/datetime/before-equals		「以前」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/select		選択型のデータ項目を検索や結果取得対象に含める場合
data/select/selected		「選択されている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/file		ファイル型のデータ項目を検索や結果取得対象に含める場合
data/file/contains		「ファイル名に含まれている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/quser		ユーザ型のデータ項目を検索や結果取得対象に含める場合
data/quser/equals		「等しい」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/qgroup		組織型のデータ項目を検索や結果取得対象に含める場合
data/qgroup/equals		「等しい」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/table		テーブル型のデータ項目を結果取得対象に含める場合検索条件には指定できません。
data/*/view		指定したデータ項目において検索条件は指定せず、結果取得対象にする場合「*」の部分は、対象のデータ型によって異なります。

タスク検索条件:JSON形式の構造

キー	型	説明
processModelInfoId	整数	アプリのID 権限を保持している全アプリを検索対象とする場合は、指定しないか「-1」を指定してください。
processInstanceState	文字列(配列)	対象プロセスの状態を、以下から指定します。複数の状態を検索対象とする場合は、その数だけ配列指定します。 STARTED: 未終了のプロセス ENDED: 正常終了したプロセス FAILED: 異常終了(強制終了)したプロセス
processInstanceId	整数	プロセスのID 指定した場合は、指定されたプロセスIDを保持したプロセスを検索します。
processInstanceTitle	文字列(配列)	件名指定した場合は、値が件名の一部に含まれているプロセスを検索します。複数のタイトルを配列指定することにより、AND条件での絞り込み条件を増やすことができます。
processInstanceStartDateFrom	文字列	プロセスを開始した日時(from) 指定した場合は、指定された日時以降に開始されたプロセスを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。
processInstanceStartDateTo	文字列	プロセスを開始した日時(to) 指定した場合は、指定された日時以前に開始されたプロセスを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。
processInstanceEndDateFrom	文字列	プロセスが終了した日時(from) 指定した場合は、指定された日時以降に終了したプロセスを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。実行中のプロセスは含まれません。
processInstanceEndDateTo	文字列	プロセスが終了した日時(to) 指定した場合は、指定された日時以前に終了したプロセスを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。実行中のプロセスは含まれません。
processInstanceInitQuserId	文字列	ユーザのIDまたは自分自身(「#me」) 指定した場合は、プロセスの開始ユーザが指定したユーザまたは自分自身であるプロセスを検索します。
processInstanceInitQgroupId	文字列	組織のID 指定した場合は、プロセスの開始組織が指定した組織であるプロセスを検索します。
nodeNumber	整数	タスクのノード番号指定した場合は、合致するノード番号を持つタスクを検索します。
state	文字列(配列)	対象タスクの状態を、以下から指定します。複数の状態を検索対象とする場合は、その数だけ配列指定します。 OFFERED: 引き受け待ちのタスク ALLOCATED: 未処理のタスク STARTED: 処理中のタスク ENDED: 処理完了のタスク FAILED: エラー終了のタスク
allocatedQuserId	文字列	ユーザのIDまたは自分自身(「#me」) 指定した場合は、処理担当者が指定したユーザまたは自分自身であるタスクを検索します。
offerDateFrom	文字列	タスクをオファーした日時(from) 指定した場合は、指定された日時以降にオファーされたタスクを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。
offerDateTo	文字列	タスクをオファーした日時(to) 指定した場合は、指定された日時以前にオファーされたタスクを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。
endDateFrom	文字列	タスクが完了した日時(from) 指定した場合は、指定された日時以降に完了したタスクを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。
endDateTo	文字列	タスクが完了した日時(to) 指定した場合は、指定された日時以前に完了したタスクを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。
timeLimitDateFrom	文字列	タスクの締切日時(from) 指定した場合は、指定された日時以降に締切となるタスクを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。
timeLimitDateTo	文字列	タスクの締切日時(to) 指定した場合は、指定された日時以前に締切となるタスクを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。
starred	boolean	スターが付与されている状態を、以下から指定します。 true: スターあり false: スターなし
data	オブジェクト(配列)	データ項目に保持されている値で検索する場合に、各データ項目ごとに指定します。複数のデータ項目を指定する場合は、配列指定してください。例) {"type": "decimal", "number": 0, "method":"less-equals","value":"10"} 各データ項目に指定するkeyは、data[].xxxで説明しています。テーブル型データ項目は指定することができません。
data[].type	文字列	データ項目のデータ型を指定します。検索条件:JSON形式で指定するデータ項目に関する詳細は、こちらを参照してください。
data[].number	整数	データ項目のデータ項目番号を指定します。
data[].method	文字列	データ項目の値の判定条件を指定します。検索条件:JSON形式で指定するデータ項目に関する詳細は、こちらを参照してください。
data[].value	文字列	データ項目の判定値を指定します。検索条件:JSON形式で指定するデータ項目に関する詳細は、こちらを参照してください。
fields	オブジェクト(配列)	検索結果として出力したいデータ項目を指定します。複数のデータ項目を指定する場合は、配列指定してください。例) {"type": "decimal", "number": 0} 各データ項目に指定するkeyは、fields[].xxxで説明しています。出力対象のデータ項目を指定するため、特定のアプリを検索する場合のみ有効となります。
fields[].type	文字列	データ項目のデータ型を指定します。検索条件:JSON形式で指定するデータ項目に関する詳細は、こちらを参照してください。
fields[].number	整数	データ項目のデータ項目番号を指定します。
sortProperty	文字列	検索結果をソートする際のキーを、以下から指定します。指定しない場合は、「offerDatetime」が指定されたものとみなされます。 processInstanceTitle: プロセスのタイトルでソートします。 processInstanceStartDatetime: プロセスの開始日時でソートします。 processInstanceEndDatetime: プロセスの終了日時でソートします。 offerDatetime: タスクのオファー日時でソートします。 endDatetime: タスクの完了日時でソートします。 timeLimitDatetime: タスクの締め切り日時でソートします。 allocatedQuserId: 割り当てられたユーザのIDでソートします。 nodeName: タスクの名前でソートします。
sortDirection	文字列	ソートの順序を、以下から指定します。指定しない場合は、「DESC」が指定されたものとみなされます。 ASC: 昇順でソートします。 DESC: 降順でソートします。

タスク検索条件:JSON形式のデータ項目指定

データ型	type に指定する値	method に指定する値	説明
文字型	string	empty	値が入力されていない
		not-empty	値が入力されている
		contains	valueで指定された文字列を含む
数値型	decimal	equals	valueで指定された数値と等しい
		greater-equals	valueで指定された数値以上
		less-equals	valueで指定された数値以下
選択型	select	selected	valueで指定された選択肢IDと等しい
日付型	date	equals	valueで指定された日付と等しい
		after-equals	valueで指定された日付以降
		before-equals	valueで指定された日付以前
日時型	datetime	equals	valueで指定された日時と等しい
		after-equals	valueで指定された日時以降
		before-equals	valueで指定された日時以前
ファイル型	file	contains	valueで指定された文字列をファイル名に含む
ユーザ型	quser	equals	valueで指定されたユーザIDと等しい
組織型	qgroup	equals	valueで指定された組織IDと等しい
テーブル型	list	-	fieldsのみで使用できるため、methodの指定はありません。
掲示板型	discussion	empty	値が入力されていない
		not-empty	値が入力されている
		contains	valueで指定された文字列を含む

タスク検索条件の例

検索条件を指定したタスク検索条件の例です。

アプリIDが「33」
プロセス開始日時が「2013-01-01」以降
タスクのノード番号が「0」
タスクの状態が「処理完了のタスク」
タスクを割り当てられたユーザが「自分」
タスク完了日時が「2013-01-01 09:00」以降
タスク完了日時が「2013-06-30 18:00」以前
データ項目番号「0」の文字型データ項目に対して「値が入力されている」
データ項目番号「1」の数値型データ項目に対して「100」以上
データ項目番号「10」の選択型データ項目を取得

タスク検索条件の例: XML形式


 <workitem-criteria>
     <process-model-info-id>33</process-model-info-id>
     <start-date-from>2013-01-01</start-date-from>
     <node-number>0</node-number>
     <workitem-states><workitem-state>ENDED</workitem-state></workitem-states>
     <workitem-allocated-quser-id>#me</workitem-allocated-quser-id>
     <workitem-end-date-from>2013-01-01 09:00</workitem-end-date-from>
     <workitem-end-date-to>2013-06-30 18:00</workitem-end-date-to>
     <data>
         <string>
             <data-definition-number>0</data-definition-number>
             <not-empty />
         </string>
         <decimal>
             <data-definition-number>1</data-definition-number>
             <greater-equals />
             <value>100</value>
         </decimal>
         <select>
             <data-definition-number>10</data-definition-number>
             <view />
         </select>
     </data>
 </workitem-criteria>

タスク検索条件の例: JSON形式


 {
      "processModelInfoId":33,
      "processInstanceStartDateFrom":"2013-01-01",
      "nodeNumber":0,
      "state":["ENDED"],
      "allocatedQuserId":"#me",
      "endDateFrom":"2013-01-01 09:00",
      "endDateTo":"2013-06-30 18:00",
      "data":[
          {
              "type":"string",
              "number":0,
              "method":"not-empty"
          },
          {
              "type":"decimal",
              "number":1,
              "method":"greater-equals",
              "value":100
          }
      ],
      "fields":[
          {
              "type":"select",
              "number":10
          }
      ]
 }

レスポンス

タスク処理履歴を検索する: /API/OR/Workitem/list
- workitems: タスクの一覧で、WorkitemEntryのリスト
タスク処理履歴を検索する(CSVファイル取得: UTF-8): /API/OR/Workitem/listCsv
- ファイルデータ: CSV形式のファイルで、データエンコードがUTF-8
タスク処理履歴を検索する(CSVファイル取得: UTF-16): /API/OR/Workitem/listCsvUtf16
- ファイルデータ: CSV形式のファイルで、データエンコードがUTF-16

発生する可能性のあるエラー

Validation: 10000
InvalidStart: 10012
InvalidLimit: 10013

すべてのプロセス履歴を検索する: /API/OR/ProcessInstance/list

すべてのプロセス履歴を検索する(CSVファイル取得: UTF-8): /API/OR/ProcessInstance/listCsv

すべてのプロセス履歴を検索する(CSVファイル取得: UTF-16): /API/OR/ProcessInstance/listCsvUtf16

GET/POST リクエストパラメータ

パラメータ名	必須	説明
criteria	任意	検索条件を指定します。検索条件は、XML形式またはJSON形式で指定することができます。指定しない場合は、権限を保持している全アプリの全プロセスが対象になります。検索条件にXML形式を指定する場合は、こちらを参照してください。検索条件にJSON形式を指定する場合は、こちらを参照してください。
reportId	任意	[このリストに名前をつけて保存]で保存した検索条件のレポートIDで指定します。レポートIDは、保存した検索条件を開いた際に、ブラウザに表示されるURLの[reportId]パラメータの値を使用してください。
limit	任意	取得するタスクの最大件数を指定します。最小値は「0」、最大値は「1000」です。指定しない場合は、「1」が指定されたものとみなされます。
start	任意	取得するタスクの開始位置を指定します。最小値は「0」、最大値は「2147483647」です。指定しない場合は、「0」が指定されたものとみなされます。例: 検索結果の全件が「100」、startに「10」、limitに「50」を指定した場合は、100件のうち11件目から60件を取得します。

プロセス検索条件:XML形式の構造

要素名/属性名(XPath式)	型	説明
/process-instance-criteria		検索条件XMLのルート要素
process-model-info-id	整数	アプリのID 権限を保持している全アプリを検索対象とする場合は、指定しないでください。
states		対象プロセスの状態を指定します。指定しない場合は、すべての状態のプロセスが検索対象となります。
states/state	文字列	対象プロセスの状態を、以下から指定します。複数の状態を検索対象とする場合は、その数だけ要素を並べます。 STARTED: 未終了のプロセス ENDED: 正常終了したプロセス FAILED: 異常終了(強制終了)したプロセス
title	文字列	件名指定した場合は、値が件名の一部に含まれているプロセスを検索します。 title要素を複数指定することにより、AND条件での絞り込み条件を増やすことができます。
start-date-from	文字列	プロセスを開始した日時(from) 指定した場合は、指定された日時以降に開始されたプロセスを検索します(指定日時も含む)。
start-date-to	文字列	プロセスを開始した日時(to) 指定した場合は、指定された日時以前に開始されたプロセスを検索します(指定日時も含む)。
end-date-from	文字列	プロセスが終了した日時(from) 指定した場合は、指定された日時以降に終了したプロセスを検索します(指定日時も含む)。
end-date-to	文字列	プロセスが終了した日時(to) 指定した場合は、指定された日時以前に終了したプロセスを検索します(指定日時も含む)。
init-quser-id	整数	ユーザのIDまたは自分自身(「#me」) 指定した場合は、プロセスの開始ユーザが指定したユーザであるプロセスを検索します。
init-qgroup-id	整数	組織のID 指定した場合は、プロセスの開始組織が指定した組織であるプロセスを検索します。
sort-property	文字列	検索結果をソートする際のキー指定しない場合は、「processInstanceStartDatetime」が指定されたものとみなされます。 processInstanceStartDatetime: プロセスの開始日時でソートします。 processInstanceEndDatetime: プロセスの終了日時でソートします。
sort-direction	文字列	ソートの順序指定しない場合は、「DESC」が指定されたものとみなされます。 ASC: 昇順でソートします。 DESC: 降順でソートします。
data		データ項目を検索条件や結果取得対象に含めるかどうかここで指定されたデータ項目のみ、検索結果に含まれます。
data/*/data-definition-number	整数	データ項目番号検索対象や結果取得対象にするデータ項目のデータ項目番号を指定します。「*」部分は、対象のデータ型によって異なります。
data/*/value	文字列	検索に使用する値「*」部分は、対象のデータ型によって異なります。
data/string		文字型のデータ項目を検索や結果取得対象に含める場合
data/string/empty		「値が入力されていない」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定は必要ありません。
data/string/not-empty		「値が入力されている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定は必要ありません。
data/string/contains		「値に含まれている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/discussion		掲示板型のデータ項目を検索や結果取得対象に含める場合
data/discussion/empty		「値が入力されていない」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定は必要ありません。
data/discussion/not-empty		「値が入力されている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定は必要ありません。
data/discussion/contains		「値に含まれている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/decimal		数値型のデータ項目を検索や結果取得対象に含める場合
data/decimal/equals		「等しい」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/decimal/greater-equals		「以上」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/decimal/less-equals		「以下」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/date		日付型のデータ項目を検索や結果取得対象に含める場合
data/date/equals		「等しい」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/date/after-equals		「以降」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/date/before-equals		「以前」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/datetime		日時型のデータ項目を検索や結果取得対象に含める場合
data/datetime/equals		「等しい」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/datetime/after-equals		「以降」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/datetime/before-equals		「以前」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/select		選択型のデータ項目を検索や結果取得対象に含める場合
data/select/selected		「選択されている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/file		ファイル型のデータ項目を検索や結果取得対象に含める場合
data/file/contains		「ファイル名に含まれている」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/quser		ユーザ型のデータ項目を検索や結果取得対象に含める場合
data/quser/equals		「等しい」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/qgroup		組織型のデータ項目を検索や結果取得対象に含める場合
data/qgroup/equals		「等しい」条件で検索する場合この検索条件を指定した場合は、data/*/value の指定が必要です。
data/table		テーブル型のデータ項目を結果取得対象に含める場合検索条件には指定できません。
data/*/view		指定したデータ項目において検索条件は指定せず、結果取得対象にする場合「*」の部分は、対象のデータ型によって異なります。

プロセス検索条件:JSON形式の構造

キー	型	説明
processModelInfoId	整数	アプリのID 権限を保持している全アプリを検索対象とする場合は、指定しないか「-1」を指定してください。
processInstanceState	文字列(配列)	対象プロセスの状態を、以下から指定します。複数の状態を検索対象とする場合は、その数だけ配列指定します。 STARTED: 未終了のプロセス ENDED: 正常終了したプロセス FAILED: 異常終了(強制終了)したプロセス
processInstanceTitle	文字列(配列)	件名指定した場合は、値が件名の一部に含まれているプロセスを検索します。複数のタイトルを配列指定することにより、AND条件での絞り込み条件を増やすことができます。
processInstanceStartDateFrom	文字列	プロセスを開始した日時(from) 指定した場合は、指定された日時以降に開始されたプロセスを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。
processInstanceStartDateTo	文字列	プロセスを開始した日時(to) 指定した場合は、指定された日時以前に開始されたプロセスを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。
processInstanceEndDateFrom	文字列	プロセスが終了した日時(from) 指定した場合は、指定された日時以降に終了したプロセスを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。実行中のプロセスは含まれません。
processInstanceEndDateTo	文字列	プロセスが終了した日時(to) 指定した場合は、指定された日時以前に終了したプロセスを検索します(指定日時も含む)。 2023-10-12(日付)、2023-10-12 09:36(日時)などの絶対指定のほかに、 #now、#today、addDays(2)などの相対指定もできます。実行中のプロセスは含まれません。
processInstanceInitQuserId	文字列	ユーザのIDまたは自分自身(「#me」) 指定した場合は、プロセスの開始ユーザが指定したユーザまたは自分自身であるプロセスを検索します。
processInstanceInitQgroupId	文字列	組織のID 指定した場合は、プロセスの開始組織が指定した組織であるプロセスを検索します。
starred	boolean	スターが付与されている状態を、以下から指定します。 true: スターあり false: スターなし
data	オブジェクト(配列)	データ項目に保持されている値で検索する場合に、各データ項目ごとに指定します。複数のデータ項目を指定する場合は、配列指定してください。例) {"type": "decimal", "number": 0, "method":"less-equals","value":"10"} 各データ項目に指定するkeyは、data[].xxxで説明しています。テーブル型データ項目は指定することができません。
data[].type	文字列	データ項目のデータ型を指定します。検索条件:JSON形式で指定するデータ項目に関する詳細は、こちらを参照してください。
data[].number	整数	データ項目のデータ項目番号を指定します。
data[].method	文字列	データ項目の値の判定条件を指定します。検索条件:JSON形式で指定するデータ項目に関する詳細は、こちらを参照してください。
data[].value	文字列	データ項目の判定値を指定します。検索条件:JSON形式で指定するデータ項目に関する詳細は、こちらを参照してください。
fields	オブジェクト(配列)	検索結果として出力したいデータ項目を指定します。複数のデータ項目を指定する場合は、配列指定してください。例) {"type": "decimal", "number": 0} 各データ項目に指定するkeyは、fields[].xxxで説明しています。出力対象のデータ項目を指定するため、特定のアプリを検索する場合のみ有効となります。
fields[].type	文字列	データ項目のデータ型を指定します。検索条件:JSON形式で指定するデータ項目に関する詳細は、こちらを参照してください。
fields[].number	整数	データ項目のデータ項目番号を指定します。
sortProperty	文字列	検索結果をソートする際のキーを、以下から指定します。指定しない場合は、「processInstanceStartDatetime」が指定されたものとみなされます。 processInstanceTitle: プロセスのタイトルでソートします。 processInstanceStartDatetime: プロセスの開始日時でソートします。 processInstanceEndDatetime: プロセスの終了日時でソートします。
sortDirection	文字列	ソートの順序を、以下から指定します。指定しない場合は、「DESC」が指定されたものとみなされます。 ASC: 昇順でソートします。 DESC: 降順でソートします。

プロセス検索条件:JSON形式のデータ項目指定

データ型	type に指定する値	method に指定する値	説明
文字型	string	empty	値が入力されていない
		not-empty	値が入力されている
		contains	valueで指定された文字列を含む
数値型	decimal	equals	valueで指定された数値と等しい
		greater-equals	valueで指定された数値以上
		less-equals	valueで指定された数値以下
選択型	select	selected	valueで指定された選択肢IDと等しい
日付型	date	equals	valueで指定された日付と等しい
		after-equals	valueで指定された日付以降
		before-equals	valueで指定された日付以前
日時型	datetime	equals	valueで指定された日時と等しい
		after-equals	valueで指定された日時以降
		before-equals	valueで指定された日時以前
ファイル型	file	contains	valueで指定された文字列をファイル名に含む
ユーザ型	quser	equals	valueで指定されたユーザIDと等しい
組織型	qgroup	equals	valueで指定された組織IDと等しい
テーブル型	list	-	fieldsのみで使用できるため、methodの指定はありません。
掲示板型	discussion	empty	値が入力されていない
		not-empty	値が入力されている
		contains	valueで指定された文字列を含む

プロセス検索条件の例

検索条件を指定したプロセス検索条件の例です。

アプリIDが「33」
プロセス開始日時が「2011-01-01」以降
データ項目番号「0」の文字型データ項目に対して「値が入力されている」
データ項目番号「1」の数値型データ項目に対して「100」以上
データ項目番号「10」の選択型データ項目を取得

プロセス検索条件の例: XML形式


 <process-instance-criteria>
     <process-model-info-id>33</process-model-info-id>
     <start-date-from>2011-01-01</start-date-from>
     <data>
         <string>
             <data-definition-number>0</data-definition-number>
             <not-empty />
         </string>
         <decimal>
             <data-definition-number>1</data-definition-number>
             <greater-equals />
             <value>100</value>
         </decimal>
         <select>
             <data-definition-number>10</data-definition-number>
             <view />
         </select>
     </data>
 </process-instance-criteria>

プロセス検索条件の例: JSON形式


 {
      "processModelInfoId":33,
      "processInstanceStartDateFrom":"2011-01-01",
      "data":[
          {
              "type":"string",
              "number":0,
              "method":"not-empty"
          },
          {
              "type":"decimal",
              "number":1,
              "method":"greater-equals",
              "value":100
          }
      ],
      "fields":[
          {
              "type":"select",
              "number":10
          }
      ]
 }

レスポンス

すべてのプロセス履歴を検索する: /API/OR/ProcessInstance/list
- processInstances: プロセスの一覧で、ProcessInstanceEntryのリスト
すべてのプロセス履歴を検索する(CSVファイル取得: UTF-8): /API/OR/ProcessInstance/listCsv
- ファイルデータ: CSV形式のファイルで、データエンコードがUTF-8
すべてのプロセス履歴を検索する(CSVファイル取得: UTF-16): /API/OR/ProcessInstance/listCsvUtf16
- ファイルデータ: CSV形式のファイルで、データエンコードがUTF-16

発生する可能性のあるエラー

Validation: 10000
InvalidStart: 10012
InvalidLimit: 10013

プロセスの詳細情報を取得する: /API/OR/ProcessInstance/view

GET/POST リクエストパラメータ

パラメータ名	必須	説明
processInstanceId	必須	対象プロセスのID WorkitemEntryのprocessInstanceId属性の値

レスポンス

processInstance: ProcessInstanceEntry

発生する可能性のあるエラー

InvalidProcessInstanceId: 10014
ProcessInsntanceDoesNotExist: 20016
Forbidden: HTTP 403

ファイル型のデータ項目を取得する: /API/OR/ProcessInstance/File/download

GET/POST リクエストパラメータ

パラメータ名	必須	説明
id (File Id)	必須	対象データ項目のファイルのID ProcessDataEntryの[value]を指定します。
processDataInstanceId	必須	対象データ項目のID ProcessDataEntryの[id]を指定します。

レスポンス

ファイルデータ

発生する可能性のあるエラー

InvalidId: 10001
InvalidProcessDataInstanceId: 20015
Forbidden: HTTP 403

プロセスにスターを追加する: /API/OR/ProcessInstance/<processInstanceId>/Star/add

POST リクエストパラメータ

パラメータ名	必須	説明
processInstanceId	必須	対象プロセスのID クエリパラメータの指定ではなく、パスパラメータでの指定となります。リクエストURLの<processInstanceId>に指定します。

レスポンス

なし

発生する可能性のあるエラー

なし

プロセスからスターを削除する: /API/OR/ProcessInstance/<processInstanceId>/Star/remove

POST リクエストパラメータ

パラメータ名	必須	説明
processInstanceId	必須	対象プロセスのID クエリパラメータの指定ではなく、パスパラメータでの指定となります。リクエストURLの<processInstanceId>に指定します。

レスポンス

なし

発生する可能性のあるエラー

なし

タスクを強制割当する: /API/PIM/Workitem/reallocate

指定したタスクが「必ず最初のタスクを処理した人に割り当てる」が設定されているスイムレーン上にあり、そのスイムレーン上に複数の処理中の割当タスクが存在する場合は、そのすべてのタスクが強制割当されます。

POST リクエストパラメータ

パラメータ名	必須	説明
workitemId	必須	対象タスクのID
quserId	必須	割当先ユーザのID
qgroupId	必須	割当先ユーザの所属組織のID

レスポンス

workitem: 強制割当したタスクの WorkitemEntry

発生する可能性のあるエラー

InvalidQuserId: 10002
InvalidQgroupId: 10003
InvalidWorkitemId: 10016
QuserDoesNotExist: 20002
QgroupDoesNotExist: 20004
MembershipDoesNotExist: 20006
WorkitemDoesNotExist: 40003
WorkitemFinished: 40006

プロセスを強制終了する: /API/OR/ProcessInstance/stop

強制終了できるプロセスは、自分が開始して自分しか関わっていないプロセス、またはコントロール権限を持つプロセスとなります。

POST リクエストパラメータ

パラメータ名	必須	説明
processInstanceId	必須	対象プロセスのID

レスポンス

なし

発生する可能性のあるエラー

InvalidProcessInstanceId: 10014
ProcessInstanceDoesNotExist: 20016
ProcessInstanceFinished: 40007

プロセスを削除する: /API/OR/ProcessInstance/delete

削除できるプロセスは、自分が開始して自分しか関わっていないプロセス、またはコントロール権限を持つプロセスとなります。

POST リクエストパラメータ

パラメータ名	必須	説明
processInstanceId	必須	対象プロセスのID

レスポンス

なし

発生する可能性のあるエラー

InvalidProcessInstanceId: 10014
ProcessInstanceDoesNotExist: 20016

オープンチャットAPI

操作	GET	POST	リクエストURL	レスポンス(JSON)	実行に必要な権限
指定のメッセージを削除する	-	○	<ContextRoot>/API/Feed/Message/<messageId>/delete	なし	全ログインユーザ
指定のコメントを削除する	-	○	<ContextRoot>/API/Feed/Message/<messageId>/Comment/<commentId>/delete	なし	全ログインユーザ

「<ContextRoot>」は、DataSpider BPMのルートURIである「http(s)://<ホスト名>:<ポート番号>/userweb」を意味します。

オープンチャットAPI詳細

指定のメッセージを削除する: /API/Feed/Message/<messageId>/delete

POST リクエストパラメータ

パラメータ名	必須	説明
messageId	必須	投稿したつぶやき(メッセージ)のID クエリパラメータの指定ではなく、パスパラメータでの指定となります。リクエストURLの<messageId>に指定します。タイムライン画面を開き、投稿したつぶやきの投稿日時にマウスを移動することで、idを確認することができます。

レスポンス

Forbidden: HTTP 403
Not Found: HTTP 404

発生する可能性のあるエラー

なし

指定のコメントを削除する: /API/Feed/Message/<messageId>/Comment/<commentId>/delete

POST リクエストパラメータ

パラメータ名	必須	説明
messageId	必須	投稿したつぶやき(メッセージ)のID クエリパラメータの指定ではなく、パスパラメータでの指定となります。リクエストURLの<messageId>に指定します。タイムライン画面を開き、投稿したつぶやきの投稿日時にマウスを移動することで、idを確認することができます。
commentId	必須	投稿したコメントのID クエリパラメータの指定ではなく、パスパラメータでの指定となります。リクエストURLの<commentId>に指定します。タイムライン画面を開き、投稿したコメントの投稿日時にマウスを移動することで、idを確認することができます。

レスポンス

なし

発生する可能性のあるエラー

Forbidden: HTTP 403
Not Found: HTTP 404