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 每页显示的项数
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 每页显示的项数
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 指针
value	object 要在操作中使用的值。
from	string 包含 JSON 指针值的字符串。

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 指向之前返回的最后一项的令牌