IBM FileNet P8, バージョン 5.2.1            

Process Engine REST Service リファレンス

REST Service の URL

Process Engine REST Service リソースの URI の形式は、次のとおりです。
http://CPEServerHost:CPEServerPort/peengine/P8BPMREST/p8/bpm/v1/{resourceName}[?cp={connectionPointName}][&{resourceParameters}]
CPEServerHost
REST Service をホストしている Content Platform Engine サーバーの名前。
CPEServerPort
REST Service 通信に使用される Content Platform Engine サーバーのポート。
resourceName
使用する Process Engine REST リソースの名前。
cp=
(オプション) Process Engine REST Service によって使用されるアイソレート・リージョン接続ポイントは、P8PMRESTConfig.xml ファイル内で割り当てられます。リソースにこのパラメーターを指定すると、接続ポイント設定を上書きすることができます。フォーマットは次のとおりです。
cp=connectionPointName
connectionPointName は既存の接続ポイントの名前です。詳しくは、『REST Service の構成』および『ワークフロー・システムの定義』を参照してください。
resourceParameters
指定した Process Engine REST リソース用に指定する任意のパラメーター。

Process Engine REST Service バージョン識別番号 (/v1) を使用すると、REST Service に対する後続の更新が可能になります。

アプリケーション・スペース名

/p8/bpm/v1/appspacenames

説明

複数のアプリケーション・スペースの名前のコレクション。現行ユーザーにアクセス権がないものも含まれます。これは、ページ作成で アプリケーション・スペースを選択する場合に役立ちます。

パス・エレメント

なし。

アプリケーションの HTTP メソッド

GET

アプリケーション・スペースのコレクションを取得します。

パラメーター

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/appspacenames

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "description":"Contains a dynamic set of properties. The property names are the application space names.",
  "additionalProperties":
  {
    "type":"object",
    "properties":
    {
      "name":{"type":"string"},
      "rolenames": 
      {
        "type":"string",
        "format":"uri"
      } 
    }   
  }     
}
応答の例
{ 
  "Autoclaim": 
  { 
    "name":" Autoclaim", 
    "rolenames":"appspacenames/Autoclaim/rolenames"
  },
  "Healthclaim":
  { 
    "name":"Healthclaim",
    "rolenames":"appspacenames/Healthclaim/rolenames"}
}
表 1. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

現行ユーザー

/p8/bpm/v1/currentuser

説明

アプリケーション・スペース内の現行ユーザーの名前、ID、E メール・アドレス、および表示名。

パス・エレメント

なし

アプリケーションの HTTP メソッド

GET

現行ユーザーがメンバーとして属している、指定アプリケーション・スペース内のロールを取得します。

パラメーター

なし

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/currentuser

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "description":"Contains information for the current user.",
  "properties": 
  {
    "type":"object",
    "properties":
    {  
      "name":{"type":"string","description":"Current user name."},
      "id": {"type":"long","description":"Associated user ID."},
      "email":{"type":"string","description":"email"},
      "displayName":{"type":"string","description":"display name"}
    }
  } 
}
応答の例
{
  "name":"elijah",
  "id": 23
  "email":"elijah@zzz.net",
  "displayName":"Elijah BBB"
}
表 2. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

Groups

/p8/bpm/v1/groups

説明

グループのコレクション。これは、ロール・メンバーシップまたはワーク・アイテムの割り当てでグループを選択する場合に役立ちます。

domainName GET パラメーターを使用してドメインを指定することにより、検索スコープを制限できます。ドメイン名が指定されていない場合、検索スコープはすべてのドメインです。

Group オブジェクトには、name プロパティーと displayName プロパティーの両方が含まれます。name 値は、Process Engine データベースにキャッシュされたグループの短縮名です。この名前は常に小文字で保管されます。displayName 値は、LDAP サーバーから取得されます。 この値には、大文字と小文字の区別があります。元の大文字小文字の表示が必要な場合は、displayName 値を使用してください。

パス・エレメント

なし。

アプリケーションの HTTP メソッド

GET

指定された検索パラメーターに基づくグループ名またはグループ名のコレクションを取得します。

表 3. グループのパラメーター
必須かどうか 名前 データ型 説明
必要な searchPattern String グループ名の一致の有無を判別するために使用される比較文字列。比較は、searchType パラメーターで指定されたメソッドに 従って実行されます。このパラメーターは、searchType が 0 (SEARCH_TYPE_NONE) の場合は無視されます。
必要な searchType Integer 指定された searchPattern の使用方法を判別します。これは、次のいずれかの整数値になります。
  • 0 (SEARCH_TYPE_NONE): searchPattern 文字列は無視され (指定した場合)、示された範囲のグループ名が すべて返されます。これにより、大容量データベースの場合はパフォーマンスが低下する可能性があります。
  • 1 (SEARCH_TYPE_CUSTOM): searchPattern 文字列が完全に一致した場合に返します。
  • 2 (SEARCH_TYPE_PREFIX_MATCH): searchPattern 文字列がグループ名の先頭に完全に一致した場合に返します。
  • 3 (SEARCH_TYPE_SUFFIX_MATCH): searchPattern 文字列がグループ名の末尾に完全に一致した場合に返します。
  • 4 (SEARCH_TYPE_CONTAINS): searchPattern 文字列がグループ名の任意の場所に完全に一致した場合に返します。
オプション sortType Integer 返されたレコード・セットに対してセキュリティー・データベース・サーバーが実行するソートのタイプを 示します。セキュリティー・データベース・サーバーでソートが失敗すると、エラーが発生し、結果は返されません。これは、次のいずれかの整数値になります。
  • 0 (SORT_TYPE_NONE): 結果のレコードをソートしません。
    重要: 大容量のセキュリティー・データベースの場合、この指定によりパフォーマンスの低下や、誤った結果が生じる可能性が あります。バッファー・サイズの設定値は、(limit パラメーターによって指定された) 返されるレコードの最大数となり、返される実際のレコード数は、入力バッファー・サイズとディレクトリー・サーバー・サイズ制限のいずれか小さい数となります。
  • 1 (SORT_TYPE_ASCENDING): 結果のレコードを昇順でソートします。
  • 2 (SORT_TYPE_DESCENDING): 結果のレコードを降順でソートします。
オプション limit Integer 返されるレコードの最大数。この値を指定しない場合、照会結果全体が返されます。
オプション domainName String この要求のスコープとして使用するドメインの名前。ドメイン名が指定されていない場合、検索スコープはすべてのドメインです。
要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/groups/MyDomain/groups?searchPattern="engineers"&searchType=1&sortType=1&limit=50

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "properties":
  {  
    "overLimit":{"type":"boolean", "description":"Contains true if the value for the limit parameter is exceeded; false otherwise."},  
    "groups": 
    { 
      "type":"array",
      "items": 
      { 
        "name":{"type":"string"}, 
        "displayName":{"type":"string"} 
      }
    }
}
応答の例
{ "overLimit":false,
  "groups":
  [
    {"name":"engineers", "displayName":"engineers"},
  ]
}
表 4. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

起動ステップ・エレメント

/p8/bpm/v1/rosters/{rosterName}/wc/{workclassName}/wob/{wobNum}

説明

ワークフローの起動ステップ・エレメント。このリソースは、要求ヘッダーの POE パラメーターが 1 (POE:1) の場合に、Workclass.Get response ヘッダーの POE-Links パラメーターで返されます。

表 5. パス・エレメント
名前 説明
rosterName String ワークフローに使用されるロスターの名前。
workclassName String ワーク・クラス (ワークフロー) の名前。
wobNum String ワーク・オブジェクト (ワークフロー起動ステップ・エレメント) を識別する GUID。

アプリケーションの HTTP メソッド

POST

指定されたワーク・クラス (ワークフロー) を開始します。クライアントは、WorkClass.GET 操作を介して取得された構造を使用する必要があります。

POST 操作が成功するには、ワーク・オブジェクト (ワークフロー起動ステップ・エレメント) の最初の POST である必要があります。

成功した場合、ペイロードの最初の POST は、201 Created を返します。後続の POST 操作では、次の応答が返されます。
    405 Not Allowed
    Allow: Get

このリソースの GET 操作は、POST 操作で作成されたのと同様のワークフロー起動ステップ・エレメントの JSON 表記を返します。

パラメーター

なし。

表 6. 要求ヘッダー
必須かどうか 名前 説明
必要な POE この値は 1 に設定する必要があります。この値が存在しない場合、400 Bad Request エラーが返されます。

要求のコンテンツ

Mime タイプ: application/json

ステップ・エレメントについては、応答の「JSON スキーマ」を参照してください。

起動ステップ・エレメントに応答がある場合は、selectedResponse 値を設定する必要があります。それ以外の場合は、400 Bad Request が返されます。

要求の例
POST http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/rosters/myRoster/wc/myWorkclass/wob/12345

応答のコンテンツ

Mime タイプ: application/json

ステップ・エレメントについては、応答の「JSON スキーマ」を参照してください。

応答の例

ステップ・エレメントの応答例」を参照してください。

表 7. エラー・コード
コード 説明
201 Created 正常終了 - ワークフローが起動されます。
400 Bad Request selectedResponse が欠落しているか、要求コンテンツがありません。
404 Not Found 指定されたワーク・クラス (ワークフロー) が見つかりません。
405 Not Allowed このリソースに対する後続の POST が試行されています。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

GET

このリソース上の POST 操作で作成したエレメントと同様の、ワークフロー起動ステップ・エレメントの JSON 表記を取得します。

パラメーター

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/rosters/myRoster/wc/myWorkclass/wob/12345

応答のコンテンツ

ワーク・オブジェクト (ワークフロー起動ステップ・エレメント) が見つかり、それがアクティブな場合、200 OK の応答コードと共に、ワークフロー起動ステップ・エレメントの JSON 表記がロスター内の現在の状態で返されます。

Mime タイプ: application/json

ステップ・エレメントについては、応答の「JSON スキーマ」を参照してください。

応答の例

ステップ・エレメントの応答例」を参照してください。

表 8. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
410 Gone ワーク・クラス (ワークフロー) が終了または削除されています。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

マイルストーン

/p8/bpm/v1/queues/{queueName}/stepelements/{wobnum}/milestones

説明

ステップ・エレメントのマイルストーンのリストを取得します。

表 9. マイルストーンのパス・エレメント
名前 説明
queueName String ステップ・エレメントが関連付けられているキューの名前。
wobnum String ワーク・オブジェクト (ステップ・エレメント) を識別する GUID。

