Documentation Powered by ReDoc

Blue Prism API (7.0.0)

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

Authentication

Bearer

JWT token issued from Authentication Server

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

OAuth2

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://auth-server/connect/token
Scopes:
  • bp-api -

    API scope

  • bpserver -

    Blue Prism Application scope

Dashboards

Return aggregate work queue data for each of the requested queues.

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
workQueueIds
required
Array of strings <uuid>

Array of work queue IDs to retrieve data for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return runtime resource utilization

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return runtime resources summary utilization by date range

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Encryption Schemes

Return a list of encryption schemes in the environment

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Resources

Return a list of resources in the environment

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • name[eq]=Example - Search for a value equal to "Example".
  • name[strtw]=Exa - Search a value starting with "Exa".
  • name[gte]=Ex&name[lte]=F - Search for a value alphanumerically between "Ex" and "F".
  • name[gte]=Example - Search for a value alphanumerically after or equal to "Example".

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:
  • groupName[eq]=Example - Search for a value equal to "Example".
  • groupName[strtw]=Exa - Search a value starting with "Exa".
  • groupName[gte]=Ex&groupName[lte]=F - Search for a value alphanumerically between "Ex" and "F".
  • groupName[gte]=Example - Search for a value alphanumerically after or equal to "Example".

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:
  • poolName[eq]=Example - Search for a value equal to "Example".
  • poolName[strtw]=Exa - Search a value starting with "Exa".
  • poolName[gte]=Ex&poolName[lte]=F - Search for a value alphanumerically between "Ex" and "F".
  • poolName[gte]=Example - Search for a value alphanumerically after or equal to "Example".

A filter to search for the pool name of the resource.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • activeSessionCount[eq]=123 - Search for a value equal to 123.
  • activeSessionCount[gte]=123&activeSessionCount[lte]=321 - Search for a value between 123 and 321 inclusive.
  • activeSessionCount[lte]=123 - Search for a value less than or equal to 123.

A filter to search for resource's active session count.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • pendingSessionCount[eq]=123 - Search for a value equal to 123.
  • pendingSessionCount[gte]=123&pendingSessionCount[lte]=321 - Search for a value between 123 and 321 inclusive.
  • pendingSessionCount[lte]=123 - Search for a value less than or equal to 123.

A filter to search for resource's pending session count.

displayStatus
Array of strings
Items Enum: "Working" "Idle" "Warning" "Offline" "Missing" "LoggedOut" "Private"

A filter to search for the current status of the resource.

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 on this page.

pagingToken
string

The token to point to the last item previously returned.

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Schedules

Return a list of schedules in the environment

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • name[eq]=Example - Search for a value equal to "Example".
  • name[strtw]=Exa - Search a value starting with "Exa".
  • name[gte]=Ex&name[lte]=F - Search for a value alphanumerically between "Ex" and "F".
  • name[gte]=Example - Search for a value alphanumerically after or equal to "Example".

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

pagingToken
string

The token to point to the last item previously returned

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Update a given schedule

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
scheduleId
required
integer

The ID of the schedule to update

Request Body schema: application/json
isRetired
boolean

A new value for schedule retirement status

Responses

Request samples

Content type
application/json
{
  • "isRetired": true
}

Response samples

Content type
application/json
{
  • "invalidField": "string",
  • "message": "string"
}

Return all schedule logs

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
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:
  • startTime[eq]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • startTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&startTime[lte]=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • startTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

A filter to search for the log start time.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • endTime[eq]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • endTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&endTime[lte]=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • endTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

A filter to search for the log end time.

pagingToken
string

The token to point to the last item previously returned

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "string",
  • "items": [
    ]
}

Return all logs for a specified schedule

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
scheduleId
required
integer

The ID of the schedule to retrieve data for

query Parameters
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:
  • startTime[eq]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • startTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&startTime[lte]=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • startTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

A filter to search for the log start time.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • endTime[eq]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • endTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&endTime[lte]=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • endTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

A filter to search for the log end time.

pagingToken
string

The token to point to the last item previously returned

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "string",
  • "items": [
    ]
}

Set a schedule to run at a specific date and time

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
scheduleId
required
string <uuid>

The ID of the schedule to start

Request Body schema: application/json
startTime
string <date-time>

The date and time that the schedule should be run at

Responses

Request samples

Content type
application/json
{
  • "startTime": "2020-10-02T10:34:56.000Z"
}

Response samples

Content type
application/json
{
  • "scheduledTime": "2020-10-02T10:34:56.000Z"
}

Retrieve a list of tasks in a schedule

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
scheduleId
required
integer

