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
System - Calendar permission
sortBy | string Enum: "IdAsc" "IdDesc" "NameAsc" "NameDesc" "RegionIdAsc" "RegionIdDesc" The field that results should be sorted by and the direction they should be sorted in. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for calendar id. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the name of the calendar. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the region id. | |
workingWeek | Array of strings Items Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" The working week to search for. |
[- {
- "id": 1,
- "name": "Working Week / No Holidays",
- "workingWeek": [
- "Monday",
- "Tuesday"
], - "region": {
- "regionId": 1,
- "disabledPublicHolidaysIds": [
- 1,
- 2
]
}
}
]
Permissions required:
System - Calendars
Details of the calendar to create.
name | string [ 1 .. 128 ] characters The name of the calendar to create. |
workingWeek | Array of strings Items Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" An array of working week. Each day can be added only 1 time. |
object or null A region of the calendar. |
{- "name": "string",
- "workingWeek": [
- "Sunday"
], - "region": {
- "regionId": 0,
- "disabledPublicHolidaysIds": [
- 0
]
}
}
{- "id": 0
}
System - Calendar permission
calendarId required | integer <int32> The ID of the calendar to get. |
{- "id": 1,
- "name": "Working Week / No Holidays",
- "workingWeek": [
- "Monday",
- "Tuesday"
], - "region": {
- "regionId": 1,
- "disabledPublicHolidaysIds": [
- 1,
- 2
]
}
}
System - Calendar permission
calendarId required | integer <int32> The ID of the calendar to delete. |
{- "message": "string",
- "messageDetail": "string"
}
Permissions required:
System - Calendar permission
calendarId required | integer <int32> The ID of the Calendar to update. |
Details of the calendar to update.
op required | string Enum: "add" "remove" "replace" "move" "copy" The operation to be performed. |
path required | string A JSON-Pointer. |
value | object The value to be used within the operations.. |
from | string A string containing a JSON Pointer value. |
[- {
- "op": "add",
- "path": "/someArrayProperty",
- "value": [
- "item1",
- "item2"
]
}
]
{- "message": "string",
- "messageDetail": "string"
}
System - Calendar permission
calendarId required | integer <int32> The ID of the calendar to clone. |
Details of the calendar to create.
name | string [ 1 .. 128 ] characters The name of the calendar to create. |
{- "name": "string"
}
{- "id": 0
}
System - Calendar permission
calendarId required | integer <int32> The ID of the calendar used to get other holidays. |
[- "2021-01-04",
- "2021-10-25",
- "2022-03-05"
]
System - Calendar permission
calendarId required | integer <int32> The ID of the calendar used to remove other holidays. |
The list of other holidays to delete.
holidays | Array of strings <date> An array of other holidays. |
{- "holidays": [
- "2019-08-24"
]
}
{- "message": "string",
- "messageDetail": "string"
}
System - Calendar permission
calendarId required | integer <int32> The ID of the calendar used to add other holidays. |
The list of other holidays to create.
holidays | Array of strings <date> An array of other holidays. |
{- "holidays": [
- "2019-08-24"
]
}
{- "message": "string",
- "messageDetail": "string"
}
calendarId required | integer <int32> The ID of the calendar to find references for. |
sortBy | string Enum: "NameAsc" "NameDesc" "DescriptionAsc" "DescriptionDesc" "ProcessTypeAsc" "ProcessTypeDesc" 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. |
pagingToken | string The token to point to the last item previously returned. |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the name of the reference. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the description of the reference. | |
processType | Array of strings Items Enum: "Process" "Object" The type of the process to search for. |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "type": "Process"
}
]
}
System - Calendars permission
holidayRegionId required | integer <int32> The ID of the holiday region. |
[- {
- "publicHolidayId": 33,
- "name": "Coming of Age Day",
- "nextDate": "10/01/2023"
}
]
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:
System - License permission
{- "activeLicenseTypes": [
- "Enterprise"
], - "enterpriseEntitlement": {
- "publishedprocesseslimit": 0,
- "concurrentsessionslimit": 0,
- "runtimeresourceslimit": 0,
- "processalertmachineslimit": 0
}, - "desktopEntitlement": {
- "publishedprocesseslimit": 0,
- "concurrentsessionslimit": 0,
- "runtimeresourceslimit": 0,
- "processalertmachineslimit": 0
}
}
Permissions required
At least one of:
View Resource Screen Capture
|View Resource
|Control Resource
|Configure Resource
And at least one of:Audit Alerts
|Subscribe To Process Alerts
|Configure Process Alerts
{- "publishedProcessesLimit": null,
- "publishedProcessesUsed": 5,
- "concurrentSessionsLimit": 50,
- "concurrentSessionsUsed": 7,
- "runtimeResourcesLimit": 150,
- "runtimeResourcesUsed": 72,
- "processAlertMachinesLimit": 50,
- "processAlertMachinesUsed": 17
}
Permissions required:
Security - View Encryption Scheme Configuration
[- {
- "name": "Example encryption scheme",
- "algorithm": "AES256",
- "keyLocation": "Server",
- "isAvailable": true
}
]
Permissions required
At least one of:
Business Objects - View Environment Variables
|Business Objects - Configure Environment Variables
|Processes - View Environment Variables
|Processes - Configure Environment Variables
sortBy | string Enum: "NameAsc" "NameDesc" "DescriptionAsc" "DescriptionDesc" "DataTypeAsc" "DataTypeDesc" 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. |
pagingToken | string The token to point to the last item previously returned. |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the name of the environment variable. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the description of the environment variable. | |
dataType | Array of strings Items Enum: "Binary" "Date" "DateTime" "Flag" "Image" "Number" "Password" "RadioButtons" "Text" "Time" "TimeSpan" The type of the environment variable to search for. |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "name": "name of the text variable",
- "description": "description of the text variable",
- "dataType": "text",
- "value": "text value"
}
]
}
Permissions required:
Business Objects - Configure Environment Variables
,Process - Configure Environment Variables
Details of the environment variable to create.
name | string [ 1 .. 64 ] characters The name of the environment variable to create. |
description | string The description of the environment variable. |
dataType | string Valid types for environment variables - Date (date), DateTime (date-time), Flag (boolean), Number (integer), Password (string), Text (string), Time (date), TimeSpan (time), Image (base64), Binary (base64), RadioButtons (object radioButtons). |
string or string or boolean or number or string or string or Array of RadioButtons (objects) The value of the environment variable of a valid type that the user provides to save to the DB. |
{- "name": "Test environment variable",
- "description": "Any text",
- "value": "Any text",
- "dataType": "Text"
}
{- "message": "string",
- "messageDetail": "string"
}
Permissions required:
At least one of:
Business Objects - Configure Environment Variables
,Processes - Configure Environment Variables
environmentVariableId required | string <uuid> The id of the environment variable. |
sortBy | string Enum: "NameAsc" "NameDesc" "DescriptionAsc" "DescriptionDesc" "ProcessTypeAsc" "ProcessTypeDesc" 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. |
pagingToken | string The token to point to the last item previously returned. |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the name of the environment variable. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the description of the environment variable reference. | |
processType | string (ProcessType) Enum: "Process" "Object" A filter to search for the references by process type. |
{- "pagingToken": "string",
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "type": "Process"
}
]
}
Permissions required:
Business Objects - Configure Environment Variables
orProcesses - Configure Environment Variables
environmentVariableId required | string <uuid> The id of the environment variable. |
"string"
Permissions required:
Business Objects - Configure Environment Variables
OrProcesses - Configure Environment Variables
environmentVariableId required | string <uuid> The id of the environment variable to update. |
op required | string Enum: "add" "remove" "replace" "move" "copy" The operation to be performed. |
path required | string A JSON-Pointer. |
value | object The value to be used within the operations.. |
from | string A string containing a JSON Pointer value. |
[- {
- "op": "add",
- "path": "/someArrayProperty",
- "value": [
- "item1",
- "item2"
]
}
]
{- "message": "string",
- "messageDetail": "string"
}
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 (ProcessAttributeFilter) Items Enum: "Retired" "Published" "PublishedWebService" "PublishedDesktop" A filter to search for attributes to be included. |
attributesExclude | Array of strings (ProcessAttributeFilter) Items Enum: "Retired" "Published" "PublishedWebService" "PublishedDesktop" A filter to search for attributes to be excluded. |
sortBy | string (getProcessSortBy) 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",
- "PublishedWebService"
]
}
]
}
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 / group. | |
sortBy | string (getAllProcessGroupItemsSortBy) Enum: "NameAsc" "NameDesc" 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. |
attributesInclude | Array of strings (ProcessAttributeFilter) Items Enum: "Retired" "Published" "PublishedWebService" "PublishedDesktop" A filter to search for attributes to be included. |
attributesExclude | Array of strings (ProcessAttributeFilter) Items Enum: "Retired" "Published" "PublishedWebService" "PublishedDesktop" A filter to search for attributes to be excluded. |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "id": "01234567-89ab-cdef-0123-456789abcdef",
- "name": "Process_Name",
- "nodeType": "Item",
- "lastModified": "2022-04-01T09:05:10.64+01:00"
}
]
}
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" "BPD" 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. |
resourceType | string Enum: "Enterprise" "Desktop" "RemoteDigitalWorker" A filter to search for the resource type. |
includeResourcePools | boolean Includes resource pools in the results. |
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",
- "resourceType": "Desktop"
}
]
}
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" "Desktop" "RemoteDigitalWorker" "Pool" 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 strings Items Enum: "Active" "Retired" A filter to search for the retirement status of the schedule. The default behavior is to search for all statuses. |
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": 123,
- "name": "Example schedule",
- "description": "A schedule for API example purposes.",
- "initialTaskId": 4,
- "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"
}
]
}
Permissions required:
Create Schedule
and
Edit Schedule
copyFrom | integer Deprecated Schedule ID to create copy against. |
Details of the schedule definition to create or to update when cloning. To send a request without a body, enter a null value (swagger only).
name | string The name of the schedule. |
description | string The description of the schedule. |
initialTaskId | integer or null The ID of the initial task this schedule executes. |
intervalType | string Enum: "Once" "Minute" "Hour" "Day" "Week" "Month" "Year" The type of interval the schedule runs at. |
startDate | string <date-time> The earliest date the schedule will run. |
endDate | string or null <date-time> The last date on which the schedule will run. If this value is null or missing then the schedule will run indefinitely. |
timeZoneId | string or null The ID of the time zone. |
adjustForDaylightSaving | boolean or null Determines if to use daylight savings time when time zone is a valid time zone ID. |
object (HourlyMinutelyDetails) Hourly and minute details that apply to the hourly and minute interval schedule type. | |
object (HourlyMinutelyDetails) Hourly and minute details that apply to the hourly and minute interval schedule type. | |
object (DailyDetails) Daily details that apply to the daily interval schedule type. | |
object (WeeklyDetails) Weekly details that apply to the weekly interval schedule type. | |
object (MonthlyDetails) Monthly details that apply to the monthly interval schedule type. | |
object (YearlyDetails) Yearly details that apply to the yearly interval schedule type. |
{- "name": "string",
- "description": "string",
- "initialTaskId": 0,
- "intervalType": "Once",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "timeZoneId": "string",
- "adjustForDaylightSaving": true,
- "minutelyDetails": {
- "period": 0,
- "start": "14:15:22Z",
- "end": "14:15:22Z",
- "calendarId": 0
}, - "hourlyDetails": {
- "period": 0,
- "start": "14:15:22Z",
- "end": "14:15:22Z",
- "calendarId": 0
}, - "dailyDetails": {
- "period": 0,
- "calendarId": 0
}, - "weeklyDetails": {
- "period": 0,
- "type": "WeekDay",
- "weekDay": "First",
- "calendarId": 0
}, - "monthlyDetails": {
- "period": 0,
- "type": "NthDay",
- "missingDateAction": "Skip",
- "weekNumber": "First",
- "weekDay": "Sunday",
- "workingDay": "First",
- "calendarId": 0
}, - "yearlyDetails": {
- "period": 0
}
}
{- "id": 0
}
Permissions required
At least one of:
View Schedule
|Edit Schedule
|Delete Schedule
|Create Schedule
|Retire Schedule
|System - Scheduler
scheduleId required | integer The ID of the schedule to return. |
{- "id": 0,
- "name": "string",
- "description": "string",
- "initialTaskId": 0,
- "initialTaskName": "string",
- "isRetired": true,
- "tasksCount": 0,
- "intervalType": "Once",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "timeZoneId": "string",
- "adjustForDaylightSaving": true,
- "hourlyDetails": {
- "period": 0,
- "start": "14:15:22Z",
- "end": "14:15:22Z",
- "calendarId": 0
}, - "minutelyDetails": {
- "period": 0,
- "start": "14:15:22Z",
- "end": "14:15:22Z",
- "calendarId": 0
}, - "dailyDetails": {
- "period": 0,
- "calendarId": 0
}, - "weeklyDetails": {
- "period": 0,
- "type": "WeekDay",
- "weekDay": "First",
- "calendarId": 0
}, - "monthlyDetails": {
- "period": 0,
- "type": "NthDay",
- "missingDateAction": "Skip",
- "weekNumber": "First",
- "weekDay": "Sunday",
- "workingDay": "First",
- "calendarId": 0
}, - "yearlyDetails": {
- "period": 0
}
}
Permissions required
For editing:
Edit Schedule
For retiring all of the following:Edit Schedule
|Retire Schedule
For unretiring all of the following:Edit Schedule
|Retire Schedule
|Create Schedule
scheduleId required | integer The ID of the schedule to update. |
name | string The name of the schedule. |
description | string The description of the schedule. |
initialTaskId | integer or null The ID of the initial task this schedule executes. |
intervalType | string Enum: "Once" "Minute" "Hour" "Day" "Week" "Month" "Year" The type of interval the schedule runs at. |
startDate | string <date-time> The earliest date the schedule will run. |
endDate | string or null <date-time> The last date on which the schedule will run. If this value is null or missing then the schedule will run indefinitely. |
timeZoneId | string or null The ID of the time zone. |
adjustForDaylightSaving | boolean or null Determines if to use daylight savings time when time zone is a valid time zone ID. |
object (HourlyMinutelyDetails) Hourly and minute details that apply to the hourly and minute interval schedule type. | |
object (HourlyMinutelyDetails) Hourly and minute details that apply to the hourly and minute interval schedule type. | |
object (DailyDetails) Daily details that apply to the daily interval schedule type. | |
object (WeeklyDetails) Weekly details that apply to the weekly interval schedule type. | |
object (MonthlyDetails) Monthly details that apply to the monthly interval schedule type. | |
object (YearlyDetails) Yearly details that apply to the yearly interval schedule type. |
{- "name": "string",
- "description": "string",
- "initialTaskId": 0,
- "intervalType": "Once",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "timeZoneId": "string",
- "adjustForDaylightSaving": true,
- "minutelyDetails": {
- "period": 0,
- "start": "14:15:22Z",
- "end": "14:15:22Z",
- "calendarId": 0
}, - "hourlyDetails": {
- "period": 0,
- "start": "14:15:22Z",
- "end": "14:15:22Z",
- "calendarId": 0
}, - "dailyDetails": {
- "period": 0,
- "calendarId": 0
}, - "weeklyDetails": {
- "period": 0,
- "type": "WeekDay",
- "weekDay": "First",
- "calendarId": 0
}, - "monthlyDetails": {
- "period": 0,
- "type": "NthDay",
- "missingDateAction": "Skip",
- "weekNumber": "First",
- "weekDay": "Sunday",
- "workingDay": "First",
- "calendarId": 0
}, - "yearlyDetails": {
- "period": 0
}
}
{- "id": 0,
- "name": "string",
- "description": "string",
- "initialTaskId": 0,
- "initialTaskName": "string",
- "isRetired": true,
- "tasksCount": 0,
- "intervalType": "Once",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "timeZoneId": "string",
- "adjustForDaylightSaving": true,
- "hourlyDetails": {
- "period": 0,
- "start": "14:15:22Z",
- "end": "14:15:22Z",
- "calendarId": 0
}, - "minutelyDetails": {
- "period": 0,
- "start": "14:15:22Z",
- "end": "14:15:22Z",
- "calendarId": 0
}, - "dailyDetails": {
- "period": 0,
- "calendarId": 0
}, - "weeklyDetails": {
- "period": 0,
- "type": "WeekDay",
- "weekDay": "First",
- "calendarId": 0
}, - "monthlyDetails": {
- "period": 0,
- "type": "NthDay",
- "missingDateAction": "Skip",
- "weekNumber": "First",
- "weekDay": "Sunday",
- "workingDay": "First",
- "calendarId": 0
}, - "yearlyDetails": {
- "period": 0
}
}
Permissions required:
Delete Schedule
and
Edit Schedule
scheduleId required | integer The ID of the schedule to delete. |
{- "message": "string",
- "messageDetail": "string"
}
Permissions required
Create Schedule
andEdit Schedule
scheduleId required | integer The ID of the schedule to copy. |
Details of the schedule definition to update. Name can not be a null value.
name required | string The name of the schedule. |
description | string The description of the schedule. |
initialTaskId | integer or null The ID of the initial task this schedule executes. |
intervalType | string Enum: "Once" "Minute" "Hour" "Day" "Week" "Month" "Year" The type of interval the schedule runs at. |
startDate | string <date-time> The earliest date the schedule will run. |
endDate | string or null <date-time> The last date on which the schedule will run. If this value is null or missing then the schedule will run indefinitely. |
timeZoneId | string or null The ID of the time zone. |
adjustForDaylightSaving | boolean or null Determines if to use daylight savings time when time zone is a valid time zone ID. |
object (HourlyMinutelyDetails) Hourly and minute details that apply to the hourly and minute interval schedule type. | |
object (HourlyMinutelyDetails) Hourly and minute details that apply to the hourly and minute interval schedule type. | |
object (DailyDetails) Daily details that apply to the daily interval schedule type. | |
object (WeeklyDetails) Weekly details that apply to the weekly interval schedule type. | |
object (MonthlyDetails) Monthly details that apply to the monthly interval schedule type. | |
object (YearlyDetails) Yearly details that apply to the yearly interval schedule type. |
{- "name": "string",
- "description": "string",
- "initialTaskId": 0,
- "intervalType": "Once",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "timeZoneId": "string",
- "adjustForDaylightSaving": true,
- "minutelyDetails": {
- "period": 0,
- "start": "14:15:22Z",
- "end": "14:15:22Z",
- "calendarId": 0
}, - "hourlyDetails": {
- "period": 0,
- "start": "14:15:22Z",
- "end": "14:15:22Z",
- "calendarId": 0
}, - "dailyDetails": {
- "period": 0,
- "calendarId": 0
}, - "weeklyDetails": {
- "period": 0,
- "type": "WeekDay",
- "weekDay": "First",
- "calendarId": 0
}, - "monthlyDetails": {
- "period": 0,
- "type": "NthDay",
- "missingDateAction": "Skip",
- "weekNumber": "First",
- "weekDay": "Sunday",
- "workingDay": "First",
- "calendarId": 0
}, - "yearlyDetails": {
- "period": 0
}
}
{- "id": 0
}
Permissions required:
Edit Schedule
scheduleId required | integer The ID of the schedule to start. |
startTime | string <date-time> The date and time that the schedule should be run at. |
{- "startTime": "2020-10-02T12:34:56+02:00"
}
{- "scheduledTime": "2020-10-02T12:34:56+02:00"
}
Permissions required
At least one of:
View Schedule
|Edit Schedule
|Delete Schedule
|Create Schedule
|Retire Schedule
|System - Scheduler
scheduleId required | integer The ID of the schedule for which to retrieve tasks. |
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "failFastOnError": true,
- "delayAfterEnd": 0,
- "onSuccessTaskId": 0,
- "onSuccessTaskName": "string",
- "onFailureTaskId": 0,
- "onFailureTaskName": "string",
- "sessionsCount": 0
}
]
Permissions required
At least one of:
Create Schedule
|Edit Schedule
scheduleId required | integer The ID of the schedule for which to create task. |
name | string The name of the scheduled task. |
description | string The description of the scheduled task. |
failFastOnError | boolean Determines if all errors should be regarded as a task failure. |
delayAfterEnd | integer The delay after task end. |
onSuccessTaskId | integer The ID for the task to commence on the success of this task. |
onFailureTaskId | integer The ID for the task to commence on the failure of this task. |
{- "name": "string",
- "description": "string",
- "failFastOnError": true,
- "delayAfterEnd": 0,
- "onSuccessTaskId": 0,
- "onFailureTaskId": 0
}
{- "taskId": 0
}
Permissions required
At least one of:
View Schedule
|Edit Schedule
|Delete Schedule
|Create Schedule
|Retire Schedule
|System - Scheduler
scheduleId required | integer The ID of the schedule that task belongs to. |
taskId required | integer The ID of the scheduled task to return. |
{- "id": 0,
- "name": "string",
- "description": "string",
- "failFastOnError": true,
- "delayAfterEnd": 0,
- "onSuccessTaskId": 0,
- "onSuccessTaskName": "string",
- "onFailureTaskId": 0,
- "onFailureTaskName": "string",
- "sessionsCount": 0
}
Permissions required:
Edit Schedule
and
Delete Schedule
scheduleId required | integer The ID of the schedule that task belongs to. |
taskId required | integer The ID of the task to delete. |
{- "message": "string",
- "messageDetail": "string"
}
Permissions required:
Edit Schedule
scheduleId required | integer The ID of the schedule that task belongs to |
taskId required | integer The ID of the scheduled task to update. |
name | string The name of the scheduled task. |
description | string The description of the scheduled task. |
failFastOnError | boolean Determines if all errors should be regarded as a task failure. |
delayAfterEnd | integer The delay after task end. |
onSuccessTaskId | integer The ID for the task to commence on the success of this task. |
onFailureTaskId | integer The ID for the task to commence on the failure of this task. |
{- "name": "string",
- "description": "string",
- "failFastOnError": true,
- "delayAfterEnd": 0,
- "onSuccessTaskId": 0,
- "onFailureTaskId": 0
}
{- "message": "string",
- "messageDetail": "string"
}
Permissions required:
Edit Schedule
scheduleId required | integer The ID of the schedule. |
taskId required | integer The ID of the scheduled task. |
sessionId required | integer The ID of the scheduled task session. |
{- "message": "string",
- "messageDetail": "string"
}
Permissions required
At least one of:
View Schedule
|Edit Schedule
|Delete Schedule
|Create Schedule
|Retire Schedule
|System - Scheduler
scheduleId required | integer The ID of the schedule that task belongs to. |
taskId required | integer >= 1 The ID of the task to retrieve data for. |
[- {
- "processName": "string",
- "resourceName": "string",
- "taskSessionId": 0
}
]
Permissions required
At least one of:
View Resource Screen Capture
|View Resource Details
|Manage Resource Access Rights
|Control Resource
|Configure Resource
|View Resource
And at least one of:View Process Definition
|Export Process
|Execute Process
|Manage Process Access Rights
|Execute Process as Web Service
|Edit Process Groups
|Edit Process
|Delete Process
|Create Process
andEdit Schedule
scheduleId required | integer >= 1 The ID of the schedule that task belongs to. |
taskId required | integer >= 1 The ID of the task for which to create scheduled session. |
Parameters of the scheduled session to create.
processId | string <uuid> The ID of the process. |
resourceId | string <uuid> The ID of the resource. |
{- "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
- "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6"
}
{- "scheduledSessionId": 0
}
Permissions required
At least one of:
View Schedule
|Edit Schedule
|Delete Schedule
|Create Schedule
|Retire Schedule
|System - Scheduler
taskId required | integer >= 1 The ID of the task to retrieve data for. |
[- {
- "processName": "string",
- "resourceName": "string",
- "taskSessionId": 0
}
]
Permissions required:
Edit Schedule
scheduleId required | integer >= 1 The ID of the schedule to update start-up parameters for. |
taskId required | integer >= 1 The ID of the task to update start-up parameters for. |
A collection of start up parameters.
object (DataRow) A dictionary which represents a row of data from a Blue Prism collection. | |
taskSessionId | integer <integer> The ID of scheduled task session. |
[- {
- "parameters": {
- "parameter1": {
- "valueType": "Text",
- "value": "Example value",
- "additionalParameters": [
- "UTF-8"
]
}, - "parameter2": {
- "valueType": "Number",
- "value": 123,
- "additionalParameters": null
}, - "parameter3": {
- "valueType": "Image",
- "value": "isAWPOCldncNSNLnacnKNsnaNAlknKLKScnsaklcn...",
- "additionalParameters": [
- "C:\\Path\\To\\File.ext",
- "01/01/2022 01:01:01 AM"
]
}
}, - "taskSessionId": 3
}
]
{- "message": "string",
- "messageDetail": "string"
}
Permissions required
At least one of:
View Schedule
|Edit Schedule
|Delete Schedule
|Create Schedule
|Retire Schedule
|System - Scheduler
scheduleId required | integer >= 1 The ID of the schedule to retrieve start-up parameters for. |
taskId required | integer >= 1 The ID of the task to retrieve start-up parameters for. |
[- {
- "parameters": {
- "parameter1": {
- "valueType": "Text",
- "value": "Example value",
- "additionalParameters": [
- "UTF-8"
]
}, - "parameter2": {
- "valueType": "Number",
- "value": 123,
- "additionalParameters": null
}, - "parameter3": {
- "valueType": "Image",
- "value": "isAWPOCldncNSNLnacnKNsnaNAlknKLKScnsaklcn...",
- "additionalParameters": [
- "C:\\Path\\To\\File.ext",
- "01/01/2022 01:01:01 AM"
]
}
}, - "taskSessionId": 3
}
]
Permissions required
At least one of:
View Schedule
|Edit Schedule
|Delete Schedule
|Create Schedule
|Retire Schedule
|System - Scheduler
scheduleId required | integer The ID of the schedule to retrieve data for |
sortBy | string Enum: "EndTimeAsc" "EndTimeDesc" "ScheduleLogIdAsc" "ScheduleLogIdDesc" "ScheduleNameAsc" "ScheduleNameDesc" "ServerNameAsc" "ServerNameDesc" "StartTimeAsc" "StartTimeDesc" "StatusAsc" "StatusDesc" The field that results should be sorted by and the direction they should be sorted in. |
itemsPerPage | integer The number of items to show per page |
scheduleLogStatus | Array of strings Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned" A filter to search for the status of the log. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the log start time. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the log end time. | |
pagingToken | string The token to point to the last item previously returned |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for name of the schedule. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for name of the server. |
{- "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"
}
]
}
Permissions required
At least one of:
View Schedule
|Edit Schedule
|Delete Schedule
|Create Schedule
|Retire Schedule
|System - Scheduler
sortBy | string Enum: "EndTimeAsc" "EndTimeDesc" "ScheduleLogIdAsc" "ScheduleLogIdDesc" "ScheduleNameAsc" "ScheduleNameDesc" "ServerNameAsc" "ServerNameDesc" "StartTimeAsc" "StartTimeDesc" "StatusAsc" "StatusDesc" The field that results should be sorted by and the direction they should be sorted in. |
itemsPerPage | integer The maximum number of items to retrieve per page. |
scheduleLogStatus | Array of strings Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned" A filter to search for the status of the log. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the log start time. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the log end time. | |
pagingToken | string The token to point to the last item previously returned. |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for name of the schedule. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for name of the server. |
{- "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"
}
]
}
Permissions required:
Edit Schedule
scheduleId required | integer The ID of the schedule to start. |
startTime | string <date-time> The date and time that the schedule should be run at. |
{- "startTime": "2020-10-02T12:34:56+02:00"
}
{- "scheduledTime": "2020-10-02T12:34:56+02:00"
}
Permissions required
At least one of:
View Schedule
|Edit Schedule
|Delete Schedule
|Create Schedule
|Retire Schedule
|System - Scheduler
sortBy | string Enum: "EndTimeAsc" "EndTimeDesc" "ScheduleLogIdAsc" "ScheduleLogIdDesc" "ScheduleNameAsc" "ScheduleNameDesc" "ServerNameAsc" "ServerNameDesc" "StartTimeAsc" "StartTimeDesc" "StatusAsc" "StatusDesc" "DurationAsc" "DurationDesc" The field that results should be sorted by and the direction they should be sorted in. |
itemsPerPage | integer The maximum number of items to retrieve per page. |
scheduleLogStatus | Array of strings Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned" A filter to search for the status of the log. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the log start time. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the log end time. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the schedules duration. | |
pagingToken | string The token to point to the last item previously returned. |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for name of the schedule. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for name of the server. |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "scheduleLogId": 1,
- "startTime": "2019-08-27T14:15:22Z",
- "endTime": "2019-08-27T14:15:22Z",
- "duration": "00:01:23",
- "status": "pending",
- "serverName": "Example server",
- "scheduleId": 1,
- "scheduleName": "Example schedule"
}
]
}
Permissions required
At least one of:
View Schedule
|Edit Schedule
|Delete Schedule
|Create Schedule
|Retire Schedule
|System - Scheduler
scheduleId required | integer The ID of the schedule to retrieve data for. |
sortBy | string Enum: "EndTimeAsc" "EndTimeDesc" "ScheduleLogIdAsc" "ScheduleLogIdDesc" "ServerNameAsc" "ServerNameDesc" "StartTimeAsc" "StartTimeDesc" "StatusAsc" "StatusDesc" "DurationAsc" "DurationDesc" The field that results should be sorted by and the direction they should be sorted in. |
itemsPerPage | integer The maximum number of items to retrieve per page. |
scheduleLogStatus | Array of strings Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned" A filter to search for the status of the log. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the log start time. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the log end time. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the schedules duration. | |
pagingToken | string The token to point to the last item previously returned. |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for name of the server. |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "scheduleLogId": 1,
- "startTime": "2019-08-27T14:15:22Z",
- "endTime": "2019-08-27T14:15:22Z",
- "duration": "00:01:23",
- "status": "pending",
- "serverName": "Example server",
- "scheduleId": 1,
- "scheduleName": "Example schedule"
}
]
}
Permissions required
At least one of:
Create Process
|Delete Process
|Edit Process
|Edit Process Groups
|Export Process
|Execute Process
|Execute Process as Web Service
|View Process Definition
|Manage Process Access Rights
And at least one of:View Resource
|View Resource Screen Captures
|Configure Resource
|Control Resource
|Manage Resource Access Rights
sortBy | string (getSessionsSortBy) Enum: "SessionNumberAsc" "SessionNumberDesc" "ProcessNameAsc" "ProcessNameDesc" "ResourceNameAsc" "ResourceNameDesc" "UserNameAsc" "UserNameDesc" "StatusAsc" "StatusDesc" "ExceptionTypeAsc" "ExceptionTypeDesc" "StartTimeAsc" "StartTimeDesc" "EndTimeAsc" "EndTimeDesc" "LatestStageAsc" "LatestStageDesc" "StageStartedAsc" "StageStartedDesc" 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. |
pagingToken | string The token to point to the last item previously returned. |
(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 being run by the session. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicNumericFilter) Examples:
A filter to search for the session number. | |
(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 on which the session is running/ran. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the name of the user that triggered the session. | |
status | Array of strings (SessionStatus) Items Enum: "Pending" "Running" "Terminated" "Stopped" "Completed" "Stopping" "Warning" The status of the sessions to search for. |
sessionSource | Array of strings (SessionSource) Items Enum: "Desktop" "Enterprise" The source of the sessions to search for. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the time that the session started. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the time that the session ended. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the name of the latest stage. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the time when the latest stage started. | |
onlySessionsForCurrentUser | boolean or null Flag to restrict sessions to API user. |
processId.eq | string or null <uuid> The ID of the process to retrieve data for. |
{- "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",
- "sessionSource": "Enterprise",
- "processAttribute": "Published"
}
]
}
Permissions required
At least one of:
Create Process
|Edit Process
|Execute Process
andControl Resource
Parameters to create a new session
resourceId | string <uuid> The ID of the resource or pool to create session. |
processId | string <uuid> The ID of the process to create session. |
{- "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
- "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
Permissions required
At least one of:
Create Process
|Delete Process
|Edit Process
|Edit Process Groups
|Export Process
|Execute Process
|Execute Process as Web Service
|View Process Definition
|Manage Process Access Rights
And at least one of:View Resource
|View Resource Screen Captures
|Configure Resource
|Control Resource
|Manage Resource Access Rights
sessionId required | string <uuid> The ID of the session to retrieve data for. |
{- "sessionId": "01234567-89ab-cdef-0123-456789abcdef",
- "sessionNumber": 123,
- "areStartupParamsSet": true,
- "areInputParamsSet": true,
- "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",
- "sessionSource": "Enterprise",
- "processAttribute": [
- "Retired",
- "Published",
- "PublishedWebService"
]
}
Permissions required
Control Resource
And at least one of:View Process Definition
|Edit Process
|Create Process
sessionId required | string <uuid> The ID of the pending session to delete. |
{- "message": "string",
- "messageDetail": "string"
}
Permissions required
At least one of:
Create Process
|Edit Process
|Execute Process
andControl Resource
sessionId required | string <uuid> The ID of the session to update. |
Details of the session to update, only supports 'Running', 'Stopping' and 'Stopped' statuses.
status | string Enum: "Pending" "Running" "Stopped" "Terminated" "Completed" "Stopping" "Warning" The status of the session. |
{- "status": "Pending"
}
{- "message": "string",
- "messageDetail": "string"
}
Permissions required
At least one of:
Create Process
|Edit Process
|Export Process
|Execute Process
|View Process Definition
And at least one of:View Resource
|View Resource Screen Captures
|Configure Resource
|Control Resource
|Manage Resource Access Rights
sessionId required | string <uuid> The ID of the session to retrieve start-up parameters for. |
{- "parameters": {
- "parameter1": {
- "valueType": "Text",
- "value": "Example value",
- "additionalParameters": [
- "UTF-8"
]
}, - "parameter2": {
- "valueType": "Number",
- "value": 123,
- "additionalParameters": null
}, - "parameter3": {
- "valueType": "Image",
- "value": "isAWPOCldncNSNLnacnKNsnaNAlknKLKScnsaklcn...",
- "additionalParameters": [
- "C:\\Path\\To\\File.ext",
- "01/01/2022 01:01:01 AM"
]
}
}
}
Permissions required
At least one of:
Create Process
|Edit Process
|Execute Process
andControl Resource
sessionId required | string <uuid> The ID of the session to update start-up parameters for. |
A start-up parameters for session.
object (DataRow) A dictionary which represents a row of data from a Blue Prism collection. |
{- "parameters": {
- "parameter1": {
- "valueType": "Text",
- "value": "Example value",
- "additionalParameters": [
- "UTF-8"
]
}, - "parameter2": {
- "valueType": "Number",
- "value": 123,
- "additionalParameters": null
}, - "parameter3": {
- "valueType": "Image",
- "value": "isAWPOCldncNSNLnacnKNsnaNAlknKLKScnsaklcn...",
- "additionalParameters": [
- "C:\\Path\\To\\File.ext",
- "01/01/2022 01:01:01 AM"
]
}
}
}
{- "message": "string",
- "messageDetail": "string"
}
Permissions required
At least one of:
Create Process
|Delete Process
|Edit Process
|Edit Process Groups
|Export Process
|Execute Process
|Execute Process as Web Service
|View Process Definition
|Manage Process Access Rights
And at least one of:View Resource
|View Resource Screen Captures
|Configure Resource
|Control Resource
|Manage Resource Access Rights
andAudit - Process Logs
sessionId required | string <uuid> The ID of the session to retrieve data for. |
sortBy | string (getSessionLogsSortBy) Enum: "LogNumberAsc" "LogNumberDesc" "StageIdAsc" "StageIdDesc" "StageNameAsc" "StageNameDesc" "StageTypeAsc" "StageTypeDesc" "ProcessNameAsc" "ProcessNameDesc" "PageNameAsc" "PageNameDesc" "ObjectNameAsc" "ObjectNameDesc" "ActionNameAsc" "ActionNameDesc" "ResultAsc" "ResultDesc" "ResultTypeAsc" "ResultTypeDesc" "ResourceStartTimeAsc" "ResourceStartTimeDesc" "ResourceEndTimeAsc" "ResourceEndTimeDesc" "BluePrismMemoryAsc" "BluePrismMemoryDesc" "TargetAppIdAsc" "TargetAppIdDesc" "TargetMemoryAsc" "TargetMemoryDesc" The field that results should be sorted by and the direction they should be sorted in. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the log id/number. | |
object (EqualsFilter) Examples:
A filter to search for the id of the stage. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the name of the stage. | |
stageType | Array of strings (StageType) Items Enum: "Undefined" "Action" "Decision" "Calculation" "Data" "Collection" "Process" "SubSheet" "ProcessInfo" "SubSheetInfo" "Start" "End" "Anchor" "Note" "LoopStart" "LoopEnd" "Read" "Write" "Navigate" "Code" "ChoiceStart" "ChoiceEnd" "WaitStart" "WaitEnd" "Alert" "Exception" "Recover" "Resume" "Block" "MultipleCalculation" "Skill" "Input" "Output" "EnterpriseSession" A filter to search for the type of the stage. |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the name of the process. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the name of the page. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the name of the object. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the name of the action. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the result. | |
resultType | Array of strings (ResultType) Items Enum: "Unknown" "Binary" "Collection" "Date" "DateTime" "Flag" "Image" "Number" "Password" "Text" "Time" "TimeSpan" "RadioButton" A filter to search for the type of the result. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the time that the session started. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the time that the ended started. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the blue prism memory. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the target app id. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the target memory. | |
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": [
- {
- "logId": 123,
- "logNumber": 123,
- "stageId": "00000000-0000-0000-0000-000000000000",
- "stageName": "Example stage",
- "stageType": "Calculation",
- "processName": "Example process",
- "pageName": "Example page",
- "objectName": "Example object",
- "actionName": "Example action",
- "result": "Some result",
- "resultType": "Collection",
- "resourceStartTime": "2020-10-02T12:34:56+01:00",
- "resourceEndTime": "2020-10-02T13:34:56+01:00",
- "bluePrismMemory": 123,
- "targetAppId": "Example target",
- "targetMemory": 123,
- "hasParameters": true
}
]
}
Permissions required
At least one of:
Create Process
|Delete Process
|Edit Process
|Edit Process Groups
|Export Process
|Execute Process
|Execute Process as Web Service
|View Process Definition
|Manage Process Access Rights
And at least one of:View Resource
|View Resource Screen Captures
|Configure Resource
|Control Resource
|Manage Resource Access Rights
andAudit - Process Logs
sessionId required | string <uuid> The ID of the session to retrieve data for. |
logId required | integer >= 1 The ID of the log to retrieve for the session. |
{- "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"
}
]
}
}
}
}
{- "items": [
- {
- "id": "Dateline Standard Time",
- "displayName": "(UTC-12:00) International Date Line West",
- "baseUtcOffset": "-12:00:00",
- "standardName": "Dateline Standard Time"
}, - {
- "id": "UTC-11",
- "displayName": "(UTC-11:00) Co-ordinated Universal Time-11",
- "baseUtcOffset": "-11:00:00",
- "standardName": "UTC-11"
}
]
}
Permissions required
At least one of:
Read Access to Queue Management
|Full Access to Queue Management
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" The field that results should be sorted by and the direction they should be sorted in. |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the name of the work queue. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the name of the work queue's key field. | |
status.eq | string (QueueStatus) Enum: "Running" "Paused" A filter to search for the current status of the work queue. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the configured maximum attempts of the work queue. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the pending item count of the work queue. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the locked item count of the work queue. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the completed item count of the work queue. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the exceptioned item count of the work queue. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the total item count of the work queue. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the average work time of the work queue. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the total case duration of the work queue. | |
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 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",
- "isRetryItems": true,
- "isSnapshotEnabled": true,
- "isActiveQueue": true,
- "activeWorkQueueConfiguration": {
- "assignedProcessId": "axe34dfx-1234-2435-fedc-ba9876500987",
- "assignedResourceGroupId": "xv3fd45s-6543-6231-exrf-we23e456781"
}, - "activeQueueStats": {
- "activeSessions": "10",
- "availableResources": "5",
- "timeRemaining": "01:25:10",
- "elapsedRemaining": "00:05:10",
- "ETA": "2020-10-03T13:36:21+02:00"
}
}
]
}
Permissions required
For creating work queue:
Workflow - Work Queue Configuration
For creating active work queue:Workflow - Work Queue Configuration
andControl Resource
and at least one of:Create Process
|Edit Process
|Execute Process
This endpoint does not support application server-based encryption keys. Only database-based encryption keys can be used.
Details of the queue to create.
name | string [ 1 .. 255 ] characters The name of the queue to create. |
keyField | string [ 0 .. 255 ] characters The name of the column to be used as the queue's key. |
maxAttempts | integer [ 1 .. 999999 ] The maximum number of retry attempts for items in the queue. |
status | string (QueueStatus) Enum: "Running" "Paused" The current status of the queue. |
encryptionKeyId | integer The ID of the encryption key to use for the queue. If no encryption is required, this field should be 0. |
sessionExceptionRetry | boolean Retry items in this queue in the event of an unexpected session termination. |
activeQueueAssignedProcessId | string <uuid> The ID of the process to use for an active queue. |
activeQueueAssignedResourceGroupId | string <uuid> The ID of the resource group to use for an active queue. |
groupid | object The ID of the group to use for the queue. If no group id is required, this field should be empty string like "" or empty Guid - "00000000-0000-0000-0000-000000000000". |
{- "name": "Example queue",
- "keyField": "Example field",
- "maxAttempts": 3,
- "status": "Running",
- "encryptionKeyId": 0,
- "sessionExceptionRetry": false,
- "activeQueueAssignedProcessId": "658de89c-a43d-4b18-a38c-d26d5eb26659",
- "activeQueueAssignedResourceGroupId": "5180390c-b21a-4d69-9753-b876e34f100d",
- "groupid": "a4e0b0ba-3b8f-443d-bdb0-ee519299bd01"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Permissions required
At least one of:
Read Access to Queue Management
|Full Access to Queue Management
workQueueId required | string <uuid> The ID of the queue to retrieve details for. |
{- "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",
- "isRetryItems": true,
- "isSnapshotEnabled": true,
- "isActiveQueue": true,
- "activeWorkQueueConfiguration": {
- "assignedProcessId": "axe34dfx-1234-2435-fedc-ba9876500987",
- "assignedResourceGroupId": "xv3fd45s-6543-6231-exrf-we23e456781"
}
}
Permissions required
At least one of:
Read Access to Queue Management
|Full Access to Queue Management
andWorkflow - Work Queue Configuration
This endpoint does not support application server-based encryption keys. Only database-based encryption keys can be used.
workQueueId required | string <uuid> The ID of the queue to modify. |
op required | string Enum: "add" "remove" "replace" "move" "copy" The operation to be performed. |
path required | string A JSON-Pointer. |
value | object The value to be used within the operations.. |
from | string A string containing a JSON Pointer value. |
[- {
- "op": "add",
- "path": "/someArrayProperty",
- "value": [
- "item1",
- "item2"
]
}
]
{- "message": "string",
- "messageDetail": "string"
}
Permissions required:
Workflow - Work Queue Configuration
workQueueId required | string <uuid> The ID of the queue to delete. |
{- "message": "string",
- "messageDetail": "string"
}
Permissions required:
Workflow - Work Queue Configuration
workQueueId required | string <uuid> The ID of the queue to get references of. |
sortBy | string Enum: "NameAsc" "NameDesc" "DescriptionAsc" "DescriptionDesc" "ProcessTypeAsc" "ProcessTypeDesc" 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. |
pagingToken | string The token to point to the last item previously returned. |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the name of the reference. | |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the description of the reference. | |
processType | Array of strings Items Enum: "Process" "Object" The type of the process to search for. |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "type": "Process"
}
]
}
Permissions required
At least one of:
Read Access to Queue Management
|Full Access to Queue Management
Additional permissions for accessing Active Queue items
At least one of:
Create Process
|Edit Process
|Execute Process
AndControl Resource
workQueueId required | string <uuid> The ID of the queue to get an item from. |
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" "SlaAsc" "SlaDesc" "SlaDateTimeAsc" "SlaDateTimeDesc" "ProcessNameAsc" "ProcessNameDesc" "IsSuggestedAsc" "IsSuggestedDesc" The field that results should be sorted by and the direction they should be sorted in. |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the value of the key field of the work queue item. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the status of the work queue item. | |
state | Array of strings Items Enum: "Pending" "Locked" "Deferred" "Completed" "Exceptioned" A filter to search for the current state of the work queue item. |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the total work time of the work queue item. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the time the work queue item was loaded onto the queue. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the time the work queue item is deferred until. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the time the work queue item was locked. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the time the work queue item was completed. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the time the work queue item exceptioned. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the time the work queue item was last updated. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the current attempt number of the work queue item. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the priority of the work queue item. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the reason that the work queue item exceptioned. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the sla time the work queue item. | |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the process name of the work queue item. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the sla time of the work queue item. | |
withinSla | boolean Flag to get work queue items within sla time. |
object (EqualsFilter) Example: A filter to search the work queue items which is used to help troubleshoot issues. | |
itemsPerPage | integer 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",
- "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",
- "sessionId": "01234567-89ab-cdef-0123-456789abcdef",
- "sla": 7200,
- "slaDateTime": "0001-01-01T00:00:00Z",
- "processName": "Example process name",
- "isSuggested": false
}
]
}
Permissions required:
Full Access to Queue Management
Additional permissions for accessing Active Queue items
At least one of:
Create Process
|Edit Process
|Execute Process
AndControl Resource
workQueueId required | string <uuid> The ID of the queue to insert into. |
Details of the queue items to create.
object (DataCollection) Represents a Blue Prism collection. | |
deferredDate | string <date-time> The earliest time and date that this item is deferred until. |
priority | integer <integer> The priority value assigned to the item. |
tags | Array of strings A collection of tags assigned to the item. |
status | string The user-supplied status value. |
sla | integer The user-supplied sla value. |
processName | string The user-supplied process name value. |
isSuggested | boolean The user-supplied isSuggested value - default value should be false. |
[- {
- "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",
- "sla": 7200,
- "processName": "Example process name",
- "isSuggested": false
}
]
{- "ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Permissions required:
Full Access to Queue Management
Additional permissions for accessing Active Queue items
At least one of:
Create Process
|Edit Process
|Execute Process
AndControl Resource
This endpoint does not support application server-based encryption keys. Only work queues that are not encrypted, or use database-based encryption keys can use this endpoint.
workQueueId required | string <uuid> The ID of the queue to insert into. |
Details of the queue items to create.
object (DataCollection) Represents a Blue Prism collection. | |
deferredDate | string <date-time> The earliest time and date that this item is deferred until. |
priority | integer <integer> The priority value assigned to the item. |
tags | Array of strings A collection of tags assigned to the item. |
status | string The user-supplied status value. |
sla | integer The user-supplied sla value. |
processName | string The user-supplied process name value. |
isSuggested | boolean The user-supplied isSuggested value - default value should be false. |
[- {
- "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",
- "sla": 7200,
- "processName": "Example process name",
- "isSuggested": false
}
]
{- "ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Permissions required
At least one of:
Read Access to Queue Management
|Full Access to Queue Management
Additional permissions for accessing Active Queue items
At least one of:
Create Process
|Edit Process
|Execute Process
AndControl Resource
This endpoint does not support application server-based encryption keys. Only work queues that are not encrypted, or use database-based encryption keys can use this endpoint.
workQueueItemId required | string <uuid> The ID of the item to get. |
{- "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",
- "sessionId": "01234567-89ab-cdef-0123-456789abcdef",
- "data": {
- "rows": [
- {
- "valueType": "Number",
- "value": 321
}, - {
- "valueType": "Date",
- "value": "2020-10-02T12:34:56+01:00"
}
]
}, - "sla": 7200,
- "slaDateTime": "0001-01-01T00:00:00Z",
- "processName": "Example process name",
- "isSuggested": false
}
Permissions required
At least one of:
Read Access to Queue Management
|Full Access to Queue Management
.Additional permissions for accessing Active Queue item
At least one of:
Create Process
|Edit Process
|Execute Process
AndControl Resource
This endpoint does not support application server-based encryption keys. Only work queues that are not encrypted, or use database-based encryption keys can use this endpoint.
workQueueId required | string <uuid> The queue ID of the item to get. |
workQueueItemId required | string <uuid> The ID of the item to get. |
{- "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",
- "sessionId": "01234567-89ab-cdef-0123-456789abcdef",
- "data": {
- "rows": [
- {
- "valueType": "Number",
- "value": 321
}, - {
- "valueType": "Date",
- "value": "2020-10-02T12:34:56+01:00"
}
]
}, - "sla": 7200,
- "slaDateTime": "0001-01-01T00:00:00Z",
- "processName": "Example process name",
- "isSuggested": false
}
Permissions required
At least one of:
Read Access to Queue Management
|Full Access to Queue Management
.Additional permissions for accessing Active Queue item
At least one of:
Create Process
|Edit Process
|Execute Process
AndControl Resource
workQueueId required | string <uuid> The queue ID of the item to return attempts. |
workQueueItemId required | string <uuid> The ID of the item to return attempts. |
[- {
- "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",
- "lastUpdated": "2020-10-02T12:34:56+01:00",
- "workTimeInSeconds": 123,
- "attemptWorkTimeInSeconds": 56,
- "resource": "Example resource",
- "sessionId": "01234567-89ab-cdef-0123-456789abcdef",
- "sla": 7200,
- "slaDateTime": "0001-01-01T00:00:00Z",
- "processName": "Example process name",
- "isSuggested": false
}
]
Permissions required:
Full Access to Queue Management
workQueueId required | string <uuid> The queue ID of the item to force retry. |
workQueueItemId required | string <uuid> The ID of the item to force retry. |
{- "attemptId": 0
}
Permissions required:
Full Access to Queue Management
workQueueId required | string <uuid> The queue ID of the item to delete. |
workQueueItemId required | string <uuid> The ID of the item to delete. |
attemptId required | number The ID of the attempt of the work queue item to delete |
{- "message": "string",
- "messageDetail": "string"
}
Permissions required:
Full Access to Queue Management
workQueueId required | string <uuid> The queue ID of the item to update. |
workQueueItemId required | string <uuid> The ID of the item to update. |
attemptId required | number The ID of the attempt of the work queue item to update |
op required | string Enum: "add" "remove" "replace" "move" "copy" The operation to be performed. |
path required | string A JSON-Pointer. |
value | object The value to be used within the operations.. |
from | string A string containing a JSON Pointer value. |
[- {
- "op": "replace",
- "path": "/property",
- "value": "propertyValue"
}
]
{- "message": "string",
- "messageDetail": "string"
}
Permissions required:
Workflow - Work Queue Configuration
identifier required | string <uuid or "root"> It can be 'root' value to get a root group or the ID of the work queue group to retrieve details for. |
{- "id": "01234567-89ab-cdef-0123-456789abcdef",
- "name": "Example work queue group",
- "parentGroupId": "fedcba98-7654-3210-fedc-ba9876543210",
- "hasChildGroups": false,
- "hasChildItems": false
}
Permissions required:
Workflow - Work Queue Configuration
identifier required | string <uuid or "root"> The ID of the work queue group to update. |
op required | string Enum: "add" "remove" "replace" "move" "copy" The operation to be performed. |
path required | string A JSON-Pointer. |
value | object The value to be used within the operations.. |
from | string A string containing a JSON Pointer value. |
[- {
- "op": "replace",
- "path": "/property",
- "value": "propertyValue"
}
]
{- "message": "string",
- "messageDetail": "string"
}
Permissions required:
Workflow - Work Queue Configuration
Details of the group to create.
name | string [ 1 .. 255 ] characters The name of the group to create. |
parentGroupId | string <uuid or "root"> The ID of the group to use as a parent. |
{- "name": "Test Group",
- "parentGroupId": "a4e0b0ba-3b8f-443d-bdb0-ee519299bd01"
}
{- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}
Permissions required:
Workflow - Work Queue Configuration
workQueueGroupId required | string <uuid> The ID of the work queue group to delete. |
{- "message": "string",
- "messageDetail": "string"
}
Permissions required:
Workflow - Work Queue Configuration
identifier required | string <uuid or "root"> It can be a 'root' value to get work queues from the root queue group or the ID of the work queue group to retrieve work queues from it. |
sortBy | string Enum: "NameAsc" "NameDesc" 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. |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the name of items inside work queue group. |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "id": "01234567-89ab-cdef-0123-456789abcdef",
- "name": "queue 1"
}
]
}
Permissions required:
Workflow - Work Queue Configuration
identifier required | string <uuid or "root"> It can be a 'root' value to get details of groups from the root or the ID of the parent work queue group to retrieve details of child groups. |
sortBy | string Enum: "NameAsc" "NameDesc" "HasChildGroupsAsc" "HasChildGroupsDesc" "HasChildItemsAsc" "HasChildItemsDesc" 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. |
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter) Examples:
A filter to search for the name of the queue group. | |
hasChildGroups | Array of strings Items Enum: "true" "false" The availability of child groups in the group. |
hasChildItems | Array of strings Items Enum: "true" "false" The availability of child items in the group. |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "id": "01234567-89ab-cdef-0123-456789abcdef",
- "name": "Example work queue group",
- "parentGroupId": "fedcba98-7654-3210-fedc-ba9876543210",
- "hasChildGroups": false,
- "hasChildItems": false
}
]
}
Permissions required:
System - License permission
pagingToken | string The token to point to the last item previously returned. |
itemsPerPage | integer >= 1 The maximum number of items to retrieve per page. |
sortBy | string Enum: "LicenseIdAsc" "LicenseIdDesc" "StatusAsc" "StatusDesc" "ActivationStatusAsc" "ActivationStatusDesc" "OwnerAsc" "OwnerDesc" "TypeAsc" "TypeDesc" "StartsAsc" "StartsDesc" "ExpiresAsc" "ExpiresDesc" "ProcessesAsc" "ProcessesDesc" "SessionsAsc" "SessionsDesc" "ResourcesAsc" "ResourcesDesc" "AlertsAsc" "AlertsDesc" "StandaloneAsc" "StandaloneDesc" "DecipherIDPAsc" "DecipherIDPDesc" The field that results should be sorted by and the direction they should be sorted in. |
status | Array of strings Items Enum: "Future" "Expired" "ExpiresSoon" "GracePeriodEndsSoon" "RequiresActivation" "Active" The status of the license to search for. |
activationStatus | Array of strings Items Enum: "NotApplicable" "NotActivated" "Activated" The activation status of the license to search for. |
type | Array of strings Items Enum: "None" "Enterprise" "NHS" "Evaluation" "Education" "Desktop" The type of the license to search for. |
(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter) Examples:
A filter to search for the owner of the license. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the date that the license starts. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the date that the license expires. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the number of processes that may be published. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the number of sessions which may be run. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the number of runtime resources which may be registered at any one time. | |
(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter) Examples:
A filter to search for the number of machines on which Process Alerts may be used. | |
standalone.eq | boolean A filter to check availability of license standalone. |
decipherIDP.eq | boolean A filter to check availability of license decipherIDP. |
{- "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
- "items": [
- {
- "id": 1,
- "status": "Active",
- "owner": "Test License",
- "activationStatus": "NotApplicable",
- "type": "Enterprise",
- "starts": "2021-01-31",
- "expires": "2023-01-31",
- "processes": "1",
- "sessions": "unlimited",
- "resources": "5",
- "alerts": "50",
- "standalone": true,
- "decipherIDP": false
}
]
}
Permissions required:
System - License permission
Encoded license key.
encodedLicenseKey | string The encoded license key. |
{- "encodedLicenseKey": "PD94bWwgdmVyc2lvbj0iMS4"
}
{- "id": 1,
- "status": "Active",
- "expires": "2023-01-31",
- "owner": "Test License"
}