アプリケーションの HTTP メソッド

GET

ステップ・エレメントの一連のマイルストーンを取得します。

表 10. マイルストーンのパラメーター
必須かどうか 名前 データ型 説明
オプション レベル Integer 1 から 99 までの整数値 (これらの値を含む)。制限レベルとして使用するマイルストーン・レベルを 示します。この値以下のレベル値を持つマイルストーンのみが、イベント・ログから取得されます。
オプション reachedOnly boolean 値 true は、取得操作が、到達したマイルストーン・オブジェクトに制限されることを示します。値 false は、マイルストーンに到達したかどうかに関係なく取得が行われ、マイルストーンが実行順に返されることを示します。この場合、返されるマイルストーンの順序は、Process Designer で指定された順序によって決定されます。指定しない場合、デフォルトで false になります。
オプション lastOnly boolean 値 true は、マイルストーンの最後の実行を反映するオブジェクトのみが返されることを示します。マイルストーンが複数回実行されている場合でも、1 つのマイルストーンに対して 1 つのオブジェクトのみが返されます。値 false は、マイルストーンが複数回実行されている場合、1 つのマイルストーンに対して複数のオブジェクトが返されることを示します。指定しない場合、デフォルトで true になります。
要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/myQueue/stepelements/12345/milestones

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type": "array",
  "items":
    {
        "type":"object",
        "properties":
        {
            "name":{"type":"string"},
            "level":{"type":"integer"},
            "reached":{"type":"boolean"},
            "message":{"type":"string"},
            "milestoneId":{"type":"integer"},
            "timestamp":{"type":"string", "format":"date-time"},
            "mapName":{"type":"string"},
            "mapId":{"type":"integer"},
            "stepId":{"type":"integer"},
        }
    }
}
応答の例
[
  {
    "name":"Milestone A",
    "level":1,
    "reached":true,
    "message":"Milestone A has been reached",
    "milestoneId":1",
    "timestamp":"2009-04-16'T'14:36:25Z",
    "mapName":"Workflow",
    "mapId":-2,
    "stepId":5
  },
  {
    "name":"Milestone B",
    "level":1,
    "reached":false,
    "message":"",
    "milestoneId":1",
    "timestamp":"",
    "mapName":"Workflow",
    "mapId":-1,
    "stepId":-1
  }
]
表 11. マイルストーンのエラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
404 Not Found ワーク・アイテムが見つかりません。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

キュー・エレメント

/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/?{queryParams}

説明

指定された照会パラメーターに基づいて、ワーク・バスケット内のキュー・エレメントの集合を取得します。queryParams 引数が大規模な集合である場合、Content-Type=application/x-www-form-urlencoded を指定した POST メソッドと、UTF-8 でエンコードされた要求パラメーター URL を含む要求コンテンツを使用します。詳細については、「URL 長の制限」を参照してください。

多くのエレメントが存在する場合には、全セットを取得するために複数の照会が必要になることがあります。 使用法については、lastRecord パラメーターおよび pageSize パラメーターを参照してください。

表 12. パス・エレメント
名前 説明
queue String ワーク・バスケットが関連付けられているキューの名前。
workbasket String ワーク・バスケットの名前。
queryParams なし 照会の条件を指定するパラメーターの集合。このリソースの GET パラメーターを参照してください。

アプリケーションの HTTP メソッド

GET

指定された照会パラメーターに基づいて、キュー・エレメントの集合を取得します。

表 13. キュー・エレメントのパス・パラメーター
必須かどうか 名前 データ型 説明
オプション filters String フィルター名/値のペアのタプル (例えば、[State=CA, City=Costa Mesa])。等号 (=)、コンマ (,)、および円記号 (¥) 文字は、フィルターで使用する場合に、特別な制限または処理があります。等号 (=)、コンマ (,)、および円記号 (¥) 文字は、指定されたフィルターを構文解析するために使用される予約文字です。コンマ文字は複数のフィルターを区切るために使用され、等号文字はフィルターの名前と値を区切るために使用されます。これらの予約文字を予約された用途以外の方法で使用する場合は、以下の操作が必要です。
  • 文字の前に円記号を付けることにより (¥=¥、または ¥¥)、フィルター名またはフィルター値で使用される予約文字をエスケープします。例えば、「より小か等しい」演算 (<=) をフィルターで正しく構文解析するためには、等号を「<¥=」とエスケープします。
  • フィルター・バージョン・キー fv=1 を最後に付加します。現在サポートされているフィルター・バージョン・キー値は 1 のみです。この他の値を指定すると、例外が生成されます。&fv=1 がフィルターの URL から省略されると、予約文字は値の区切りおよび割り当てのみに使用されます。フィルターのバージョン管理 (&fv=1) を使用しない場合は、フィルターの構文解析がより効率的になります。

下線 (_) およびパーセント (%) 文字は、データベース構文 LIKE および NOT LIKE とともに使用すると、データベース・ワイルドカード文字に関連付けられます。LIKE または NOT LIKE 構文でフィルターを定義して、これらの文字が含まれた実行時のマップ値を渡した場合、結果セットは、ワイルドカード文字のマッチングによって定義されます。フィールドに「_」または「%」文字が含まれたレコードを抽出することはできません。

ユーザーにバインドされたキュー要素の取得:

  • 前提条件: F_BoundUser 列に基づいて、ワーク・バスケットに対するフィルターを定義します。
  • USN 構文を使用して boundUser を指定します: filters=[filterkey={{USN:}}]
  • 例えば、以下のフィルターはワーク・バスケット内のユーザー「pwtest1」にバインドされたキュー要素を取得します: http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/?filters=[filterkey={{USN:pwtest1}}]
オプション lastRecord String 前の照会で返された最後のレコードを示します。このパラメーターは、継続呼び出し (ページングのための呼び出しなど) にのみ使用されます。応答のコンテンツ内に返される値には意味がありません。照会の filters 値または orderBy 値が変更されるたびに常に、クライアントは照会を lastRecord パラメーターなしで再発行する必要があります。このパラメーターは、最初の照会で指定しないでください。
オプション pageSize Integer ページに表示されるアイテムの数。サーバーは一度に 1 ページだけ返します。ページ・サイズを指定しない場合、デフォルトの 50 が使用されます。
オプション orderBy String ソートのキーとなる列 ("AccountNumber" など)。1 列のみ指定できます。
オプション queryFlags Integer 照会に使用されるフラグ。指定可能な値については、「VWQueue Javadocs」の QUERY_* 属性を参照してください。値を指定しない場合、デフォルトは 0 (ゼロ) です。この場合、結果としてアンロック済みのワーク・アイテムのみが返されます。

ロック済みとアンロック済みの両方のワーク・アイテムを返す必要があることを指定するには、この値を 1 に設定します。

次の形式を使用して複数の queryFlags 値を組み合わせることができます。

queryFlags=value1|+value2|+...

要求の例

ワーク・バスケットからロック済みとアンロック済みの両方のワーク・アイテムをフェッチする例を以下に示します (queryFlags=1)。結果は、filters 値「State=CA」および「City='Costa Mesa'」でフィルタリングされ、orderby 値「State」で並べ替えられます。一度に最大 50 個のワーク・アイテムがサーバーから返されます (pageSize 値)。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements?filters=[State=CA,City=Costa Mesa]&pageSize=50&queryFlags=1ℴBy=State
クライアントは、サーバーからの応答でキュー・エレメントを受け取ります。応答には、lastRecord 値も含まれています。以下の GET は、次の 50 個のワーク・アイテムを取得します。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements?filters=[State=CA,City=Costa Mesa]&pageSize=50&queryFlags=1ℴBy=State&lastRecord=xxxxx
次の 50 個のワーク・アイテムを取得する前述の GET で、これらのワーク・アイテムが降順で返されるように指定することもできます。queryFlags 値 16384 は、降順ソートを有効にすることを示します。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements?filters=[State=CA,City=Costa Mesa]&pageSize=50&queryFlags=1|+16384ℴBy=State&lastRecord=xxxxx
以下のフィルターの例では予約文字が使用されます。予約文字は円記号 (¥) 文字でエスケープする必要があります。フィルターにはフィルター・バージョン・キー (fv=1) を付加する必要があります。この例には、2 つのフィルターがあります。最初のフィルターはキー salary >=10000 を使用し、値は 10000 です。2 番目のフィルターはキー directory=¥etc¥ を使用し、値は ¥etc¥ です。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/?filters="[salary>¥=10000=10000,directory¥=¥¥etc¥¥=¥¥etc¥¥]"&fv=1
以下のフィルターは、ワーク・バスケットのユーザー pwtest1 にバインドされたキュー要素を取得します。前提条件として、ユーザーは F_BoundUser 列に基づいて、ワーク・バスケットに対するフィルターを定義済みである必要があります。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/?filters=[filterkey={{USN:pwtest1}}]
以下のフィルターは、F_WobNum のキュー・エレメントを取得します。前提条件として、ユーザーは F_WobNum 列に基づいて、ワーク・バスケットに対するフィルターを定義済みである必要があります。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/?filters=filters=[wobnum=D78E4D6FB2146748AE7DB9E653E79FE0]
以下のフィルターは、F_CaseFolder のキュー・エレメントを取得します。前提条件として、ユーザーは F_CaseFolder 列に基づいて、ワーク・バスケットに対するフィルターを定義済みである必要があります。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/?filters= filters=[caseFolder={A9EF7CCC-11F5-4234-9020-6A035DF96443}]

応答のコンテンツ

Mime タイプ: application/json

: サーバーからフェッチされたキュー・エレメントがない場合は、空の JSON オブジェクト ({ }) が返されます。