The ID of the schedule for which to retrieve tasks

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return a list of the scheduled sessions for a specified task

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
taskId
required
integer >= 1

The ID of the task to retrieve data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sessions

Return a list of sessions in the environment

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
sortBy
string
Enum: "SessionNumberAsc" "SessionNumberDesc" "ProcessNameAsc" "ProcessNameDesc" "ResourceNameAsc" "ResourceNameDesc" "UserNameAsc" "UserNameDesc" "StatusAsc" "StatusDesc" "ExceptionTypeAsc" "ExceptionTypeDesc" "StartTimeAsc" "StartTimeDesc" "EndTimeAsc" "EndTimeDesc" "LatestStageAsc" "LatestStageDesc" "StageStartedAsc" "StageStartedDesc"

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:
  • processName[eq]=Example - Search for a value equal to "Example".
  • processName[strtw]=Exa - Search a value starting with "Exa".
  • processName[gte]=Ex&processName[lte]=F - Search for a value alphanumerically between "Ex" and "F".
  • processName[gte]=Example - Search for a value alphanumerically after or equal to "Example".

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) (BasicStringFilter)
Examples:
  • sessionNumber[eq]=Example - Search for a value equal to "Example".
  • sessionNumber[strtw]=Exa - Search a value starting with "Exa".
  • sessionNumber[gte]=Ex&sessionNumber[lte]=F - Search for a value alphanumerically between "Ex" and "F".
  • sessionNumber[gte]=Example - Search for a value alphanumerically after or equal to "Example".

A filter to search for the session number.

(RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) or StartsWithStringFilter (object) (BasicStringFilter)
Examples:
  • resourceName[eq]=Example - Search for a value equal to "Example".
  • resourceName[strtw]=Exa - Search a value starting with "Exa".
  • resourceName[gte]=Ex&resourceName[lte]=F - Search for a value alphanumerically between "Ex" and "F".
  • resourceName[gte]=Example - Search for a value alphanumerically after or equal to "Example".

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:
  • userName[eq]=Example - Search for a value equal to "Example".
  • userName[strtw]=Exa - Search a value starting with "Exa".
  • userName[gte]=Ex&userName[lte]=F - Search for a value alphanumerically between "Ex" and "F".
  • userName[gte]=Example - Search for a value alphanumerically after or equal to "Example".

A filter to search for the name of the user that triggered the session.

status
Array of strings
Items Enum: "Pending" "Running" "Terminated" "Stopped" "Completed" "Stopping" "Warning"

The status of the sessions to search for.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • startTime[eq]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • startTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&startTime[lte]=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • startTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

