Download the OpenAPI v3 specification:Download
The Blue Prism API provides a series of predefined capabilities that can be used by custom solutions to interact with Blue Prism programmatically using a REST API.
Blue Prism agreements: https://portal.blueprism.com/agreements
workQueueIds required | Array of strings <uuid> Array of work queue IDs to retrieve data for. |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "completed": 0,
- "pending": 0,
- "deferred": 0,
- "locked": 0,
- "exceptioned": 0
}
]
startDate required | string <date-time> The start date. |
resourceIds | Array of strings <uuid> Array of resource IDs to filter on. |
pageNumber | integer Page number parameter used for data paging of utilization heat map. |
pageSize | integer Page size parameter used for data paging of utilization heat map. |
[- {
- "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
- "digitalWorkerName": "string",
- "utilizationDate": "2020-10-02T12:34:56+02:00",
- "usages": [
- 0
]
}
]
startDate required | string <date-time> The start date. |
endDate required | string <date-time> The end date. |
resourceIds | Array of strings <uuid> Resource IDs to filter on. |
[- {
- "usagehour": "2020-10-02T12:34:56+02:00",
- "usage": 0
}
]
Permissions required
At least one of:
Create Process
|Delete Process
|Edit Process
|Edit Process Groups
|Execute Process
|Execute Process as Web Service
|Export Process
|Manage Process Access Rights
|View Process Definition
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the name of the process. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the description of the process. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the group name of the process. | |
attributesInclude | Array of strings Items Enum: "Retired" "Published" "PublishedWebService" A filter to search for attributes to be included. |
attributesExclude | Array of strings Items Enum: "Retired" "Published" "PublishedWebService" A filter to search for attributes to be excluded. |
sortBy | string Enum: "NameAsc" "NameDesc" "DescriptionAsc" "DescriptionDesc" "GroupAsc" "GroupDesc" The field that results should be sorted by and the direction they should be sorted in. |
itemsPerPage | integer >= 1 The maximum number of items to retrieve per page. |
pagingToken | string The token to point to the last item previously returned. |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "processId": "01234567-89ab-cdef-0123-456789abcdef",
- "processName": "Process_Name",
- "processDescription": "Process_Description",
- "groupId": "99e23d41-e8ec-4ffe-89c9-93814d70d551",
- "groupName": "Group_name",
- "attributes": [
- "Retired",
- "PublishedWS"
]
}
]
}
Permissions required
At least one of:
View Resource
|View Resource Screen Captures
|Configure Resource
|Control Resource
|Manage Resource Access Rights
|View Resource Details
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the name of the resource. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the group name of the resource. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the pool name of the resource. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for resource's active session count. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for resource's pending session count. | |
displayStatus | Array of strings Items Enum: "Working" "Idle" "Warning" "Offline" "Missing" "LoggedOut" "Private" "Details" A filter to search for the current status of the resource. |
retirementFilter | string Enum: "NonRetired" "Retired" "All" A filter to search for the retirement status of the resource. The default behavior is to search for non-retired resources. |
sortBy | string Enum: "NameAsc" "NameDesc" "PoolAsc" "PoolDesc" "GroupAsc" "GroupDesc" "PendingAsc" "PendingDesc" "ActiveAsc" "ActiveDesc" "DisplayStatusAsc" "DisplayStatusDesc" The field that results should be sorted by and the direction they should be sorted in. |
itemsPerPage | integer >= 1 The maximum number of items to retrieve per page. |
pagingToken | string The token to point to the last item previously returned. |
{- "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"
}
]
}
Permissions required:
Configure Resource
resourceId required | string <uuid> The ID of the resource or pool. |
To retire an active resource, use "Retire". To unretire a resource, use "None". The "Retire" attribute should not be included if attempting to unretire a resource.
attributes | Array of strings (ResourceAttribute) Items Enum: "None" "Retired" "Local" "LoginAgent" "Private" "DefaultInstance" The attributes to assign to the resource. |
{- "attributes": [
- "Retired",
- "None"
]
}
{- "message": "string",
- "messageDetail": "string"
}
Permissions required
At least one of:
View Resource
|View Resource Screen Captures
|Configure Resource
|Control Resource
|Manage Resource Access Rights
|View Resource Details
[- {
- "id": 1,
- "name": "Test Pool",
- "members": 3,
- "databaseStatus": "Ready"
}
]
Permissions required
At least one of:
View Schedule
|Edit Schedule
|Delete Schedule
|Create Schedule
|Retire Schedule
|System - Scheduler
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for name of the schedule. | |
retirementStatus | Array of string |