JSON スキーマ:
{ "type":"object",
  "properties":
  {
    "lastRecord":{"type":"string"},
    "stepProcessors":
    {
      "type":"object",
      "description":"Contains a dynamic set of properties. The property names are the step processor identifiers.",
      "additionalProperties":
      {
        "type":"object",
        "properties":,
        {
          "name":{"type":"string"},
          "id":{"type":"integer"},
          "appType":{"type":"string"},
          "processorType":{"type":"string"},
          "width":{"type":"integer"},
          "height":{"type":"integer"},
          "applicationName":{"type":"string"},
          "locations":
          {
            "type":"object",
            "description":"Contains a dynamic set of properties. プロパティー名は Web アプリケーション ID です。 The value of each property is the step processor location for that Web application.",
            "additionalProperties":{"type":"string"}
          }
        }
      }
    }
    "queueElements":
    {
      "type":"array",
      "items":
      {
        "type":"object",
        "properties":
        {
          "stepElement":{"type":"string" ,"format":"uri"},
          "milestones":{"type":"string","format":"uri"},
          "Etag":{"type":"string"},
          "workObjectNumber":{"type":"string"},
          "stepName":{"type":"string"},
          "queueName":{"type":"string"},
          "lockedBy":{"type":"string", "description":"Contains the name of the user who has the work item locked."},
          "lockedById":{"type":"integer", "description":"Contains the id of the user who has the work item locked. This will be -1 if the work item is not locked."},
          "stepDeadlineStatus":{"type":"string", "description":"Contains an integer value indicating the deadline status for the current step, where 0: DEADLINE_NOT_REACHED, 1: DEADLINE_REMINDER_NOTIFICATION, 2: DEADLINE_REACHED, and 3: COMPLETED"},
          "stepProcessorId":{"type":"string", "description":"Use this property to look up the step processor information in the stepProcessors property."},
          "canReassign":{"type":"boolean"},
          "boundUserName":{"type":"string","description":"Contains the name of the user who has the work item."},
          "caseFolderId": {"type":"string", "description":"Contains the case folder. This property is returned only if the field is exposed in the queue."},
          "caseTaskId": {"type":"string", "description":"Contains the case task id. This property is returned only if the field is exposed in the queue."},
          "columns":
          {
            "type":"object",
            "description":"Contains a dynamic set of properties. The property names are the column names, and the value of each property is the value of that column for the queue element.",
            "additionalProperties":
            {
              "type":"object",
              "properties":
              {
                "name":{"type":"string"},
                "value":{"type":["string","number","boolean","array"]}
              }
            }
          }
        }
      }
    }
  }
}
応答の例
{
  "lastRecord":"xxxxxxxxxxxxxx",
  "stepProcessors":
  {
    "1":
    {
      "name":"",
      "id":1,
      "appType":"HTML",
      "processorType":"step",
      "width":500,
      "height":500,
      "applicationName":"",
      "locations":
      { 
        "1":"html/ootb/WcmStepProcessor.jsp",
        "7":"html/ootb/WcmStepProcessor.jsp"
        ...
      }
    },
    ...
  }
  "queueElements":
  [
    {
      "stepElement":"queues/{queue}/stepelements/{wobnum}",
      "milestones":"/context/P8BPMREST/p8/bpm/v1/queues/{queue}/stepelements/{wobnum}/milestones",
      "ETag":"xxxx",
      "workObjectNumber","xxx",
      "stepName","Review Step",
      "queueName","ClaimProcessing",
      "lockedBy":"elijah",
      "lockedById":"23",
      "stepDeadlineStatus": 0,
      "stepProcessorId":1,
      "canReassign": true
      "boundUserName":"joe",
      "caseTaskId": "{00000000-0000-0000-0000-000000000000}", 
      "caseFolderId": "{00000000-0000-0000-0000-000000000000}",  
      "columns":
      {
        "CustomerName":"John Smith",
        "CustomerAge":35
      }
    }
    ...
  ]
}
表 14. キュー・エレメントのエラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

キュー・エレメント・カウント

/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/count

説明

ワーク・バスケット内のキュー・エレメントの数。filters パラメーターが使用されていない限り、カウントは、ワーク・バスケットの事前定義照会に基づきます。

表 15. パス・エレメント
名前 説明
queue String ワーク・バスケットが関連付けられているキューの名前。
workbasket String ワーク・バスケットの名前。
queryParams なし 照会の条件を指定するパラメーターの集合。このリソースの GET パラメーターを参照してください。

アプリケーションの HTTP メソッド

GET

表 16. パラメーター
必須かどうか 名前 データ型 説明
オプション filters String

フィルター名/値のペアのタプル (例えば、[State=CA, City=Costa Mesa])。等号 (=)、コンマ (,)、および円記号 (¥) 文字は、フィルターで使用する場合に、特別な制限または処理があります。等号 (=)、コンマ (,)、および円記号 (¥) 文字は、指定されたフィルターを構文解析するために使用される予約文字です。コンマ文字は複数のフィルターを区切るために使用され、等号文字はフィルターの名前と値を区切るために使用されます。これらの予約文字を予約された用途以外の方法で使用する場合は、以下の操作が必要です。

  • 文字の前に円記号を付けることにより (¥=¥、または ¥¥)、フィルター名またはフィルター値で使用される予約文字をエスケープします。例えば、「より小か等しい」演算 (<=) をフィルターで正しく構文解析するためには、等号を「<¥=」とエスケープします。
  • フィルター・バージョン・キー fv=1 を最後に付加します。現在サポートされているフィルター・バージョン・キー値は 1 のみです。この他の値を指定すると、例外が生成されます。&fv=1 がフィルターの URL から省略されると、予約文字は値の区切りおよび割り当てのみに使用されます。フィルターのバージョン管理 (&fv=1) を使用しない場合は、フィルターの構文解析がより効率的になります。

下線 (_) およびパーセント (%) 文字は、データベース構文 LIKE および NOT LIKE とともに使用すると、データベース・ワイルドカード文字に関連付けられます。LIKE または NOT LIKE 構文でフィルターを定義して、これらの文字が含まれた実行時のマップ値を渡した場合、結果セットは、ワイルドカード文字のマッチングによって定義されます。フィールドに「_」または「%」文字が含まれたレコードを抽出することはできません。

ユーザーにバインドされたキュー要素の取得:

  • F_BoundUser 列に基づいて、ワーク・バスケットに対するフィルターを定義します。
  • USN 構文を使用して boundUser を指定します: filters=[filterkey={{USN:}}]
  • 例えば、以下のフィルターはワーク・バスケット内のユーザー「pwtest1」にバインドされたキュー要素を取得します: http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/?filters=[filterkey={{USN:pwtest1}}]
要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/count?filters=[State=CA,City=Costa Mesa]
以下のフィルターでは予約文字が使用されます。予約文字は円記号 (¥) 文字でエスケープする必要があります。フィルターにはフィルター・バージョン・キー (fv=1) を付加する必要があります。この例には、2 つのフィルターがあります。最初のフィルターはキー salary >=10000 を使用し、値は 10000 です。2 番目のフィルターはキー directory=¥etc¥ を使用し、値は ¥etc¥ です。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/count?filters="[salary>¥=10000=10000,directory¥=¥¥etc¥¥=¥¥etc¥¥]"&fv=1
以下のフィルターは、ワーク・バスケットのユーザー pwtest1 にバインドされたキュー要素を取得します。前提条件として、ユーザーは F_BoundUser 列に基づいて、ワーク・バスケットに対するフィルターを定義済みである必要があります。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/?filters=[filterkey={{USN:pwtest1}}]
以下のフィルターは、F_WobNum のキュー・エレメントを取得します。前提条件として、ユーザーは F_WobNum 列に基づいて、ワーク・バスケットに対するフィルターを定義済みである必要があります。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/?filters=filters=[wobnum=D78E4D6FB2146748AE7DB9E653E79FE0]
以下のフィルターは、F_CaseFolder のキュー・エレメントを取得します。前提条件として、ユーザーは F_CaseFolder 列に基づいて、ワーク・バスケットに対するフィルターを定義済みである必要があります。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/?filters= filters=[caseFolder={A9EF7CCC-11F5-4234-9020-6A035DF96443}]

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "properties":
  {
    "count":{"type":"integer"}
  }
}
応答の例
{"count":95}
表 17. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

MyRoles

/p8/bpm/v1/appspaces/{appspace}/myroles

説明

アプリケーション・スペース内のロールのコレクション。現行ユーザーがメンバーとして属しているロールのみが返されます。

表 18. パス・エレメント
名前 説明
appspace String アプリケーション・スペースの名前。

アプリケーションの HTTP メソッド

GET

現行ユーザーがメンバーとして属している、指定アプリケーション・スペース内のロールを取得します。

パラメーター

なし

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/appspaces/Autoclaim/myroles

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:

{ "type":"object",
  "description":"Contains a dynamic set of properties. The property names are the authored role names.",
  "additionalProperties": 
  {
    "type":"object",
    "properties":
    {  
      "name":{"type":"string","description":"Translated role name."},
      "description": {"type":"string","description":"description of this role."},
      "URI":{"type":"string","format":"uri"}
    }
  }
}
応答の例
{ 
  "Agent":{"name":"Agent","description": "agent role", "URI":"appspaces/Autoclaim/roles/Agent"},
  "Manager":{"name":"Manager","description": "manager role", "URI":"appspaces/Autoclaim/roles/Manager"
}
表 19. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ロール

/p8/bpm/v1/appspaces/{appspace}/roles/{role}

説明

特定のロール。現行ユーザーは、このロールのメンバーであるか、またはこのロールへの書き込み権限を保持する必要があります。

表 20. パス・エレメント
名前 説明
appspace String アプリケーション・スペースの名前。
role String ロールの名前。

アプリケーションの HTTP メソッド

GET

表 21. パラメーター
必須かどうか 名前 データ型 説明
オプション includeCustomAttributes Boolean 応答にワーク・バスケットおよびロールのカスタム属性情報を含めるかどうかを示します。この属性情報を含めるには、true 値を指定します。デフォルトで false が設定されます。
要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/appspaces/Autoclaim/roles/Reviewer?includeCustomAttributes=true

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "properties": 
  {  
    "name":{"type":"string"},
    "authoredName":{"type":"string"},
    "description":{"type":"string"},
    "homePage":{"type":"string"}, 
    "attributes":{"type":"string" ,"format":"uri"},
    "customAttributes": 
        { "type":"object",
        "additionalProperties": 
                {  
        "type":"object",
        "description":"Contains a dynamic set of properties. プロパティー名は属性名です。",
        "properties":
                {
                "name":{"type":"string"},
                "type":{"type":"integer",, "description":"VWFieldType"},
                "isArray":{"type":"boolean"},
                "value":{"type":["string","number", "boolean", "array"]}
                }
                }
         }
"workbaskets": 
    {
      "type":"object",
      "description":"Contains a dynamic set of properties. The property names are the authored workbasket names.",
      "additionalProperties":
      {
        "type":"object",
        "properties":
        {
          "name":{"type":"string"},
          "description":{"Translated workbasket name."},
          "URI":{"type":"string","format":"uri"}
          "customAttributes": 
          {
            "type":"object",
            "description":"Included in the response only if the value of the includeCustomAttributes parameter is true.",
            "additionalProperties":
            {  
              "type":"object",
              "properties":
              {
                "name":{"type":"string"},
                "type":{"type":"integer"},
                "isArray":{"type":"boolean"},
                "value":{"type":["string", "number", "boolean", "array"]}
              }
            }
          }
        }
      }		 
    }
    "orderedWorkbaskets": 
    {
      "type":"array",
      "description":"Contains a dynamic set of properties. The property names are the authored workbasket names, in the order specified when",
      "items":
      {
        "name":{"type":"string"},
        "URI":{"type":"string","format":"uri"}
        "customAttributes": 
        {
          "type":"object",
          "description":"Included in the response only if the value of the includeCustomAttributes parameter is true.",
          "additionalProperties":
          {  
            "type":"object",
            "properties":
            {
              "name":{"type":"string"},
              "type":{"type":"integer"},
              "isArray":{"type":"boolean"},
              "value":{"type":["string", "number", "boolean", "array"]}
            }
          }
        }
      }		 
    }
  }
}