A filter to search for the time that the session started.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • endTime[eq]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • endTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&endTime[lte]=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • endTime[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

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:
  • latestStage[eq]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • latestStage[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&latestStage[lte]=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • latestStage[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

A filter to search for the name of the latest stage.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • stageStarted[eq]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • stageStarted[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&stageStarted[lte]=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • stageStarted[gte]=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

A filter to search for the time when the latest stage started

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Get details of a specified session

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
sessionId
required
string <uuid>

The ID of the session to retrieve data for

Responses

Response samples

Content type
application/json
{
  • "sessionId": "01234567-89ab-cdef-0123-456789abcdef",
  • "sessionNumber": 123,
  • "processId": "01234567-89ab-cdef-0123-456789abcdef",
  • "processName": "Example process",
  • "resourceId": "01234567-89ab-cdef-0123-456789abcdef",
  • "resourceName": "Example resource",
  • "username": "Example user",
  • "status": "Running",
  • "startTime": "2020-10-02T10:34:56.000Z",
  • "endTime": "2020-10-03T11:36:21.000Z",
  • "latestStage": "Example stage",
  • "stageStarted": "2020-10-02T10:35:30.000Z",
  • "exceptionMessage": "Exception message",
  • "terminationReason": "InternalError",
  • "exceptionType": "Exception type"
}

Return all logs for a specified session

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
sessionId
required
string <uuid>

The ID of the session to retrieve data for

query Parameters
itemsPerPage
integer >= 1

The maximum number of items to retrieve

pagingToken
string

The token to point to the last item previously returned

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Return all parameters for a specified session log

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
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

Responses

Response samples

Content type
application/json
{
  • "inputs": {
    },
  • "outputs": {
    }
}

Work Queues

Return a list of work queues in the environment

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
query Parameters
sortBy
string
Enum: "NameAsc" "NameDesc" "StatusAsc" "StatusDesc" "KeyFieldAsc" "KeyFieldDesc" "MaxAttemptsAsc" "MaxAttemptsDesc" "IsEncryptedAsc" "IsEncryptedDesc" "TotalItemCountAsc" "TotalItemCountDesc" "CompletedItemCountAsc" "CompletedItemCountDesc" "PendingItemCountAsc" "PendingItemCountDesc" "LockedItemCountAsc" "LockedItemCountDesc" "ExceptionedItemCountAsc" "ExceptionedItemCountDesc" "TotalCaseDurationAsc" "TotalCaseDurationDesc" "AverageWorkTimeAsc" "AverageWorkTimeDesc"

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:
  • name[eq]=Example - Search for a value equal to "Example".
  • name[strtw]=Exa - Search a value starting with "Exa".
  • name[ctn]=amp - Search a value containing "amp"
  • name[gte]=Ex&name[lte]=F - Search for a value alphanumerically between "Ex" and "F".
  • name[gte]=Example - Search for a value alphanumerically after or equal to "Example".

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:
  • keyField[eq]=Example - Search for a value equal to "Example".
  • keyField[strtw]=Exa - Search a value starting with "Exa".
  • keyField[ctn]=amp - Search a value containing "amp"
  • keyField[gte]=Ex&keyField[lte]=F - Search for a value alphanumerically between "Ex" and "F".
  • keyField[gte]=Example - Search for a value alphanumerically after or equal to "Example".

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:
  • eq=123 - Search for a value equal to 123.
  • gte=123&lte=321 - Search for a value between 123 and 321 inclusive.
  • lte=123 - Search for a value less than or equal to 123.

A filter to search for the configured maximum attempts of the work queue.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Search for a value equal to 123.
  • gte=123&lte=321 - Search for a value between 123 and 321 inclusive.
  • lte=123 - Search for a value less than or equal to 123.

A filter to search for the pending item count of the work queue.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Search for a value equal to 123.
  • gte=123&lte=321 - Search for a value between 123 and 321 inclusive.
  • lte=123 - Search for a value less than or equal to 123.

A filter to search for the locked item count of the work queue.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Search for a value equal to 123.
  • gte=123&lte=321 - Search for a value between 123 and 321 inclusive.
  • lte=123 - Search for a value less than or equal to 123.

A filter to search for the completed item count of the work queue.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Search for a value equal to 123.
  • gte=123&lte=321 - Search for a value between 123 and 321 inclusive.
  • lte=123 - Search for a value less than or equal to 123.

A filter to search for the exceptioned item count of the work queue.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=123 - Search for a value equal to 123.
  • gte=123&lte=321 - Search for a value between 123 and 321 inclusive.
  • lte=123 - Search for a value less than or equal to 123.

A filter to search for the total item count of the work queue.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=45296 - Search for a value equal to 12:34:56.
  • gte=01:23:45&lte=45296 - Search for a value between 01:23:45 and 12:34:56 (inclusive)
  • lte=45296 - Search for a value less than or equal to 12:34:56

A filter to search for the average work time of the work queue.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=45296 - Search for a value equal to 12:34:56.
  • gte=01:23:45&lte=45296 - Search for a value between 01:23:45 and 12:34:56 (inclusive)
  • lte=45296 - Search for a value less than or equal to 12:34:56

A filter to search for the total case duration of the work queue.

itemsPerPage
integer >= 1

The maximum number of items to return in the current page.

pagingToken
string

The token to point to the last item previously returned

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Create a new work queue

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
Request Body schema: application/json

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 then this field should be 0

Responses

Request samples

Content type
application/json
{
  • "name": "Example queue",
  • "keyField": "Example field",
  • "maxAttempts": 3,
  • "status": "Running",
  • "encryptionKeyId": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Return details of a work queue

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueId
required
string <uuid>

The ID of the queue to retrieve details for

Responses

Response samples

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

Modifiy the work queue as described in the patch document

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueId
required
string <uuid>

The ID of the queue to modify

Request Body schema: application/json
Array ()
op
required
string
Enum: "add" "remove" "replace" "move" "copy" "test"

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.

Responses

Request samples

Content type
application/json
Example
Add values to a collection.
Add values to a collection.
Add new property values to an object.
Copy a value from one property to another.
Move a value from one property to another.
Remove a property value.
Replace the value in a property.
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "invalidField": "string",
  • "message": "string"
}

Delete a specified work queue

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueId
required
string <uuid>

The ID of the queue to delete

Responses

Response samples

Content type
application/json
{
  • "invalidField": "string",
  • "message": "string"
}

Return items in a specified work queue

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueId
required
string <uuid>

The ID of the queue to get an item from

query Parameters
sortBy
string
Enum: "AttemptAsc" "AttemptDesc" "AttemptWorkTimeAsc" "AttemptWorkTimeDesc" "CompletedAsc" "CompletedDesc" "DeferredAsc" "DeferredDesc" "ExceptionAsc" "ExceptionDesc" "ExceptionReasonAsc" "ExceptionReasonDesc" "KeyValueAsc" "KeyValueDesc" "LastUpdatedAsc" "LastUpdatedDesc" "LoadedAsc" "LoadedDesc" "LockedAsc" "LockedDesc" "PriorityAsc" "PriorityDesc" "StatusAsc" "StatusDesc" "WorkTimeAsc" "WorkTimeDesc"

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:
  • eq=Example - Search for a value equal to "Example".
  • strtw=Exa - Search a value starting with "Exa".
  • ctn=amp - Search a value containing "amp"
  • gte=Ex&lte=F - Search for a value alphanumerically between "Ex" and "F".
  • gte=Example - Search for a value alphanumerically after or equal to "Example".

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:
  • eq=Example - Search for a value equal to "Example".
  • strtw=Exa - Search a value starting with "Exa".
  • ctn=amp - Search a value containing "amp"
  • gte=Ex&lte=F - Search for a value alphanumerically between "Ex" and "F".
  • gte=Example - Search for a value alphanumerically after or equal to "Example".

A filter to search for the status of the work queue item.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=45296 - Search for a value equal to 12:34:56.
  • gte=01:23:45&lte=45296 - Search for a value between 01:23:45 and 12:34:56 (inclusive)
  • lte=45296 - Search for a value less than or equal to 12:34:56

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:
  • eq=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&lte=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

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:
  • eq=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&lte=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

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:
  • eq=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&lte=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

A filter to search for the time the work queue item was locked.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&lte=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

A filter to search for the time the work queue item was completed.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&lte=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

A filter to search for the time the work queue item exceptioned.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time)&lte=Mon Nov 02 2020 11:34:56 GMT+0000 (Greenwich Mean Time) - Search for a value between 2020-10-02 at 12:34:56 (GMT+1) and 2020-11-02 at 12:34:56 (GMT+1) (inclusive).
  • gte=Fri Oct 02 2020 12:34:56 GMT+0100 (British Summer Time) - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

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:
  • eq=123 - Search for a value equal to 123.
  • gte=123&lte=321 - Search for a value between 123 and 321 inclusive.
  • lte=123 - Search for a value less than or equal to 123.

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:
  • eq=123 - Search for a value equal to 123.
  • gte=123&lte=321 - Search for a value between 123 and 321 inclusive.
  • lte=123 - Search for a value less than or equal to 123.

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:
  • eq=Example - Search for a value equal to "Example".
  • ctn=amp - Search a value containing "amp"
  • strtw=Exa - Search a value starting with "Exa".
  • gte=Ex&lte=F - Search for a value alphanumerically between "Ex" and "F".
  • gte=Example - Search for a value alphanumerically after or equal to "Example".

A filter to search for the reason that the work queue item exceptioned.

itemsPerPage
integer

The maximum number of items to retrieve

pagingToken
string

The token to point to the last item previously returned

Responses

Response samples

Content type
application/json
{
  • "pagingToken": "U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho",
  • "items": [
    ]
}

Add items to a queue

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueId
required
string <uuid>

The ID of the queue to insert into

Request Body schema: application/json

Details of the queue items to create

Array ()
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

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": [
    ]
}

Return details of a specified item from a work queue

Authorizations:
Bearer (bp-apibpserver) OAuth2 (bp-apibpserver)
path Parameters
workQueueItemId
required
string <uuid>

The ID of the item to get

Responses

Response samples

Content type
application/json
{
  • "id": "01234567-89ab-cdef-0123-456789abcdef",
  • "priority": 3,
  • "ident": 123,
  • "state": "Completed",
  • "keyValue": "Example value",
  • "status": "Example status",
  • "tags": [
    ],
  • "attemptNumber": 1,
  • "loadedDate": "2020-10-02T11:34:56.000Z",
  • "deferredDate": "2020-10-02T11:34:56.000Z",
  • "lockedDate": "1901-01-01T00:00:00.000Z",
  • "completedDate": "2020-10-02T12:00:00.000Z",
  • "exceptionedDate": "1901-01-01T00:00:00.000Z",
  • "exceptionReason": "Example reason",
  • "lastUpdated": "2020-10-02T12:00:00.000Z",
  • "workTimeInSeconds": 123,
  • "attemptWorkTimeInSeconds": 123,
  • "resource": "Example resource",
  • "data": {
    }
}