Blue Prism API (7.0.0)

Download OpenAPI specification:Download

Blue Prism製品のコア機能を明らかにするAPI

Blue Prism agreements: https://portal.blueprism.com/agreements

Authentication

Bearer

Authentication Serverから発行されたJWTトークン

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

OAuth2

Security Scheme Type	OAuth2
clientCredentials OAuth Flow	Token URL: https://auth-server/connect/token Scopes: `bp-api` - API scope `bpserver` - Blue Prism Application scope

ダッシュボード

要求された各キューのワークキューの集計データを返す。

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

query Parameters

workQueueIds

required

Array of strings <uuid>

データを取得するワークキューIDの配列。

Responses

Response samples

200
400
401
403

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"completed": 0,
"pending": 0,
"deferred": 0,
"locked": 0,
"exceptioned": 0
}
]

ランタイムリソースの使用状況を返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

query Parameters

startDate required	string <date-time> 開始日
resourceIds	Array of strings <uuid> フィルターを適用するリソースIDの配列。
pageNumber	integer 使用状況ヒートマップのデータページングに使用するページ番号パラメーター。
pageSize	integer 使用状況ヒートマップのデータページングに使用するページサイズのパラメーター。

Responses

Response samples

200
400
401
403

Content type

application/json

[{"resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
"digitalWorkerName": "string",
"utilizationDate": "2020-10-02T12:34:56+02:00",
"usages": [0
]
}
]

日付範囲別のランタイムリソースの使用状況の概要を返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

query Parameters

startDate required	string <date-time> 開始日
endDate required	string <date-time> 終了日
resourceIds	Array of strings <uuid> フィルター適用対象のリソースID。

Responses

Response samples

200
400
401
403

Content type

application/json

[{"dates": "2020-10-02T12:34:56+02:00",
"usage": 0
}
]

暗号化方式

環境内の暗号化方式のリストを返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

Responses

Response samples

200

Content type

application/json

[{"name": "Example encryption scheme",
"algorithm": "AES256",
"keyLocation": "Server",
"isAvailable": true
}
]

リソース

環境内でリソース一覧を返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