応答の例

{
  "name":"ReviewerTranslated",
  "authoredName":"Reviewer",
  "description":"Role description",
  "homePage":"AutoClaimReview.html",
  "attributes":"appspaces/AutoClaim/roles/Reviewer/attributes",
  "customAttributes":
    {
       "Color": { "name":"Color",    "type":2,    "isArray":false,   "value":"Red"  },
       "Colors":{ "name":"Colors",   "type":2,    "isArray":true,    "value":["Red","Blue","Green"]  }
    }
  "workbaskets":
  {
    "Initial":{"name":"Initial","URI":"appspaces/AutoClaim/roles/Reviewer/workbaskets/Initial","customAttributes":{}},
    "Appeal":{"name":"Appeal","URI":"appspaces/AutoClaim/roles/Reviewer/workbaskets/Appeal,"customAttributes":{}"}
  }
  "orderedWorkbaskets":
  [
    {name":"Initial","URI":"appspaces/AutoClaim/roles/Reviewer/workbaskets/Initial,"customAttributes":{}"},
    {name":"Appeal","URI":"appspaces/AutoClaim/roles/Reviewer/workbaskets/Appeal,"customAttributes":{}"}
  ]
}
表 22. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
400 Not Found ロールが存在しません。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ロール属性

/p8/bpm/v1/appspaces/{appspace}/myroles/{role}/attributes

説明

ロールに割り当てられている属性を識別します。

表 23. パス・エレメント
名前 説明
appspace String アプリケーション・スペースの名前。
role String ロールの名前。

アプリケーションの HTTP メソッド

GET

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/appspaces/Autoclaim/roles/Reviewer/attributes

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "additionalProperties": 
  {  
    "type":"object",
    "description":"Contains a dynamic set of properties. プロパティー名は属性名です。",
    "properties":
    {
      "name":{"type":"string"},
      "type":{"type":"integer",, "description":"VWFieldType"},
      "isArray":{"type":"boolean"},
      "value":{"type":["string","number", "boolean", "array"]}
    }
  }
}
応答の例
{
  "Color":
  {
    "name":"Color",
    "type":2,
    "isArray":false,
    "value":"Red"
  }
  "Colors":
  {
    "name":"Colors",
    "type":2,
    "isArray":true,
    "value":["Red","Blue","Green"]
  }
}
表 24. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ロール名

/p8/bpm/v1/appspacenames/{appspace}/rolenames

説明

指定されたアプリケーション・スペースのすべてのロールのコレクション。現行ユーザーにこれらのロールへのアクセス権限があるかどうかに関係なく、 アプリケーション・スペースのすべてのロールの名前が返されます。

表 25. パス・エレメント
名前 説明
appspace String アプリケーション・スペースの名前。

アプリケーションの HTTP メソッド

GET

アプリケーション・スペース用に定義されたロールの全セットを取得します。これらのロール名は、ロールの定義時にアイソレート・リージョン構成で 指定された順に返されます。

パラメーター

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/appspacenames/Autoclaim/rolenames

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "description":"プロパティー名が役割名。",
  "additionalProperties": 
  {
    "type":"object",
    "properties":
    {  
      "name":
      {
        "type":"string",
        "description":"Role name."
      }
    }
  }             
}
応答の例
{ 
  "manager":{"name":" manager"},
  "reviewer":{"name":"reviewer"}
}
表 26. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

セキュリティー・ドメイン

/p8/bpm/v1/securitydomains

説明

検出されたすべてのセキュリティー・ドメイン (LDAP レルム) の名前。これは、ユーザー情報でロール・メンバーシップが変更されたものを照会するなど、 以降の操作でユーザーとグループの範囲を絞り込む場合に役立ちます。

パス・エレメント

なし。

アプリケーションの HTTP メソッド

GET

ドメイン名のコレクションを取得します。

パラメーター

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/securitydomains

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type": "array",
  "item":
  {
    "name": {"type":"string"},
    "dn" : {"type":"string"} 
  }     
}
応答の例
[
  {
    "name":"devdomain.eng.filenet.com",
    "dn":"dc=devdomain,dc=eng,dc=filenet,dc=com"
  },
  {
    "name":"devdomain.eng.filenet.com",
    "dn":"dc=testdomain,dc=eng,dc=filenet,dc=com"
  }
]
表 27. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ステップ・エレメント

/p8/bpm/v1/queues/{queueName}/stepelements/{wobNum}

説明

キューから取得されたステップ・エレメント。

表 28. パス・エレメント
名前 説明
queueName String ステップ・エレメントが関連付けられているキューの名前。
wobNum String ワーク・オブジェクト (ステップ・エレメント) を識別する GUID。

アプリケーションの HTTP メソッド

GET

ステップ・エレメントの JSON 表記を取得します。

パラメーター

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/myqueue/stepelements/12345
表 29. 応答ヘッダー
名前 説明
ETag ステップ・エレメントのバージョンを識別します。このリソース上で PUT を実行するときに、この値を HTTP 要求ヘッダー If-Match 値として返します。

応答のコンテンツ

Mime タイプ: application/json

ステップ・エレメントについては、応答の「JSON スキーマ」を参照してください。

応答の例

ステップ・エレメントの応答例」を参照してください。

表 30. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
404 Not Found ワーク・アイテムが見つかりません。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

PUT

ステップ・エレメントを更新します。

表 31. パラメーター
必須かどうか 名前 データ型 説明
必要な action String 次のいずれかの値を指定します。
lock
ワーク・アイテムをロックします。
overrideLock
ワーク・アイテムをロックします。ワーク・アイテムが既にロックされている場合は、現在のロックが上書きされます。
save
ワーク・アイテムを更新し、ロック状態を維持します。要求のコンテンツで、GET 応答内で返された表記の更新されたバージョンを送信します。
saveAndUnlock
ワーク・アイテムを更新し、アンロックします。要求のコンテンツで、GET 応答内で返された表記の更新されたバージョンを送信します。
abort
ワーク・アイテムを更新しないでアンロックします。
dispatch
ワーク・アイテムを更新し、アンロックし、ワーク・アイテムをワークフロー内で進めます。要求のコンテンツで、GET 応答内で返された表記の更新されたバージョンを送信します。
returnToSource
ユーザーが最初にワーク・アイテムの再割り当てまたは委任を行ったキューにワーク・アイテムを戻します。
reassign
このステップの処理を行う参加者を変更します。このアクションには以下のパラメーターを指定できます。participant 以外はすべてオプションです。
?action=reassign&domain={domainName}&participant={userName}&delegateFlag=false&queueName=
domain
指定した場合、アクションは、指定された LDAP ドメインに見つかった現行ユーザーまたは指定されたユーザーにワーク・アイテムを再割り当てします。
participant
(必須) アクションは、ここで示されるユーザーにワーク・アイテムを再割り当てします。
delegateFlag
デフォルトで false が設定されます。true にした場合、再割り当てアクションは、後で確認できるようにフラグが付けられます。
queueName
指定した場合、これは、ワーク・アイテムの移動先のキュー名、null (現行ユーザーまたは指定されたユーザーのキューを示す)、 リテラル「Inbox」(現行ユーザーまたは指定されたユーザーの受信トレイにワーク・アイテムを移動する) の いずれかを含む文字列となります。デフォルト値は null です。
moveToInbox
ワーク・アイテムを現行ユーザーの受信トレイに移動します。
オプション responseContent integer このパラメーターは、action パラメーターが「lock」または「overrideLock」である場合にのみ有効です。これは、クライアントが 1 回の呼び出しでワーク・アイテムをロックし、その表記をフェッチできるメカニズムを提供します。

1 の値は、ステップ・エレメントの現在の表記が応答のコンテンツ内で返されることを示します。このパラメーターが指定されていない場合、あるいはこの値が「lock」または「overrideLock」以外である場合、ステップ・エレメントの表記は応答のコンテンツ (デフォルト) 内に含まれません。

表 32. 要求ヘッダー
必須かどうか 名前 説明
必要な If-Match ステップ・エレメントのバージョンを識別します。これは、GET 応答ヘッダー内で返された ETag 値である必要があります。

要求のコンテンツ

savesaveAndUnlock、および dispatch アクションの場合、GET 応答内で返された表記の更新されたバージョンを送信します。他のアクションの場合、要求のコンテンツは不要です。

ステップの応答が必要な場合、ステップ・エレメントの responses プロパティーには、可能な応答の配列が含まれます。ワーク・アイテムをディスパッチする前に、selectedResponse プロパティーを設定します。

変更されたすべてのデータ・フィールド、添付、またはワークフロー・グループ値に対して、modified プロパティーを true に設定します。modified プロパティーを設定しない場合、更新された値はサーバー上に保存されません。

Mime タイプ: application/json

ステップ・エレメントについては、応答の「JSON スキーマ」を参照してください。

要求の例
PUT http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/myqueue/stepelements/12345?action=overrideLock?responseContent=1
表 33. 応答ヘッダー
必須かどうか 名前 説明
必要な ETag ワーク・アイテムの新しい識別バージョン。ステップ・エレメントを更新するときに、この値を If-Match 要求ヘッダー値として返します。

応答のコンテンツ

アクションが「lock」または「overrideLock」であり、responseContent パラメーターが 1 に設定されている場合を除いて、コンテンツは返されません。この場合には、ステップ・エレメントの現在の表記が返されます。

Mime タイプ: application/json

ステップ・エレメントについては、応答の「JSON スキーマ」を参照してください。

応答の例

ステップ・エレメントの応答例」を参照してください。

