Blue Prism API (7.1.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

Calendars

Return a list of calendars.

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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.

Permissions required: Security - View Encryption Scheme Configuration

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Processes

Return a list of all the processes in the environment.

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

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

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

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:
  • 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 process.

attributesInclude
Array of strings
Items Enum: "Retired" "Published" "PublishedWebService"

A filter to search for attributes to be included.

attributesExclude
Array of strings
Items Enum: "Retired" "Published" "PublishedWebService"

A filter to search for attributes to be excluded.

sortBy
string
Enum: "NameAsc" "NameDesc" "DescriptionAsc" "DescriptionDesc" "GroupAsc" "GroupDesc"

The field that results should be sorted by and the direction they should be sorted in.

itemsPerPage
integer >= 1

The maximum number of items to retrieve per page.

pagingToken
string

The token to point to the last item previously returned.

Responses

Response samples

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

Resources

Return a list of resources in the environment.

Permissions required

At least one of: View Resource | View Resource Screen Captures | Configure Resource | Control Resource | Manage Resource Access Rights | View Resource Details

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" "Details"

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

retirementFilter
string
Enum: "NonRetired" "Retired" "All"

A filter to search for the retirement status of the resource. The default behavior is to search for non-retired resources.

sortBy
string
Enum: "NameAsc" "NameDesc" "PoolAsc" "PoolDesc" "GroupAsc" "GroupDesc" "PendingAsc" "PendingDesc" "ActiveAsc" "ActiveDesc" "DisplayStatusAsc" "DisplayStatusDesc"

The field that results should be sorted by and the direction they should be sorted in.

itemsPerPage
integer >= 1

The maximum number of items to retrieve per page.

pagingToken
string

The token to point to the last item previously returned.

Responses

Response samples

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

Retire or unretire a resource with the given ID.

Permissions required: Configure Resource

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

The ID of the resource or pool.

Request Body schema: application/json

To retire an active resource, use "Retire". To unretire a resource, use "None". The "Retire" attribute should not be included if attempting to unretire a resource.

attributes
Array of strings (ResourceAttribute)
Items Enum: "None" "Retired" "Local" "LoginAgent" "Private" "DefaultInstance"

The attributes to assign to the resource.

Responses

Request samples

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

Response samples

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

Pools

Return a list of resource pools.

Permissions required

At least one of: View Resource | View Resource Screen Captures | Configure Resource | Control Resource | Manage Resource Access Rights | View Resource Details

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Schedules

Return a list of schedules in the environment.

Permissions required

At least one of: View Schedule | Edit Schedule | Delete Schedule | Create Schedule | Retire Schedule | System - Scheduler

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 string