query Parameters

	(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples: name[eq]=Example - 「Example」と等しい値を検索します。 name[strtw]=Exa - 「Exa」で始まる値を検索します。 name[gte]=Ex&name[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 name[gte]=Example - 「Example」以降の半角英数字の値を検索します。リソースの名前を検索するフィルター。
	(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples: groupName[eq]=Example - 「Example」と等しい値を検索します。 groupName[strtw]=Exa - 「Exa」で始まる値を検索します。 groupName[gte]=Ex&groupName[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 groupName[gte]=Example - 「Example」以降の半角英数字の値を検索します。リソースのグループ名を検索するフィルター。
	(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples: poolName[eq]=Example - 「Example」と等しい値を検索します。 poolName[strtw]=Exa - 「Exa」で始まる値を検索します。 poolName[gte]=Ex&poolName[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 poolName[gte]=Example - 「Example」以降の半角英数字の値を検索します。リソースのプール名を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: activeSessionCount[eq]=123 - 123に等しい値を検索します。 activeSessionCount[gte]=123&activeSessionCount[lte]=321 - 123～321の値を検索します。 activeSessionCount[lte]=123 - 123以下の値を検索します。リソースのアクティブなセッション数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: pendingSessionCount[eq]=123 - 123に等しい値を検索します。 pendingSessionCount[gte]=123&pendingSessionCount[lte]=321 - 123～321の値を検索します。 pendingSessionCount[lte]=123 - 123以下の値を検索します。リソースの保留中のセッション数を検索するフィルター。
displayStatus	Array of strings Items Enum: "Working" "Idle" "Warning" "Offline" "Missing" "LoggedOut" "Private" リソースの現在のステータスを検索するフィルター。
sortBy	string Enum: "NameAsc" "NameDesc" "PoolAsc" "PoolDesc" "GroupAsc" "GroupDesc" "PendingAsc" "PendingDesc" "ActiveAsc" "ActiveDesc" "DisplayStatusAsc" "DisplayStatusDesc" 結果を並べ替えるフィールドと、並べ替える方向。
itemsPerPage	integer >= 1 このページで取得するアイテムの最大数。
pagingToken	string 以前に返された最後のアイテムを指定するトークン。

Responses

Response samples

200
400
401
403

Content type

application/json

{"pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
"items": [{"id": "01234567-89ab-cdef-0123-456789abcdef",
"name": "Example",
"poolId": "99e23d41-e8ec-4ffe-89c9-93814d70d551",
"poolName": "Pool name",
"groupId": "fedcba98-7654-3210-fedc-ba9876543210",
"groupName": "Example group",
"attributes": ["None"
],
"activeSessionCount": 5,
"warningSessionCount": 1,
"pendingSessionCount": 2,
"databaseStatus": "Ready",
"displayStatus": "Working"
}
]
}

スケジュール

環境内でスケジュールのリストを返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

query Parameters

	(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples: name[eq]=Example - 「Example」と等しい値を検索します。 name[strtw]=Exa - 「Exa」で始まる値を検索します。 name[gte]=Ex&name[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 name[gte]=Example - 「Example」以降の半角英数字の値を検索します。スケジュールの名前を検索するフィルター。
retirementStatus	Array of strings Items Enum: "Active" "Retired" スケジュールの廃止ステータスを検索するフィルター。デフォルトの動作では、すべてのステータスを検索します。
itemsPerPage	integer >= 1 取得するアイテムの最大数
pagingToken	string 以前に返された最後のアイテムを指定するトークン

Responses

Response samples

200
400
401
403

Content type

application/json

{"pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
"items": [{"id": 123,
"name": "Example schedule",
"description": "APIの例のためのスケジュール",
"isRetired": false,
"tasksCount": 3,
"intervalType": "Hour",
"timePeriod": 2,
"startPoint": "0001-01-01T09:00:00+01:00",
"endPoint": "0001-01-01T17:30:00+01:00",
"dayOfWeek": "Tuesday",
"dayOfMonth": "First",
"startDate": "2020-10-02T00:00:00Z",
"endDate": "2020-10-03T02:20:00Z",
"calendarId": 1,
"calendarName": "Example calendar name"
}
]
}

所定のスケジュールを更新する

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

scheduleId

required

integer

更新するスケジュールのID

Request Body schema: application/json

isRetired

boolean

スケジュールの廃止ステータスの新しい値

Responses

Request samples

Payload

Content type

application/json

{"isRetired": true
}

Response samples

400
401
403
404
409

Content type

application/json

{"invalidField": "string",
"message": "string"
}

すべてのスケジュールログを返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

query Parameters

itemsPerPage	integer 1ページあたりの表示アイテム数
scheduleLogStatus	Array of strings Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned" ログのステータスを検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: startTime[eq]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 startTime[gte]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ログの開始時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: endTime[eq]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 endTime[gte]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ログの終了時刻を検索するフィルター。
pagingToken	string 以前に返された最後のアイテムを指定するトークン

Responses

Response samples

200
400
401
403

Content type

application/json

{"pagingToken": "string",
"items": [{"scheduleLogId": 0,
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"status": "pending",
"serverName": "string",
"scheduleId": 0,
"scheduleName": "string"
}
]
}

指定したスケジュールのすべてのログを返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

scheduleId

required

integer

データを取得するスケジュールのID

query Parameters

itemsPerPage	integer 1ページあたりの表示アイテム数
scheduleLogStatus	Array of strings Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned" ログのステータスを検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: startTime[eq]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 startTime[gte]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ログの開始時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: endTime[eq]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 endTime[gte]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ログの終了時刻を検索するフィルター。
pagingToken	string 以前に返された最後のアイテムを指定するトークン

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"pagingToken": "string",
"items": [{"scheduleLogId": 0,
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"status": "pending",
"serverName": "string",
"scheduleId": 0,
"scheduleName": "string"
}
]
}

特定の日時に実行するスケジュールを設定する

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

scheduleId

required

string <uuid>

開始するスケジュールのID

Request Body schema: application/json

startTime

string <date-time>

スケジュールを実行する日時

Responses

Request samples

Payload

Content type

application/json

{"startTime": "2020-10-02T12:34:56+02:00"
}

Response samples

202
400
401
403
404

Content type

application/json

{"scheduledTime": "2020-10-02T12:34:56+02:00"
}

スケジュール内のタスクのリストを取得する

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

scheduleId

required

integer

タスクを取得するスケジュールのID

Responses

Response samples

200
401
403
404

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"failFastOnError": true,
"delayAfterEnd": 0,
"onSuccessTaskId": 0,
"onSuccessTaskName": "string",
"onFailureTaskId": 0,
"onFailureTaskName": "string"
}
]

特定のタスクに対してスケジュールされているセッションのリストを返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

taskId

required

integer >= 1

データを取得するタスクのID

Responses

Response samples

200
401
403
404

Content type

application/json

[{"processName": "string",
"resourceName": "string"
}
]

セッション

環境内のセッションのリストを返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

query Parameters

sortBy	string Enum: "SessionNumberAsc" "SessionNumberDesc" "ProcessNameAsc" "ProcessNameDesc" "ResourceNameAsc" "ResourceNameDesc" "UserNameAsc" "UserNameDesc" "StatusAsc" "StatusDesc" "ExceptionTypeAsc" "ExceptionTypeDesc" "StartTimeAsc" "StartTimeDesc" "EndTimeAsc" "EndTimeDesc" "LatestStageAsc" "LatestStageDesc" "StageStartedAsc" "StageStartedDesc" 結果を並べ替えるフィールドと、並べ替える方向。
itemsPerPage	integer >= 1 取得するアイテムの最大数。
pagingToken	string 以前に返された最後のアイテムを指定するトークン。
	(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples: processName[eq]=Example - 「Example」と等しい値を検索します。 processName[strtw]=Exa - 「Exa」で始まる値を検索します。 processName[gte]=Ex&processName[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 processName[gte]=Example - 「Example」以降の半角英数字の値を検索します。セッションによって実行されるプロセスの名前を検索するフィルター。
	(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples: sessionNumber[eq]=Example - 「Example」と等しい値を検索します。 sessionNumber[strtw]=Exa - 「Exa」で始まる値を検索します。 sessionNumber[gte]=Ex&sessionNumber[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 sessionNumber[gte]=Example - 「Example」以降の半角英数字の値を検索します。セッション番号を検索するフィルター。
	(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples: resourceName[eq]=Example - 「Example」と等しい値を検索します。 resourceName[strtw]=Exa - 「Exa」で始まる値を検索します。 resourceName[gte]=Ex&resourceName[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 resourceName[gte]=Example - 「Example」以降の半角英数字の値を検索します。セッションが実行している、または実行したリソースの名前を検索するためのフィルター。
	(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples: userName[eq]=Example - 「Example」と等しい値を検索します。 userName[strtw]=Exa - 「Exa」で始まる値を検索します。 userName[gte]=Ex&userName[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 userName[gte]=Example - 「Example」以降の半角英数字の値を検索します。セッションをトリガーしたユーザーの名前を検索するフィルター。
status	Array of strings Items Enum: "Pending" "Running" "Terminated" "Stopped" "Completed" "Stopping" "Warning" 検索するセッションのステータス。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: startTime[eq]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 startTime[gte]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。セッションが開始した時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: endTime[eq]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 endTime[gte]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。セッションが終了した時刻を検索するフィルター。
	(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples: latestStage[eq]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 latestStage[gte]=2020-10-02T12:34:56+01:00&latestStage[lte]=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 latestStage[gte]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。最新のステージの名前を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: stageStarted[eq]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 stageStarted[gte]=2020-10-02T12:34:56+01:00&stageStarted[lte]=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 stageStarted[gte]=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。最新のステージが開始された時刻を検索するフィルター

Responses

Response samples

200
400
401
403

Content type

application/json

{"pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
"items": [{"sessionId": "01234567-89ab-cdef-0123-456789abcdef",
"sessionNumber": 123,
"processId": "01234567-89ab-cdef-0123-456789abcdef",
"processName": "Example process",
"resourceId": "01234567-89ab-cdef-0123-456789abcdef",
"resourceName": "Example resource",
"username": "Example user",
"status": "Running",
"startTime": "2020-10-02T12:34:56+02:00",
"endTime": "2020-10-03T13:36:21+02:00",
"latestStage": "Example stage",
"stageStarted": "2020-10-02T12:35:30+02:00",
"exceptionMessage": "Exception message",
"terminationReason": "InternalError",
"exceptionType": "Exception type"
}
]
}

指定セッションの詳細を取得する

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

sessionId

required

string <uuid>

データを取得するセッションのID

Responses

Response samples

200
401
403
404

Content type

application/json

{"sessionId": "01234567-89ab-cdef-0123-456789abcdef",
"sessionNumber": 123,
"processId": "01234567-89ab-cdef-0123-456789abcdef",
"processName": "Example process",
"resourceId": "01234567-89ab-cdef-0123-456789abcdef",
"resourceName": "Example resource",
"username": "Example user",
"status": "Running",
"startTime": "2020-10-02T12:34:56+02:00",
"endTime": "2020-10-03T13:36:21+02:00",
"latestStage": "Example stage",
"stageStarted": "2020-10-02T12:35:30+02:00",
"exceptionMessage": "Exception message",
"terminationReason": "InternalError",
"exceptionType": "Exception type"
}

指定したセッションのすべてのログを返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

sessionId

required

string <uuid>

データを取得するセッションのID

query Parameters

itemsPerPage	integer >= 1 取得するアイテムの最大数
pagingToken	string 以前に返された最後のアイテムを指定するトークン

Responses

Response samples

200
401
403
404

Content type

application/json

{"pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
"items": [{"logId": 123,
"stageName": "Example stage",
"stageType": "Calculation",
"result": "Some result",
"resourceStartTime": "2020-10-02T12:34:56+01:00",
"hasParameters": true
}
]
}

指定されたセッションログのすべてのパラメーターを返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

sessionId required	string <uuid> データを取得するセッションのID
logId required	integer >= 1 セッションで取得するログのID

Responses

Response samples

200
401
403
404

Content type

application/json

{"inputs": {"parameter1": {"valueType": "Text",
"value": "Example value"
},
"parameter2": {"valueType": "Number",
"value": 123
}
},
"outputs": {"parameter1": {"valueType": "Collection",
"value": {"rows": [{"valueType": "Number",
"value": 321
},
{"valueType": "Date",
"value": "2020-10-02T12:34:56+01:00"
}
]
}
}
}
}

ワークキュー

環境内のワークキューのリストを返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

query Parameters

sortBy	string Enum: "NameAsc" "NameDesc" "StatusAsc" "StatusDesc" "KeyFieldAsc" "KeyFieldDesc" "MaxAttemptsAsc" "MaxAttemptsDesc" "IsEncryptedAsc" "IsEncryptedDesc" "TotalItemCountAsc" "TotalItemCountDesc" "CompletedItemCountAsc" "CompletedItemCountDesc" "PendingItemCountAsc" "PendingItemCountDesc" "LockedItemCountAsc" "LockedItemCountDesc" "ExceptionedItemCountAsc" "ExceptionedItemCountDesc" "TotalCaseDurationAsc" "TotalCaseDurationDesc" "AverageWorkTimeAsc" "AverageWorkTimeDesc" 結果を並べ替えるフィールドと、並べ替える方向。
	(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples: name[eq]=Example - 「Example」と等しい値を検索します。 name[strtw]=Exa - 「Exa」で始まる値を検索します。 name[ctn]=amp - 「amp」を含む値を検索します name[gte]=Ex&name[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 name[gte]=Example - 「Example」以降の半角英数字の値を検索します。ワークキューの名前を検索するフィルター。
	(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples: keyField[eq]=Example - 「Example」と等しい値を検索します。 keyField[strtw]=Exa - 「Exa」で始まる値を検索します。 keyField[ctn]=amp - 「amp」を含む値を検索します keyField[gte]=Ex&keyField[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 keyField[gte]=Example - 「Example」以降の半角英数字の値を検索します。ワークキューのキーフィールドの名前を検索するフィルター。
status.eq	string (QueueStatus) Enum: "Running" "Paused" ワークキューの現在のステータスを検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューの構成済みの最大試行回数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューの保留中のアイテム数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューのロックされているアイテム数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューの完了したアイテム数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューの例外アイテム数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューの合計アイテム数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=12:34:56 - 12:34:56と等しい値を検索します。 gte=01:23:45&lte=12:34:56 - 01:23:45から12:34:56（基準となる値を含む）の値を検索 lte=12:34:56 - 12:34:56以下の値を検索ワークキューの平均作業時間を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=12:34:56 - 12:34:56と等しい値を検索します。 gte=01:23:45&lte=12:34:56 - 01:23:45から12:34:56（基準となる値を含む）の値を検索 lte=12:34:56 - 12:34:56以下の値を検索ワークキューの合計処理時間を検索するフィルター。
itemsPerPage	integer >= 1 現在のページで返すアイテムの最大数。
pagingToken	string 以前に返された最後のアイテムを指定するトークン

Responses

Response samples

200
400
401
403

Content type

application/json

{"pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
"items": [{"id": "01234567-89ab-cdef-0123-456789abcdef",
"name": "Example work queue",
"keyField": "Example field",
"status": "Running",
"isEncrypted": false,
"maxAttempts": 5,
"pendingItemCount": 10,
"completedItemCount": 75,
"lockedItemCount": 1,
"exceptionedItemCount": 3,
"totalItemCount": 14,
"averageWorkTime": "00:01:23",
"totalCaseDuration": "06:12:53",
"groupName": "Example group",
"groupId": "fedcba98-7654-3210-fedc-ba9876543210"
}
]
}

新しいワークキューを作成する

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

Request Body schema: application/json

作成するキューの詳細

name	string [ 1 .. 255 ] characters 作成するキューの名前
keyField	string [ 0 .. 255 ] characters キューのキーとして使用される列の名前
maxAttempts	integer [ 1 .. 999999 ] キュー内のアイテムの最大再試行回数
status	string (QueueStatus) Enum: "Running" "Paused" キューの現在のステータス。
encryptionKeyId	integer キューに使用する暗号化キーのID。暗号化が不要な場合、このフィールドは0にしてください

Responses

Request samples

Payload

Content type

application/json

{"name": "Example queue",
"keyField": "Example field",
"maxAttempts": 3,
"status": "Running",
"encryptionKeyId": 0
}

Response samples

201
400
401
403
409

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

ワークキューの詳細を返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

workQueueId

required

string <uuid>

詳細を取得するキューのID

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"id": "01234567-89ab-cdef-0123-456789abcdef",
"name": "Example work queue",
"keyField": "Example field",
"status": "Running",
"isEncrypted": false,
"maxAttempts": 5,
"pendingItemCount": 10,
"completedItemCount": 75,
"lockedItemCount": 1,
"exceptionedItemCount": 3,
"totalItemCount": 14,
"averageWorkTime": "00:01:23",
"totalCaseDuration": "06:12:53",
"groupName": "Example group",
"groupId": "fedcba98-7654-3210-fedc-ba9876543210"
}

パッチドキュメントの説明に従って、ワークキューを変更する

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

workQueueId

required

string <uuid>

変更するキューのID

Request Body schema: application/json

Array

op required	string Enum: "add" "remove" "replace" "move" "copy" "test" 実行する操作
path required	string JSON Pointer
value	object 操作で使用される値。
from	string JSON Pointer値を含む文字列。

Responses

Request samples

Payload

Content type

application/json

Example

[{"op": "add",
"path": "/someArrayProperty",
"value": ["item1",
"item2"
]
}
]

Response samples

400
401
403
404

Content type

application/json

{"invalidField": "string",
"message": "string"
}

指定されたワークキューを削除する

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

workQueueId

required

string <uuid>

削除するキューのID

Responses

Response samples

400
401
403
404
409

Content type

application/json

{"invalidField": "string",
"message": "string"
}

指定したワークキューのアイテムを返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

workQueueId

required

string <uuid>

アイテムを取得するキューのID

query Parameters

sortBy	string Enum: "AttemptAsc" "AttemptDesc" "AttemptWorkTimeAsc" "AttemptWorkTimeDesc" "CompletedAsc" "CompletedDesc" "DeferredAsc" "DeferredDesc" "ExceptionAsc" "ExceptionDesc" "ExceptionReasonAsc" "ExceptionReasonDesc" "KeyValueAsc" "KeyValueDesc" "LastUpdatedAsc" "LastUpdatedDesc" "LoadedAsc" "LoadedDesc" "LockedAsc" "LockedDesc" "PriorityAsc" "PriorityDesc" "StatusAsc" "StatusDesc" "WorkTimeAsc" "WorkTimeDesc" 結果を並べ替えるフィールドと、並べ替える方向。
	(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples: eq=Example - 「Example」と等しい値を検索します。 strtw=Exa - 「Exa」で始まる値を検索します。 ctn=amp - 「amp」を含む値を検索します gte=Ex&lte=F - 「Ex」と「F」の間の半角英数字の値を検索します。 gte=Example - 「Example」以降の半角英数字の値を検索します。ワークキュー項目のキーフィールドの値を検索するフィルター。
	(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples: eq=Example - 「Example」と等しい値を検索します。 strtw=Exa - 「Exa」で始まる値を検索します。 ctn=amp - 「amp」を含む値を検索します gte=Ex&lte=F - 「Ex」と「F」の間の半角英数字の値を検索します。 gte=Example - 「Example」以降の半角英数字の値を検索します。ワークキュー項目のステータスを検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=12:34:56 - 12:34:56と等しい値を検索します。 gte=01:23:45&lte=12:34:56 - 01:23:45から12:34:56（基準となる値を含む）の値を検索 lte=12:34:56 - 12:34:56以下の値を検索ワークキュー項目の合計作業時間を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目がキューに読み込まれた時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目が延期された時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目がロックされた時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目が完了した時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目が例外となった時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目が最後に更新された時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキュー項目の現在の試行回数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキュー項目の優先度を検索するフィルター。
	(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples: eq=Example - 「Example」と等しい値を検索します。 ctn=amp - 「amp」を含む値を検索します strtw=Exa - 「Exa」で始まる値を検索します。 gte=Ex&lte=F - 「Ex」と「F」の間の半角英数字の値を検索します。 gte=Example - 「Example」以降の半角英数字の値を検索します。ワークキュー項目が例外となった理由を検索するフィルター。
itemsPerPage	integer 取得するアイテムの最大数
pagingToken	string 以前に返された最後のアイテムを指定するトークン

Responses

Response samples

200
401
403
404

Content type

application/json

{"pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
"items": [{"id": "01234567-89ab-cdef-0123-456789abcdef",
"priority": 3,
"ident": 5112,
"state": "Pending",
"keyValue": "Example value",
"status": "Example status",
"tags": ["Example tag 1",
"Example tag 2"
],
"attemptNumber": 1,
"loadedDate": "2020-10-02T12:34:56+01:00",
"deferredDate": "2020-10-02T12:34:56+01:00",
"lockedDate": "0001-01-01T00:00:00Z",
"completedDate": "0001-01-01T00:00:00Z",
"exceptionedDate": "0001-01-01T00:00:00Z",
"exceptionReason": "Example reason",
"lastUpdated": "2020-10-02T12:34:56+01:00",
"workTimeInSeconds": 123,
"attemptWorkTimeInSeconds": 56,
"resource": "Example resource"
}
]
}

アイテムをキューに追加する

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

workQueueId

required

string <uuid>

挿入先のキューのID

Request Body schema: application/json

作成するキュー項目の詳細

Array

	object (DataCollection) Blue Prismコレクションを表します。
deferredDate	string <date-time> このアイテムが次の日付まで延期される最も早い日時
priority	integer <integer> アイテムに指定されている優先度値
tags	Array of strings アイテムに指定されているタグのコレクション
status	string ユーザー提供のステータス値

Responses

Request samples

Payload

Content type

application/json

[{"data": {"rows": [{"valueType": "Number",
"value": 321
},
{"valueType": "Date",
"value": "2020-10-02T12:34:56+01:00"
}
]
},
"deferredDate": "2020-10-02T12:34:56+01:00",
"priority": 3,
"tags": ["Example tag 1",
"Example tag 2"
],
"status": "Example status"
}
]

Response samples

201
400
401
403
404

Content type

application/json

{"ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

ワークキューの指定されたアイテムの詳細を返す

Authorizations:

Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

path Parameters

workQueueItemId

required

string <uuid>

取得するアイテムのID

Responses

Response samples

200
400
404

Content type

application/json

{"id": "01234567-89ab-cdef-0123-456789abcdef",
"priority": 3,
"ident": 123,
"state": "Completed",
"keyValue": "Example value",
"status": "Example status",
"tags": ["Example tag 1",
"Example tag 2"
],
"attemptNumber": 1,
"loadedDate": "2020-10-02T12:34:56+01:00",
"deferredDate": "2020-10-02T12:34:56+01:00",
"lockedDate": "0001-01-01T00:00:00Z",
"completedDate": "2020-10-02T13:00:00+01:00",
"exceptionedDate": "0001-01-01T00:00:00Z",
"exceptionReason": "Example reason",
"lastUpdated": "2020-10-02T13:00:00+01:00",
"workTimeInSeconds": 123,
"attemptWorkTimeInSeconds": 123,
"resource": "Example resource",
"data": {"rows": [{"valueType": "Number",
"value": 321
},
{"valueType": "Date",
"value": "2020-10-02T12:34:56+01:00"
}
]
}
}

sortBy	string Enum: "NameAsc" "NameDesc" "StatusAsc" "StatusDesc" "KeyFieldAsc" "KeyFieldDesc" "MaxAttemptsAsc" "MaxAttemptsDesc" "IsEncryptedAsc" "IsEncryptedDesc" "TotalItemCountAsc" "TotalItemCountDesc" "CompletedItemCountAsc" "CompletedItemCountDesc" "PendingItemCountAsc" "PendingItemCountDesc" "LockedItemCountAsc" "LockedItemCountDesc" "ExceptionedItemCountAsc" "ExceptionedItemCountDesc" "TotalCaseDurationAsc" "TotalCaseDurationDesc" "AverageWorkTimeAsc" "AverageWorkTimeDesc" 結果を並べ替えるフィールドと、並べ替える方向。
	(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples: name[eq]=Example - 「Example」と等しい値を検索します。 name[strtw]=Exa - 「Exa」で始まる値を検索します。 name[ctn]=amp - 「amp」を含む値を検索します name[gte]=Ex&name[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 name[gte]=Example - 「Example」以降の半角英数字の値を検索します。ワークキューの名前を検索するフィルター。
	(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples: keyField[eq]=Example - 「Example」と等しい値を検索します。 keyField[strtw]=Exa - 「Exa」で始まる値を検索します。 keyField[ctn]=amp - 「amp」を含む値を検索します keyField[gte]=Ex&keyField[lte]=F - 「Ex」と「F」の間の半角英数字の値を検索します。 keyField[gte]=Example - 「Example」以降の半角英数字の値を検索します。ワークキューのキーフィールドの名前を検索するフィルター。
status.eq	string (QueueStatus) Enum: "Running" "Paused" ワークキューの現在のステータスを検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューの構成済みの最大試行回数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューの保留中のアイテム数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューのロックされているアイテム数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューの完了したアイテム数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューの例外アイテム数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキューの合計アイテム数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=12:34:56 - 12:34:56と等しい値を検索します。 gte=01:23:45&lte=12:34:56 - 01:23:45から12:34:56（基準となる値を含む）の値を検索 lte=12:34:56 - 12:34:56以下の値を検索ワークキューの平均作業時間を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=12:34:56 - 12:34:56と等しい値を検索します。 gte=01:23:45&lte=12:34:56 - 01:23:45から12:34:56（基準となる値を含む）の値を検索 lte=12:34:56 - 12:34:56以下の値を検索ワークキューの合計処理時間を検索するフィルター。
itemsPerPage	integer >= 1 現在のページで返すアイテムの最大数。
pagingToken	string 以前に返された最後のアイテムを指定するトークン

sortBy	string Enum: "AttemptAsc" "AttemptDesc" "AttemptWorkTimeAsc" "AttemptWorkTimeDesc" "CompletedAsc" "CompletedDesc" "DeferredAsc" "DeferredDesc" "ExceptionAsc" "ExceptionDesc" "ExceptionReasonAsc" "ExceptionReasonDesc" "KeyValueAsc" "KeyValueDesc" "LastUpdatedAsc" "LastUpdatedDesc" "LoadedAsc" "LoadedDesc" "LockedAsc" "LockedDesc" "PriorityAsc" "PriorityDesc" "StatusAsc" "StatusDesc" "WorkTimeAsc" "WorkTimeDesc" 結果を並べ替えるフィールドと、並べ替える方向。
	(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples: eq=Example - 「Example」と等しい値を検索します。 strtw=Exa - 「Exa」で始まる値を検索します。 ctn=amp - 「amp」を含む値を検索します gte=Ex&lte=F - 「Ex」と「F」の間の半角英数字の値を検索します。 gte=Example - 「Example」以降の半角英数字の値を検索します。ワークキュー項目のキーフィールドの値を検索するフィルター。
	(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples: eq=Example - 「Example」と等しい値を検索します。 strtw=Exa - 「Exa」で始まる値を検索します。 ctn=amp - 「amp」を含む値を検索します gte=Ex&lte=F - 「Ex」と「F」の間の半角英数字の値を検索します。 gte=Example - 「Example」以降の半角英数字の値を検索します。ワークキュー項目のステータスを検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=12:34:56 - 12:34:56と等しい値を検索します。 gte=01:23:45&lte=12:34:56 - 01:23:45から12:34:56（基準となる値を含む）の値を検索 lte=12:34:56 - 12:34:56以下の値を検索ワークキュー項目の合計作業時間を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目がキューに読み込まれた時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目が延期された時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目がロックされた時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目が完了した時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目が例外となった時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）に等しい値を検索します。 gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）から2020-11-02の12:34:56（GMT+1）までの値を検索します。 gte=2020-10-02T12:34:56+01:00 - 2020-10-02の12:34:56（GMT+1）以降の値を検索します。ワークキュー項目が最後に更新された時刻を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキュー項目の現在の試行回数を検索するフィルター。
	(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples: eq=123 - 123に等しい値を検索します。 gte=123&lte=321 - 123～321の値を検索します。 lte=123 - 123以下の値を検索します。ワークキュー項目の優先度を検索するフィルター。
	(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples: eq=Example - 「Example」と等しい値を検索します。 ctn=amp - 「amp」を含む値を検索します strtw=Exa - 「Exa」で始まる値を検索します。 gte=Ex&lte=F - 「Ex」と「F」の間の半角英数字の値を検索します。 gte=Example - 「Example」以降の半角英数字の値を検索します。ワークキュー項目が例外となった理由を検索するフィルター。
itemsPerPage	integer 取得するアイテムの最大数
pagingToken	string 以前に返された最後のアイテムを指定するトークン