表 34. エラー・コード
コード 説明
201 Created 正常終了 - ワークフローが起動されます。
404 Not Found ワーク・アイテムが見つかりません。
409 Conflict If-Match 要求ヘッダー値がステップ・エレメントの現在の ETag 応答ヘッダー値と一致しません。これは、ステップ・エレメントの表記が最後に取得された後で、ステップ・エレメントが変更されたことを示します。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ユーザー

/p8/bpm/v1/users

説明

ユーザーのコレクション。domain GET パラメーターを使用してドメインを指定することにより、 検索スコープを制限できます。ドメイン名が指定されていない場合、検索スコープにはすべてのドメインが含まれます。

パス・エレメント

なし。

アプリケーションの HTTP メソッド

GET

指定された検索パラメーターに基づいて、ユーザー情報を取得します。searchPattern パラメーター (非 NULL の場合) は、取得する表示名 (短縮名ではない) を指定します。

表 35. パラメーター
必須かどうか 名前 データ型 説明
必要な searchPattern String ユーザー表示名の一致の有無を判別する比較文字列。比較は、searchType パラメーターで指定されたメソッドに 従って実行されます。searchType パラメーターが 0 (SEARCH_TYPE_NONE) の場合、この値は NULL にすることができます。
必要な searchType Integer 指定された searchPattern の使用方法を判別します。これは、次のいずれかの整数値になります。
0 (SEARCH_TYPE_NONE)
searchPattern 文字列は無視され (指定した場合)、示されたスコープのユーザー名がすべて返されます。これにより、大容量データベースの場合はパフォーマンスが低下する可能性があります。
1 (SEARCH_TYPE_CUSTOM)
searchPattern 文字列が完全に一致した場合に返します。
2 (SEARCH_TYPE_PREFIX_MATCH)
searchPattern 文字列がユーザー名の先頭に完全に一致した場合に返します。
3 (SEARCH_TYPE_SUFFIX_MATCH)
searchPattern 文字列がユーザー名の末尾に完全に一致した場合に返します。
4 (SEARCH_TYPE_CONTAINS)
searchPattern 文字列がユーザー名の任意の場所に完全に一致した場合に返します。
(オプション) sortType Integer 返されたレコード・セットに対してセキュリティー・データベース・サーバーが実行するソートのタイプを 示します。セキュリティー・データベース・サーバーでソートが失敗すると、エラーが発生し、結果は返されません。sortType 値は、次のいずれかの整数値になります。
0 (SORT_TYPE_NONE)
結果のレコードをソートしません。

注意: 大容量のセキュリティー・データベースの場合、この指定によりパフォーマンスの低下や、誤った結果が生じる可能性が あります。バッファー・サイズの設定値は、(limit パラメーターによって指定された) 返されるレコードの最大数となり、返される実際のレコード数は、入力バッファー・サイズとディレクトリー・サーバー・サイズ制限のいずれか小さい数となります。

1 (SORT_TYPE_ASCENDING)
結果のレコードを昇順でソートします。
2 (SORT_TYPE_DESCENDING)
結果のレコードを降順でソートします。
オプション limit Integer 返されるレコードの最大数。この値が 0 (ゼロ) 以下の場合、デフォルトのバッファー・サイズ 200 が使用されます。
オプション domain String この要求のスコープとして使用するドメインの名前 (dn 形式が望ましい)。ドメイン名が指定されていない場合、検索スコープはすべてのドメインを指定します。
オプション searchAttribute Integer 以下のように、検索パターンに使用する LDAP 属性を指定します。
0 (DISPLAY_NAME)
検索パターンに表示名を使用することを指定します。 searchAttribute が指定されていない場合、これがデフォルト設定です。
1 (SHORT_NAME)
検索パターンに短縮名を使用することを指定します。

要求の例

文字 j で始まる (searchType=2) 表示名を持つユーザーを取得します。結果は、昇順でソートされ (sortType=1)、50 人のユーザーのバッチで表示されます。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/users?searchPattern=j&searchType=2&sortType=1&maxBufferSize=50
文字 j で始まる (searchType=2) 短縮名 (searchAttribute=1) を持つユーザーを取得します。結果は、昇順でソートされ (sortType=1)、50 人のユーザーのバッチで表示されます。
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/users?searchPattern=j&searchAttribute=1&searchType=2&sortType=1&maxBufferSize=50

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "description":"Contains a dynamic set of properties. The property names are the application space names.",
  "additionalProperties": 
  {
    "type":"object",
    "properties":
    {  
      "name":{"type":"string"},
      "rolenames": {"type":"string","format":"uri"} 
    }
  }		 		 
}
{ "type":"object",
  "properties": 
 {  
   "overLimit":{"type":"boolean"", "description":"Contains true if the value for the limit parameter is exceeded; false otherwise.},  
   "users": 
   { 
     "type":"array",
     "items": 
     { 
       "name":{"type":"string"}, 
       "displayName":{"type":"string"}, 
       "email":{"type:""string"} 
      }
    }
  }
}

応答の例

{ "overLimit":false,
  "users":
  [
    {"name":"jemima", "displayName":"jemima", "email":"jemima@ibm.com"},
    {"name":"jeffrey", "displayName":"jeffrey", "email":null}
  ]
}
表 36. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ワーク・バスケット

/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}

説明

指定されたキューに使用できるワーク・バスケットの名前、およびそのワーク・バスケットについての情報。

パス・エレメント

名前 説明
queue String ワーク・バスケットが関連付けられているキューの名前。
workbasket String ワーク・バスケットの名前。

アプリケーションの HTTP メソッド

GET

ワーク・バスケットを取得します。返されるワーク・バスケットには、ワーク・バスケットを定義している列、およびキューの照会やフィルタリングに関する情報が含まれています。

表 37. パラメーター
必須かどうか 名前 データ型 説明
オプション includeCustomAttributes Boolean 応答にカスタム属性情報を含めるかどうかを示します。この属性情報を含めるには、true 値を指定します。デフォルトで false が設定されます。
要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/myQueue/workbaskets/myWorkbasket?includeCustomAttributes=true

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "properties":
  {  
    "name":{"type":"string"},  
    "authoredName":{"type":"string"},
    "description":{"type":"string"}, 
    "columns": 
    {
      "type":"object",
      "description":"Contains a dynamic set of properties. The property names are the authored column names.",
      "additionalProperties":
      {		   
        "type":"object",
        "properties":
        {
          "name":{"type":"string","description":"Translated column name."}
          "type":{"type":"integer","description":"VWFieldType"},
          "prompt":{"type":"string"},
          "sortable":{"type":"boolean"},
          "ordinal":{"type":"integer"},
          "attributes":{"type":"string","format":"uri"},
          "customAttributes": 
          {
            "type":"object",
            "description":"Included in the response only if the value of the includeCustomAttributes parameter is true.",
            "additionalProperties":
            {  
              "type":"object",
              "properties":
              {
                "name":{"type":"string"},
                "type":{"type":"integer"},
                "isArray":{"type":"boolean"},
                "value":{"type":["string", "number", "boolean", "array"]}
              }
            }
          }
        }
      }		 		 
    }
    "filters" : 
    {
      "type":"object",
      "additionalProperties":
      {
        "type":"object",
        "properties":
{
          "name":{"type":"string"},
          "prompt":{"type":"string"},
          "description":{"type":"string"},
          "type":{"type":"integer"},
          "operator":{"type":"integer"},
          "attributes":{"type":"string" ,"format":"uri"}
          "searchFieldName":{"type":"string" ,"description":"authored column name that filter is based on"},
          "customAttributes": 
          {
            "type":"object",
            "description":"Included in the response only if the value of the includeCustomAttributes parameter is true.",
            "additionalProperties":
            {  
              "type":"object",
              "properties":
              {
                "name":{"type":"string"},
                "type":{"type":"integer"},
                "isArray":{"type":"boolean"},
                "value":{"type":["string", "number", "boolean", "array"]}
              }
            }
          }
        }
      }
    }
    "queueType":{"type":"integer","description":"Possible values are: 1 - Indicates the queue is a process queue, 2 - Indicates the queue is a user queue (such as inbox), or 3 - Indicates the queue is a system queue."},
    "attributes":{"type":"string","format":"uri"},
    "customAttributes": 
    {
      "type":"object",
      "description":"Included in the response only if the value of the includeCustomAttributes parameter is true.",
      "additionalProperties":
      {  
        "type":"object",
        "properties":
        {
          "name":{"type":"string"},
          "type":{"type":"integer"},
          "isArray":{"type":"boolean"},
          "value":{"type":["string", "number", "boolean", "array"]}
        }
      }
    }
    "queueElements":{"type":"string","format":"uri"},
    "queueElementsCount":{"type":"string", "format":"uri"}
  }		 
}
応答の例
{
  "name":"myWorkbasketTranslated", 
  "authoredName":"myWorkbasket",
  "description":"Workbasket description",
  "columns": 
  {
    "integerCol":
    {
      "name":"integerCol", 
      "prompt":"Integer Column", 
      "type":1,
      "sortable":true,
      "ordinal":0,
      "attributes":"queues/myQueue/workbaskets/Initial/columns/integerCol/attributes",
      "customAttributes" :
      {
        "Color":
        {
          "name":"Color",
          "type":2,
          "isArray":false,
          "value":"Red"
        },
        "Colors":
        {
          "name":"Colors",
          "type":2,
          "isArray":true,
          "value":["Red","Blue","Green"]
        }
      }             
    }
  },
  "filters":
  {
    "integerCol":
{
      "name":"integerFilter", 
      "prompt":"Integer Filter", 
      "description":"Filter description",
      "type":1,
      "operator":0,
      "attributes":"queues/myQueue/workbaskets/Initial/filters/integerFilter/attributes"
      "searchFieldName": "integerSearchFieldCol",
      "customAttributes" :
      {
        "Color":
        {
          "name":"Color",
          "type":2,
          "isArray":false,
          "value":"Red"
        },
        "Colors":
        {
          "name":"Colors",
          "type":2,
          "isArray":true,
          "value":["Red","Blue","Green"]
        }
      }             
    }
  },
  "queueType":2,
  "attributes":"queues/myQueue/workbaskets/myWorkbasket/attributes",
  "customAttributes":
  {
    "Color":
    {
      "name":"Color",
      "type":2,
      "isArray":false,
      "value":"Red"
    },
    "Colors":
    {
      "name":"Colors",
      "type":2,
      "isArray":true,
      "value":["Red","Blue","Green"]
    }
  }             
  "queueElements":"queues/myQueue/workbaskets/myWorkbasket/queueelements",
  "queueElementsCount":"queues/myQueue/workbaskets/myWorkbasket/queueelements/count"
}
表 38. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ワーク・バスケット属性

/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/attributes

説明

指定されたキューの使用可能なワーク・バスケットの属性。

表 39. パス・エレメント
名前 説明
queue String ワーク・バスケットが関連付けられているキューの名前。
workbasket String ワーク・バスケットの名前。

アプリケーションの HTTP メソッド

GET

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/myQueue/workbaskets/myWorkbasket/attributes

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "description":"Contains a dynamic set of properties. プロパティー名は属性名です。",
  "additionalProperties": 
  {  
    "type":"object",
    "properties":
    {
      "name":{"type":"string"},
      "type":{"type":"integer"},
      "isArray":{"type":"boolean"},
      "value":{"type":["string", "number", "boolean", "array"]}
    }
  }
}
応答の例
{
  "Color":
  {
    "name":"Color",
    "type":2,
    "isArray":false,
    "value":"Red"
  }
  "Colors":
  {
    "name":"Colors",
    "type":2,
    "isArray":true,
    "value":["Red","Blue","Green"]
  }
}
表 40. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ワーク・バスケット列

/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/columns

説明

ワーク・バスケットの列の定義。ウィジェットでワーク・バスケットの定義全体 (Workbasket.GET で返される) でなく、列の定義のみ必要な場合に、このリソースを呼び出します。

表 41. パス・エレメント
名前 説明
queue String ワーク・バスケットが関連付けられているキューの名前。
workbasket String ワーク・バスケットの名前。

アプリケーションの HTTP メソッド

GET

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/myQueue/workbaskets/myWorkbasket/columns

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "description":"Contains a dynamic set of properties. The property names are the authored column names.",
  "additionalProperties": 
  {
    "type":"object",
    "properties":
    {  
      "name":{"type":"string","description":"Translated column name."}
      "type":{"type":"integer","description":"VWFieldType"},
      "prompt":{"type":"string"},
      "sortable":{"type":"boolean"},
      "ordinal":{"type":"integer"},
      "attributes":{"type":"string" ,"format":"uri"}
    }   
  }             
}
応答の例
{
  "integerCol":
  {
    "name":"integerCol", 
    "prompt":"Integer Column", 
    "type":1, 
    "sortable":true,    
    "attributes":"queues/myQueue/workbaskets/myworkbasket/columns/integerCol/attributes"
  },
  "stringCol":
  {
    "name":"stringCol", 
    "prompt":"String Column", 
    "type":2, 
    "sortable":false, 
    "attributes":"queues/myQueue/workbaskets/myworkbasket/columns/stringCol/attributes"
  }
}
表 42. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ワーク・バスケット列属性

/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/columns/{columnName}/attributes

説明

ワーク・バスケットに定義された列の属性。

表 43. パス・エレメント
名前 説明
queue String ワーク・バスケットが関連付けられているキューの名前。
workbasket String ワーク・バスケットの名前。
columnName String 列の名前。

アプリケーションの HTTP メソッド

GET

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/myQueue/workbaskets/myWorkbasket/columns/ColName/attributes

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "description":"Contains a dynamic set of properties. プロパティー名は属性名です。",
  "additionalProperties": 
  {
    "type":"object",
    "properties":
    {  
      "name":{"type":"string","description":"Translated column name."}
      "type":{"type":"integer","description":"VWFieldType"},
      "isArray":{"type":"boolean"},
      "value":{"type":["string", "number", "boolean", "array"]}
    }   
  }             
}
応答の例
{
  "Color":
  {
    "name":"Color",
    "type":2,
    "isArray":false,
    "value":"Red"
  }
  "Colors":
  {
    "name":"Colors",
    "type":2,
    "isArray":true,
    "value":["Red","Blue","Green"]
  }
}
表 44. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ワーク・バスケット・フィルター

    /p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/filters

説明

ワーク・バスケットのフィルターの定義。ウィジェットでワーク・バスケットの定義全体 (Workbasket.GET で返される) でなく、フィルターの定義のみ必要な場合に、このリソースを呼び出します。

パス・エレメント

名前 説明
queue String ワーク・バスケットが関連付けられているキューの名前。
workbasket String ワーク・バスケットの名前。

アプリケーションの HTTP メソッド

GET

なし

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/myQueue/workbaskets/myWorkbasket/filters

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:

{ "type":"object",
  "description":"Contains a dynamic set of properties. プロパティー名は作成されたフィルター名です。",
  "additionalProperties":
  {       
    "type":"object",
    "properties":
    {
      "name":{"type":"string","description":"Translated filter name."}
      "type":{"type":"integer","description":"VWFieldType"},
      "prompt":{"type":"string"},
      "description":{"type":"string"},
      "operator":{"type":"integer"},
      "searchFieldName":{"type":"string" ,"description":"authored column name that filter is based on"},
      "attributes":{"type":"string","format":"uri"}
    }
  }             
}

応答の例

{
  "integerCol":
  {
    "name":"integerCol", 
    "type":1,
    "operator":0,
    "prompt":"Integer Column",
    "description":"Filter description",
    "searchFieldName": "integerField",
    "attributes":"queues/myQueue/workbaskets/MyWorkbasket/filters/CompanyName/attributes"
  }
}

エラー・コード

コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ワーク・バスケット・フィルター属性

/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/filters/{filter}/attributes

説明

ワーク・バスケットに定義されているフィルターの属性。

表 45. パス・エレメント
名前 説明
queue String ワーク・バスケットが関連付けられているキューの名前。
workbasket String ワーク・バスケットの名前。
filter String フィルターの名前。

アプリケーションの HTTP メソッド

GET

なし

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/queues/myQueue/workbaskets/myWorkbasket/filters/CompanyName/attributes

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "description":"Contains a dynamic set of properties. プロパティー名は属性名です。",
  "additionalProperties": 
  {  
    "type":"object",
    "properties":
    {
      "name":{"type":"string"},
      "type":{"type":"integer"},
      "isArray":{"type":"boolean"},
      "value":{"type":["string", "number", "boolean", "array"]}
    }
  }
}
応答の例
{
  "Color":
  {
    "name":"Color",
    "type":2,
    "isArray":false,
    "value":"Red"
  }
  "Colors":
  {
    "name":"Colors",
    "type":2,
    "isArray":true,
    "value":["Red","Blue","Green"]
  }
}
表 46. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ワーク・クラス

/p8/bpm/v1/workclasses/{workclassName}

説明

ワーク・クラス (ワークフロー) 表現。これは、ワークフローのプロパティー、パラメーター、添付、およびワークフロー・グループのコレクションです。

表 47. パス・エレメント
名前 説明
workclassName String 使用可能なワーク・クラス (ワークフロー) の名前。

アプリケーションの HTTP メソッド

GET

ワーク・クラス起動ステップのフィールドを取得します。要求ヘッダーの POE パラメーターを 1 に設定 (POE:1) して呼び出すと、応答ヘッダーの POE-Links パラメーターの値が、ワークフローの起動に使用できるワーク・クラス起動ステップのリソースになります。POE パラメーターが 1 以外の値に設定された場合、このパラメーターは無視されます。

パラメーター

なし

表 48. 要求ヘッダー
必須かどうか 名前 説明
オプション POE このパラメーターを値 1 に設定 (POE:1) すると、起動ステップ・エレメントの情報が取得されます。起動ステップ・エレメントのリソースは、応答ヘッダーの POE-Links パラメーターで返されます。
要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/workclasses/myWorkclass
表 49. 応答ヘッダー
名前 説明
POE-Links (起動ステップ・リソース。「起動ステップ・エレメント」を参照) ワーク・クラス起動ステップの識別ワーク・オブジェクト番号。オプションの POE パラメーターを値 1 (POE:1) に設定した場合、この情報は応答ヘッダーで返されます。

応答のコンテンツ

Mime タイプ: application/json

ステップ・エレメントについては、応答の「JSON スキーマ」を参照してください。

応答の例

ステップ・エレメントの応答例」を参照してください。

表 50. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ワーク・クラス

/p8/bpm/v1/workclasses

説明

使用可能なワーク・クラス (ワークフロー) のコレクション。

パス・エレメント

なし

アプリケーションの HTTP メソッド

GET

起動できるワーク・クラスのコレクションを取得します。

パラメーター

なし

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/workclasses

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "description":"Contains a dynamic set of properties. プロパティー名はワーク・クラス名です。",
  "additionalProperties":
  {
    "type":"object",
    "properties":
    {
      "URI":{"type":"string" ,"format":"uri"},
      "name":{"type":"string"}
    }
  }
}
応答の例
{
  "QFieldTestWithResponseAndDeadlines":
  {
    "URI":"workclasses/QFieldTestWithResponseAndDeadlines",
    "name":"QFieldTestWithResponseAndDeadlines" },
  "QFieldTest":
  {
    "URI":"workclasses/QFieldTest","name":"QFieldTest"  }
  }
}
表 51. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ワークフローのマイルストーン

/p8/bpm/v1/rosters/{rosterName}/workflowNumber/{workflowID}/milestones

説明

ワークフローのマイルストーン。

表 52. パス・エレメント
名前 説明
rosterName String ワークフロー・エレメントが関連付けられているロスターの名前。
workflowID String ワークフロー・オブジェクトを識別する GUID

アプリケーションの HTTP メソッド

GET

ワークフロー・エレメントのマイルストーン・セットを取得します。

表 53. パラメーター
必須かどうか 名前 データ型 説明
オプション レベル Integer 1 から 99 までの整数値 (これらの値を含む)。制限レベルとして使用するマイルストーン・レベルを 示します。この値以下のレベル値を持つマイルストーンのみが、イベント・ログから取得されます。
オプション reachedOnly Boolean 値 true は、取得操作が、到達したマイルストーン・オブジェクトに制限されることを示します。値 false は、マイルストーンに到達したかどうかに関係なく取得が行われ、マイルストーンが実行順に返されることを示します。この場合、返されるマイルストーンの順序は、IBM FileNet Process Designer で指定された順序によって決定されます。指定しない場合、デフォルトで false になります。
オプション lastOnly Boolean 値 true は、マイルストーンの最後の実行を反映するオブジェクトのみが返されることを示します。マイルストーンが複数回実行されている場合でも、1 つのマイルストーンに対して 1 つのオブジェクトのみが返されます。値 false は、マイルストーンが複数回実行されている場合、1 つのマイルストーンに対して複数のオブジェクトが返されることを示します。指定しない場合、デフォルトで true になります。
要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/rosters /myRoster/workflowNumber/12345/milestones

応答のコンテンツ

MIME タイプ: application/json

JSON スキーマ:
{ "type": "array",
  "items":
    {
        "type":"object",
        "properties":
        {
            "name":{"type":"string"},
            "level":{"type":"integer"},
            "reached":{"type":"boolean"},
            "message":{"type":"string"},
            "milestoneId":{"type":"integer"},
            "timestamp":{"type":"string", "format":"date-time"},
            "mapName":{"type":"string"},
            "mapId":{"type":"integer"},
            "stepId":{"type":"integer"},
        }
    }
}
応答の例:
[
  {
    "name":"Milestone A",
    "level":1,
    "reached":true,
    "message":"Milestone A has been reached",
    "milestoneId":1",
    "timestamp":"2009-04-16'T'14:36:25Z",
    "mapName":"Workflow",
    "mapId":-2,
    "stepId":5
  },
  {
    "name":"Milestone B",
    "level":1,
    "reached":false,
    "message":"",
    "milestoneId":1",
    "timestamp":"",
    "mapName":"Workflow",
    "mapId":-1,
    "stepId":-1
  }
]
表 54. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
404 Not Found ワーク・アイテムが見つかりません。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

書き込み可能アプリケーション・スペース (コレクション)

/p8/bpm/v1/writableappspaces

説明

現在のユーザーが書き込み権限を保持するアプリケーション・スペースのコレクション。

パス・エレメント

なし

アプリケーションの HTTP メソッド

GET

現在のユーザーが書き込み権限を保持するアプリケーション・スペースのコレクションを取得します。

パラメーター

なし

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/writableappspaces

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "description":"Contains a dynamic set of properties. プロパティー名は許可されたアプリケーション・スペース名です。",
  "additionalProperties":
  {
    "type":"object",
    "properties":
    {
      "name":{"type":"string"},
      "description":{"type":"string"},
      "appspace":{"type":"string", "format":"uri"}
    }   
  }
}
応答の例
{ 
  "Autoclaim":
  { 
    "name":" Autoclaim",
    "description":"The Autoclaim app space", 
    "appspace":"writableappspaces/Autoclaim"
  },
  "Healthclaim":
  { 
    "name":"Healthclaim"
    "description":"The Healthclaim app space",
    "appspace":"writableappspaces/Healthclaim"
  }
}
表 55. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

書き込み可能アプリケーション・スペース

/p8/bpm/v1/writableappspaces/{appspace}

説明

現行ユーザーが書き込み権限を保持する 1 つのアプリケーション・スペース。返されるアプリケーション・スペース・オブジェクトには ロール情報が含まれるため、このリソースを使用してロール・リソースを構成できます。

表 56. パス・エレメント
名前 説明
appspace String アプリケーション・スペースの名前。現行ユーザーは、アプリケーション・スペースに対して書き込み権限を持っている必要があります。

アプリケーションの HTTP メソッド

GET

現行ユーザーが書き込み権限を保持する 1 つのアプリケーション・スペースを取得します。

パラメーター

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/writableappspaces/Autoclaim

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "properties":
  {
    "name":{"type":"string"},
    "authoredName":{"type":"string"},
    "description":{"type":"string"},
    "roles":{"type":"string", "format":"uri"}
    "attributes":
    { 
      "type":"object",
      "additionalProperties": 
      {  
        "type":"object",
        "description":"Contains a dynamic set of properties. プロパティー名は属性名です。",
        "properties":
        {
          "name":{"type":"string"},
          "type":{"type":"integer", 
          "description":"VWFieldType"},
          "isArray":{"type":"boolean"},
          "value":{"type":["string","number", "boolean", "array"]}
        }
      }
    }
  }
}                       
応答の例
{ 
  "name":" Autoclaim",
  "authoredName":"Autoclaim",
  "description":"The Autoclaim application space.", 
  "roles":"writableappspaces/Autoclaim/roles",
  "attributes":{}
}
表 57. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

書き込み可能アプリケーション・スペース・ロール

/p8/bpm/v1/writableappspaces/{appSpace}/roles/{role}

説明

アプリケーション・スペース用に定義された 1 つのロール。現行ユーザーは、アプリケーション・スペースに対して書き込み権限を持っている必要があります。

表 58. パス・エレメント
名前 説明
appspace String ロールを含むアプリケーション・スペースの名前。現行ユーザーは、アプリケーション・スペースに対して書き込み権限を持っている必要があります。
role String ロールの名前。

アプリケーションの HTTP メソッド

GET

アプリケーション・スペースに対して指定されたロールを取得します。これらのロール名は、ロールの定義時にアイソレート・リージョン構成で 指定された順に返されます。

パラメーター

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/writableappspaces/Autoclaim/roles/manager

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "properties":
  {  
    "name":{"type":"string"},
    "authoredName":{"type":"string"},
    "description":{"type":"string"},
    "homePage":{"type":"string"},
    "attributes":{"type":"string" ,"format":"uri"},
    "members":{"type":"string", "format":"uri"},
    "workbaskets": 
        {
      "type":"object",
      "additionalProperties:
      {
        "type":"object",
        "properties":
        {
          "name":{"type":"string"},
          "URI":{"type":"string","format":"uri"}
        }
      } 
    }
    "orderedWorkbaskets": 
    {
      "type":"array",
      "description":"Contains a dynamic set of properties. プロパティー名は作成されたワーク・バスケット名です。作成時に指定した順序になります。",
      "items":
      {
        "name":{"type":"string"},
        "URI":{"type":"string","format":"uri"}
      }
    }
  }
}
応答の例
{
  "name":"ReviewerTranslated",
  "authoredName":"Reviewer",
  "description":"A reviewer role",
  "homePage":"AutoClaimReview.html",
  "attributes":"writableappspaces/AutoClaim/roles/Reviewer/attributes",
  "members":"writableappspaces/AutoClaim/roles/Reviewer/members",
  "workbaskets":
  {
    "Initial":{"name":"Initial", "URI":"queues/MyQueue/workbaskets/Initial"},
    "Appeal":{"name":"Appeal", "URI":"queues/MyQueue/workbaskets/Appeal"}
  },
  "orderedWorkbaskets":
  [
    {name":"Initial","URI":"queues/MyQueue/workbaskets/Initial"},
    {name":"Appeal","URI":"queues/MyQueue/workbaskets/Appeal"}
  ]
}
表 59. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

書き込み可能アプリケーション・スペース・ロール (コレクション)

/p8/bpm/v1/writableappspaces/{appSpace}/roles

説明

アプリケーション・スペース用に定義されたロールのコレクション。現行ユーザーは、アプリケーション・スペースに対して書き込み権限を持っている必要があります。

パス・エレメント

名前 説明
appspace String ロールのコレクションを含むアプリケーション・スペースの名前。

アプリケーションの HTTP メソッド

GET

アプリケーション・スペースのロールのコレクション全体を取得します。

パラメーター

なし。

要求の例
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/writableappspaces/Autoclaim/roles

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"object",
  "description":"Contains a dynamic set of properties. プロパティー名は許可されたアプリケーション・スペース名です。",
  "additionalProperties":
  {
    "type":"object",
    "properties":
    {
      "name":{"type":"string"},
      "description":{"type":"string"},
      "role":{"type":"string", "format":"uri"}
    }
  }
}
応答の例
{ 
  "Agent":
  { 
    "name":"Agent", 
    "description":"An agent role",
    "role":" writableappspaces/Autoclaim/roles/Agent"
  },
  "Manager":
  {
    "name":"Manager", 
    "description":"A manager role", 
    "role":"writableappspaces/Autoclaim/roles/Manager"
  }
}
表 60. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

書き込み可能アプリケーション・スペース・ロール・メンバー

/p8/bpm/v1/writableappspaces/{appspace}/roles/{role}/members

説明

指定されたロールのメンバーのセット。

表 61. パス・エレメント
名前 説明
appspace String ロールを含むアプリケーション・スペースの名前。現行ユーザーは、アプリケーション・スペースに対して書き込み権限を持っている必要があります。
role String ロールの名前。

アプリケーションの HTTP メソッド

GET

ロールに割り当てられたメンバーのセットを取得します。アプリケーション・スペース内の任意のロールのメンバーである場合、またはアプリケーション・スペースに対する書き込み権限がある場合は、ロールの参加者を読み取ることができます。

パラメーター

なし

要求の例

GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/writableappspaces/Autoclaim/roles/Manager/members
GET http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/writableappspaces/Autoclaim/roles/Manager/members

応答のコンテンツ

Mime タイプ: application/json

JSON スキーマ:
{ "type":"array",
  "items": 
  { 
    "name":{"type":"string"}, 
    "displayName":{"type":"String"}, 
    "email":{"type":"string"}, 
    "isGroup":{"type":"Boolean"} 
  }
}
応答の例
[
  {
    "name":"jsmith", 
    "displayName":"John Smith", 
    "email":"jsmith@filenet.com", 
    "isGroup":false
  },
  {
    "name":"agents", 
    "displayName":"Claim Agents", 
    "email":"", 
    "isGroup":true
  }
]
表 62. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
400 Not Found ロールが存在しません。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

書き込み可能アプリケーション・スペース・ロール・メンバーの更新

/p8/bpm/v1/writableappspaces/{appspace}/roles/{role}/members

説明

指定されたロールのロール・メンバーシップを更新します。現行ユーザーは、アプリケーション・スペースに対して書き込み権限を持っている必要があります。

表 63. パス・エレメント
名前 説明
appspace String アプリケーション・スペースの名前。
role String ロールの名前。

アプリケーションの HTTP メソッド

PUT

ロールに対してメンバーを追加または削除することで、指定したロールのロール・メンバーシップを更新します。現行ユーザーは、アプリケーション・スペースに対して書き込み権限を持っている必要があります。

パラメーター

なし

要求の例

PUT http://restHost:8000/myContext/P8BPMREST/p8/bpm/v1/writableappspaces/Autoclaim/roles/Manager/members

要求のコンテンツ

追加 (additionList) または削除 (deletionList) 操作ごとに JSON 文字列配列が存在する必要があります。この配列の各文字列は、追加または削除の対象となるメンバーのユーザーまたはグループの短縮名です。 詳細については、『ステップ・エレメントの JSON 表記』を参照してください。

Mime タイプ: application/json

JSON スキーマ:
{ "type": object",
  "properties":
  {
    "deletionList":
    {
      "type":"array",
      "items": {"type":"string"}
    }
    "additionList":
    {
      "type":"array",
      "items": {"type":"string"}
    }
  }
}
要求のコンテンツの例
{
  "deletionList"
    ["msmith", "agupta"],
  "additionList"
    ["bjones"]
}

応答のコンテンツ

なし

表 64. エラー・コード
コード 説明
200 OK 正常終了 - 要求したデータが返されます。
400 Not Found ロールが存在しません。
500 Internal Server Error 重大な問題、プログラマー向けの詳細情報が提供されます。

ステップ・エレメントの JSON 表記

ステップ・エレメントおよび起動ステップ・エレメント・リソースには、応答コンテンツ用の共通 JSON スキーマがあります。起動ステップ・エレメントの POST 要求コンテンツも、このスキーマを共有します。

ステップに応答が必要ない場合は、systemProperties オブジェクトの responses プロパティーは、空の配列になります。この場合、selectedResponse プロパティーは存在しません。

ステップに応答が必要な場合、responses プロパティーには応答の名前の配列が含まれ、selectedResponse プロパティーが存在します。クライアントは、ステップ・エレメント・オブジェクトをサーバーに送信して保存またはディスパッチする前に、selectedResponse プロパティーを responses プロパティーで返されるいずれかの値に設定する必要があります。

systemProperties オブジェクトの一部のプロパティーは、起動ステップ・エレメントに適用されず、ステップ・エレメントの systemProperties コンテンツにのみ存在します。これらのプロパティーは、以下のとおりです。

  • 期限
  • reminder
  • launchDate
  • overdueStatus
  • originator
  • sourceDoc
  • workobjectNumber
  • workflowNumber
  • comment
  • lockedById
  • milestones
{ "type":"object",
  "propeties":
  {
    "systemProperties":
    {
      "type":"object",
      "properties":
      {
        "workflowName":{"type":"string"},
        "subject":{"type":"string"},
        "instruction":{"type":"string"},
        "stepName":{"type":"string"},
        "caseFolderId":{"type":"string", "description":"The GUID value identifying the folder."},
        "caseTaskId":{"type":"string", "description":"The GUID value identifying the activity."},
        "canReassign":{"type":"boolean"},
        "canReturnToSource":{"type":"boolean"},
        "stepId":{"type":"integer"},
        "mapName":{"type":"string"},
        "authoredMapName":{"type":"string"},
        "deadline":{"type":"string","description":"In Step Element Only"},
        "launchDate":{"type":"string","format":"date-time"},
        "reminder":{"type":"string","format":"date-time"},
        "overdueStatus":{"type":"integer", "enum":[0,1,2]},
        "originator":{"type":"string"},
        "sourceDoc":{"type":"string"},
        "workObjectNumber":{"type":"string"},
        "workflowNumber":{"type":"string"},
        "comment":{"type":"string"},
        "lockedBy":{"type":"string", "description":"Contains the name of the user who has the work item locked."},
        "lockedById":{"type":"integer", "description":"Contains the id of the user who has the work item locked. This will be -1 if the work item is not locked."},
        "milestones":{"type":"string","format":"uri"},
        "responses":
        {
          "type":"array",
          "items":{"type":"string"}
        }
        "selectedResponse":{"type":"string"}   
      }
    }
    "dataFields":
    {
      "type":"object",
      "description":"Contains a dynamic set of properties. プロパティー名は作成されたデータ・フィールド名です。",
      "additionalProperties":
      {
        "type":"object",
        "properties":
        {
          "name":{"type":"string","description":"Translated data field name."},
          "type":{"type":"integer","description":"VWFieldType"},
          "isArray":{"type":"boolean"},
          "mode":{"type":"integer","description":"VWModeType"},
          "desc":{"type":"string"},
          "modified":{"type":boolean","description":"When a client modifies a data field it should set this property to true."},
          "value":{"type":["string","number","boolean","array"]}
        }
      }
    }
    "attachments":
    {
      "type":"object",
      "description":"Contains a dynamic set of properties. プロパティー名は作成された添付名です。",
      "additionalProperties":
      {
        "type":"object",
        "properties":
        {
          "name":{"type":"string","description":"Translated attachment name."},
          "type":{"type":"integer","description":"VWFieldType"},
          "isArray":{"type":"boolean"},
          "mode":{"type":"integer","description":"VWModeType"},
          "desc":{"type":"string"},
          "modified":{"type":boolean","description":"When a client modifies an attachment it should set this property to true."},
          "value":
          {
            "type":["object","array"],
            "properties":
            {
              "title":{"type":"string"},
              "desc":{"type":"string"},
              "libraryName":{"type":"string"},
              "libraryType":{"type":"integer"},
              "type":{"type":"integer"},
              "vsId":{"type":"string"},
              "version":{"type":"string"}
            }
          }     
        }
      }
    }
    "workflowGroups":
    {
      "type":"object",
      "description":"Contains a dynamic set of properties. プロパティー名は作成されたワークフロー・グループ名です。",
      "additionalProperties":
      {
        "type":"object",
        "properties":
        {
          "name":{"type":"string","description":"Translated workflow group name."},
          "type":{"type":"integer","description":"VWFieldType"},
          "isArray":{"type":"boolean"},
          "mode":{"type":"integer""description":"VWModeType"},
          "desc":{"type":"string"},
          "modified":{"type":boolean","description":"When a client modifies a workflow group it should set this property to true."},
          "value":
          {
            "type":"array",
            "items":{"type":"string"}
          }
        }
      }
    }
    "stepProcessor":
    {
      "type":"object",
      "properties":,
      {
        "name":{"type":"string"},
        "id":{"type":"integer"},
        "appType":{"type":"string"},
        "processorType":{"type":"string"},
        "width":{"type":"integer"},
        "height":{"type":"integer"},
        "applicationName":{"type":"string"},
        "locations":
        {
          "type":"object",
          "description":"Contains a dynamic set of properties. プロパティー名は Web アプリケーション ID です。 各プロパティーの値は、その Web アプリケーションのステップ・プロセッサーの場所です。",
          "additionalProperties":{"type":"string"}
        }
      }
    }
  }
}
ステップ・エレメントの応答例
"systemProperties":
{
  "workflowName":"QFieldTest",
  "subject":"QFieldTest",
  "instruction":"",
  "stepName":"LaunchStep",
  "stepId":1,
  "mapName":"Workflow",
  "authoredMapName":"Workflow",
  "deadline":"2008-01-13T19:49:00Z",
  "reminder":"2008-02-13T19:49:00Z",
  "launchDate":"2008-03-13T19:49:00Z",
  "overdueStatus":1,
  "originator":"jsmith",
  "sourceDoc":"",
  "workObjectNumber":"",
  "workflowNumber":"",
  "comment":"This is a cool step",
  "lockedBy":"elijah",
  "lockedById":"23",
  "milestones":"/context/P8BPMREST/p8/bpm/v1/queues/{queue}/stepelements/{wobnum}/milestones",
  "responses": ["Yes","No"]
  "selectedResponse":"Yes"
}
"attachments":
{
  "supportingDocs":
  {
    "name":"supportingDocs",
    "value":
    [
      {
        "title":"Credit Report1",
        "desc":"",
        "libraryName":"peru",
        "libraryType":3,
        "type":3,
        "vsId":"{F34061E3-ACB4-4223-B7B9-0F173F72DD15}",
        "version":"-1"
      },
      {
        "title":"Bank Statement1",
        "desc":"",
        "libraryName":"peru",
        "libraryType":3,
        "type":2,
        "vsId":"{70E15871-20AF-4784-9307-797CA0618C5C}",
        "version":""
      }
    ],
    "type":32,
    "isArray":true,
    "mode":3,
    "desc":"",
    "modified":false
  },
  "application":
  {
    "name":"application",
    "value":{},
    "type":32,
    "isArray":false,
    "mode":1,
    "desc":""
  }
}
"dataFields":
{
  "QBool":
  {
    "name":"QBool",
    "value":true,
    "type":4,
    "isArray":false,
    "mode":1,
    "desc":""
  },
  "QString":
  {
    "name":"QString",
    "value":"red",
    "type":2,
    "isArray":false,
    "mode":2,
    "desc":"",
    "modified":false
  },
  "QFloatArray":
  {
    "name":"QFloatArray",
    "value":[500.0,400.0,300.0,200.0,100.0],
    "type":8,
    "isArray":true,
    "mode":3,
    "desc":"",
    "modified":false
  },
  "QFloat":
  {
    "name":"QFloat",
    "value":3.14,
    "type":8,
    "isArray":false,
    "mode":3,
    "desc":"",
    "modified":false
  },
  "QTime":
  {
    "name":"QTime",
    "value":"2008-07-24T18:56:10-0700",
    "type":16,
    "isArray":false,
    "mode":3,
    "desc":"",
    "modified":false
  },
  "QTimeArray":
  {
    "name":"QTimeArray",
    "value":["2008-07-24T18:56:10-0700","2008-07-24T18:56:10-0700"],
    "type":16,
    "isArray":true,
    "mode":3,
    "desc":"",
    "modified":false
  },
  "QBoolArray":
  {
    "name":"QBoolArray",
    "value":[],
    "type":4,
    "isArray":true,
    "mode":3,
    "desc":"",
    "modified":false
  },
  "QStringArray":
  {
    "name":"QStringArray",
    "value":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],
    "type":2,
    "isArray":false,
    "mode":3,
    "desc":"",
    "modified":false
  },
  "QInt":
  {
    "name":"QInt",
    "value":100,
    "type":1,
    "isArray":false,
    "mode":3,
    "desc":"",
    "modified":false
  },
  "QIntArray":
  {
    "name":"QIntArray",
    "value":[0,1,2,3],
    "type":1,
    "isArray":true,
    "mode":3,
    "desc":"",
    "modified":false
  }
}
"workflowGroups":
{
  "QGroup1":
  {
    "name":"QGroup1",
    "value":["QGroup1","QGroup1GParent","QGroup1Parent"],
    "type":64,
    "isArray":true,
    "mode":3,
    "desc":"",
    "modified":false
  }
}
"stepProcessor":
{
  "width":800,
  "processorType":1,
  "height":600,
  "applicationName":"",
  "appType":32,
  "name":"Approval Launch HTML (FileNet)",
  "id":6,
  "locations":
  {
    "7":"html/ootb/LaunchApproval.jsp",
    "1":"html/ootb/LaunchApproval.jsp"
  }
}


最終更新日: 2015 年 10 月
rest_ref.htm

© Copyright IBM Corp. 2015.