How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Blue Prism

Blue Prism API

The Blue Prism API is the REST contract for Blue Prism Enterprise. It exposes work queues and work queue items, sessions and session logs, schedules, scheduled tasks and schedule logs, calendars and holiday regions, processes, runtime resources and pools, environment variables, encryption schemes, licences, Control Room dashboards and webhook subscriptions. 94 operations across 67 paths, OpenAPI 3.0.3, version 7.5.1. Authentication is a JWT bearer token issued by Blue Prism Authentication Server via the OAuth 2.0 client-credentials grant.

Documentation Provider Profile APIs.io OpenAPI GitHub

Blue Prism API is one of 2 APIs that Blue Prism publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AI Automation, RPA, Intelligent Automation, and Workflow-Automation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 94 operations across 67 paths, organized into 17 resource areas, and defines 136 schemas. It is described by OpenAPI 3.0.3, at version 7.5.1.

Requests are made against a single base URL, https://{address}.

94 operations 67 paths 136 schemas 13 DELETE51 GET7 PATCH18 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
7.5.1
Base URL
https://{address}/api/v7
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
17

Authentication & Security 2

Blue Prism API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 2 scopes. By default, every request must be authenticated.

  • Bearer — JWT token issued from Authentication Server.

Paths & Operations 94

Across 67 paths, the API surfaces 94 operations — 13 DELETE, 51 GET, 7 PATCH, 18 POST, 5 PUT. They span 17 resource areas, including Calendars, Dashboards, Encryption Schemes, Environment Variables, Health, Processes, Resources, Pools, and 9 more. Each is listed below with its method, path, parameters, and response codes.

Calendars 12
GET
/api/v7/calendars
Return a list of calendars.
getCalendars 5 params → 200400401403
POST
/api/v7/calendars
Creates a Calendar.
body → 201400401403
GET
/api/v7/calendars/{calendarId}
Returns a calendar by Id
1 param → 200400401403404
DELETE
/api/v7/calendars/{calendarId}
Deletes a specified calendar.
1 param → 204400401403404409
PATCH
/api/v7/calendars/{calendarId}
Update a calendar by Id
updateCalendar 1 param body → 204400401403404
POST
/api/v7/calendars/{calendarId}/clones
Clones a calendar by Id
1 param body → 201400401403404
GET
/api/v7/calendars/{calendarId}/otherHolidays
Returns calendar other holidays by calendar Id
1 param → 200401403404
DELETE
/api/v7/calendars/{calendarId}/otherHolidays/batch
Deletes other holidays in calendar.
1 param body → 204400401403404
POST
/api/v7/calendars/{calendarId}/otherHolidays/batch
Creates other holidays in calendar.
1 param body → 204400401403404
GET
/api/v7/calendars/{calendarId}/references
Returns a list of process that reference a given calendar.
7 params → 200400401403404
GET
/api/v7/holidayRegions
Return a list of holiday regions.
getHolidayRegions → 200401403
GET
/api/v7/holidayRegions/{holidayRegionId}/publicHolidays
Return a list of holiday by region id.
getHolidayByRegionId 1 param → 200401403404
Dashboards 5
GET
/api/v7/dashboards/workQueueCompositions
Return aggregate work queue data for each of the requested queues.
getWorkQueueData 1 param → 200400401403
GET
/api/v7/dashboards/resourceUtilization
Return runtime resource utilization.
getResourceUtilization 4 params → 200400401403404
GET
/api/v7/dashboards/resourcesSummaryUtilization
Return runtime resources summary utilization by date range.
getResourceSummaryUtilizationByDate 3 params → 200400401403404
GET
/api/v7/dashboards/licensesEntitlement
Return aggregated licenses entitlement data.
→ 200400401403
GET
/api/v7/dashboards/currentLimitsAndUsage
Return current active licenses limits and usages.
getLicenseLimits → 200401403
Encryption Schemes 1
GET
/api/v7/encryptionschemes
Return a list of encryption schemes in the environment.
getEncryptionSchemes → 200
Environment Variables 5
GET
/api/v7/environmentvariables
Return a list of environment variables.
getEnvironmentVariables 6 params → 200400401403
POST
/api/v7/environmentvariables
Creates an Environment Variable.
createEnvironmentVariable body → 201400401403
GET
/api/v7/environmentvariables/{environmentVariableId}/references
Return references to a specified environment variable.
getEnvironmentVariableReferences 7 params → 200400401403404
DELETE
/api/v7/environmentvariables/{environmentVariableId}
Delete environment variable by ID.
deleteEnvironmentVariable 1 param → 204401403404
PATCH
/api/v7/environmentvariables/{environmentVariableId}
Updates the Environment Variable by ID.
updateEnvironmentVariable 1 param body → 204400401403404
Health 1
GET
/api/v7/health
Return health of API.
→ 200503
Processes 2
GET
/api/v7/processes
Return a list of all the processes in the environment.
GetProcesses 8 params → 200400401403
GET
/api/v7/processgroups/root/descendants
Return a list of all the processes / process groups in the process group tree.
getAllProcessGroupItems 6 params → 200400401403
Resources 2
GET
/api/v7/resources
Return a list of resources in the environment.
getResources 12 params → 200400401403
PUT
/api/v7/resources/{resourceId}
Retire or unretire a resource with the given ID.
updateResource 1 param body → 204400401403404409
Pools 1
GET
/api/v7/resources/pools
Return a list of resource pools.
getResourcePools → 200401403
Schedules 23
GET
/api/v7/schedules
Return a list of schedules in the environment.
getSchedules 4 params → 200400401403
POST
/api/v7/schedules
Create a new schedule definition.
createSchedule 1 param body → 201400401403
GET
/api/v7/schedules/{scheduleId}
Return requested schedule summary.
getSchedule 1 param → 200400401403404
PUT
/api/v7/schedules/{scheduleId}
Update a given schedule.
updateSchedule 1 param body → 200400401403404
DELETE
/api/v7/schedules/{scheduleId}
Delete a specified schedule.
deleteSchedule 1 param → 204400401403404
POST
/api/v7/schedules/{scheduleId}/clones
Clone a new schedule definition.
CloneSchedule 1 param body → 200400401403404
POST
/api/v7/schedules/{scheduleId}/sessionsdeprecated
Create a session and set a schedule to run at a specific date and time.
startSchedule 1 param body → 202400401403404
DELETE
/api/v7/schedules/{scheduleId}/sessionsdeprecated
Request the schedule to stop.
stopSchedule 1 param → 202400401403404
DELETE
/api/v7/schedules/{scheduleId}/runs/active
Request the schedule to stop.
stopSchedule 1 param → 202400401403404
GET
/api/v7/schedules/{scheduleId}/tasks
Return a list of tasks in a schedule.
getScheduleTasks 1 param → 200400401403404
POST
/api/v7/schedules/{scheduleId}/tasks
Create a task in a schedule.
createScheduleTask 1 param body → 201400401403404409
GET
/api/v7/schedules/{scheduleId}/tasks/{taskId}
Return a given scheduled task.
getScheduleTask 2 params → 200400401403404
DELETE
/api/v7/schedules/{scheduleId}/tasks/{taskId}
Delete a given scheduled task.
deleteScheduleTask 2 params → 204400401403404
PUT
/api/v7/schedules/{scheduleId}/tasks/{taskId}
Update a given scheduled task.
updateScheduleTask 2 params body → 204400401403404
DELETE
/api/v7/schedules/{scheduleId}/tasks/{taskId}/sessions/{sessionId}
Delete scheduled task session.
deleteScheduledTaskSession 3 params → 204400401403404
GET
/api/v7/schedules/{scheduleId}/tasks/{taskId}/sessions
Return a list of the scheduled sessions for a specified task.
getScheduledSessionForTask 2 params → 200400401403404
POST
/api/v7/schedules/{scheduleId}/tasks/{taskId}/sessions
Create a scheduled session in task.
createScheduleSessionForTask 2 params body → 201400401403404
GET
/api/v7/schedules/tasks/{taskId}/sessionsdeprecated
Return a list of the scheduled sessions for a specified task.
getSchduledSessionsForTask 1 param → 200400401403404
PUT
/api/v7/schedules/{scheduleId}/tasks/{taskId}/scheduledSessionParameters
Update start-up parameters.
updateStartupParameters 2 params body → 204400401403404
GET
/api/v7/schedules/{scheduleId}/tasks/{taskId}/scheduledSessionParameters
Return start-up parameters.
getStartupParameters 2 params → 200401403404
GET
/api/v7/schedules/{scheduleId}/logsdeprecated
Return all logs for a specified schedule
getLogsForSchedule 9 params → 200400401403404
GET
/api/v7/schedules/logsdeprecated
Return all schedule logs.
getAllScheduleLogs 8 params → 200400401403
POST
/api/v7/schedules/{scheduleId}/runs
Create a session and set a schedule to run at a specific date and time.
createSessionRun 1 param body → 202400401403404
ScheduleLogs 2
GET
/api/v7/scheduleLogs
Return all schedule logs.
getScheduleLogs 9 params → 200400401403
GET
/api/v7/scheduleLogs/{scheduleId}
Return all logs for a specified schedule.
getScheduleLogsById 9 params → 200400401403404
Sessions 10
GET
/api/v7/sessions
Return a list of sessions in the environment.
GetSessions 15 params → 200400401403
POST
/api/v7/sessions
Create a new session for the given resource ID and process ID.
createSession body → 200400401403404
GET
/api/v7/sessions/{sessionId}
Return details of a specified session.
getSession 1 param → 200400401403404
DELETE
/api/v7/sessions/{sessionId}
Deletes a specified pending session.
deleteSession 1 param → 204400401403404
PATCH
/api/v7/sessions/{sessionId}
Update the session for the given session ID.
updateSession 1 param body → 202400401403404409
GET
/api/v7/sessions/{sessionId}/parameters
Get start-up parameters for a specified session.
getSessionStartUpParameters 1 param → 200400401403404
PUT
/api/v7/sessions/{sessionId}/parameters
Update start-up parameters for a specified session.
updateSessionStartupParameters 1 param body → 204400401403404409
GET
/api/v7/sessions/{sessionId}/logs
Return all logs for a specified session.
getSessionLogs 19 params → 200400401403404
GET
/api/v7/sessions/{sessionId}/logslight
Return fewer logs fields (logid,startdatetime,starttimezoneoffset,stagetype,objectname,actionname,processname,pagename,stagename,result,resulttype,attributexml and logNumber) for a specified session…
getSessionLogsLight 19 params → 200400401403404
GET
/api/v7/sessions/{sessionId}/logs/{logId}/parameters
Return all parameters for a specified session log.
getSessionLogParameters 2 params → 200400401403404
Subscriptions 1
PATCH
/api/v7/subscriptions/{subscriptionId}
Update the subscription for the given subscription ID.
updatesubscription 1 param body → 202400401403404
Time Zones 1
GET
/api/v7/timezones
Return a list of time zones.
getTimezones → 200401
User 1
GET
/api/v7/user/permissions
Return a list of permissions for the currently authenticated user.
getPermissionsForUser → 200401
Work Queues 18
GET
/api/v7/workqueues
Return a list of work queues in the environment.
getWorkqueues 14 params → 200400401403
POST
/api/v7/workqueues
Create a new work queue.
createWorkQueue body → 201400401403409
GET
/api/v7/workqueues/light
Return fewer information about work queue(all fields except work queue configuration and sessionexceptionretry).
getWorkqueuesLight 14 params → 200400401403
GET
/api/v7/workqueues/configurations
Return configuration(id, name, assignedProcessId, assignedResourceGroupId and activeQueueStats) for each active work queue.
getWorkQueueConfiguration 4 params → 200400401403
GET
/api/v7/workqueues/{workQueueId}
Return details of a work queue.
getWorkQueue 1 param → 200400401403404
PATCH
/api/v7/workqueues/{workQueueId}
Modify the work queue as described in the patch document.
updateWorkQueue 1 param body → 204400401403404
DELETE
/api/v7/workqueues/{workQueueId}
Delete a specified work queue.
deleteWorkQueue 1 param → 204400401403404409
GET
/api/v7/workqueues/{workQueueId}/references
Return references to a specified work queue.
getWorkQueueReferences 7 params → 200400401403404
GET
/api/v7/workqueues/{workQueueId}/items
Return items in a specified work queue.
getWorkQueueItems 22 params → 200400401403404
POST
/api/v7/workqueues/{workQueueId}/itemsdeprecated
Create work queue item(s).
createWorkQueueItem 1 param body → 201400401403404
POST
/api/v7/workqueues/{workQueueId}/items/batch
Create work queue items.
createWorkQueueItems 1 param body → 201400401403404
GET
/api/v7/workqueues/items/{workQueueItemId}deprecated
Return details of a specified item from a work queue.
getWorkQueueItem 1 param → 200400404
GET
/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}
Return details of a specified item from a work queue.
getWorkQueueItemFromWorkQueue 2 params → 200400404
GET
/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/attempts
Returns all attempts for the given work queue item
getWorkQueueItemAttempts 2 params → 200400401403404
POST
/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/attempts
Creates a new work queue item attempt by forcing an item to retry.
createWorkQueueItemAttempt 2 params → 201400401403404
DELETE
/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/attempts/{attemptId}
Deletes a worked queue item.
deleteWorkQueueItemAttempt 3 params → 204400401403404
PATCH
/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/attempts/{attemptId}
Modify the work queue item as described in the patch document.
updateWorkQueueItemAttempt 3 params body → 204400401403404
POST
/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/callbacks
Creates a new work queue web hook item .
CreateWebHookWorkQueueItem 2 params body → 201400401403404
Work Queue Groups 6
GET
/api/v7/workqueuegroups/{identifier}
Return details of a work queue group.
getWorkQueueGroup 1 param → 200400401403404
PATCH
/api/v7/workqueuegroups/{identifier}
Modify the work queue group as described in the patch document.
updateWorkQueueGroup 1 param body → 204400401403404
POST
/api/v7/workqueuegroups
Creates a work queue group.
createWorkQueueGroup body → 201400401403
DELETE
/api/v7/workqueuegroups/{workQueueGroupId}
Deletes a work queue group.
deleteWorkQueueGroup 1 param → 204400401403404
GET
/api/v7/workqueuegroups/{identifier}/items
Return a list of work queues belonging to a work queue group.
getWorkQueuesInGroup 5 params → 200400401403404
GET
/api/v7/workqueuegroups/{identifier}/childgroups
Return details of child groups of work queue group.
getChildGroupsInWorkQueueGroup 7 params → 200400401403404
Licenses 3
GET
/api/v7/licenses
Return a list of licenses.
getLicenses 15 params → 200401403
POST
/api/v7/licenses
Add a license.
createLicense body → 201400401403
DELETE
/api/v7/licenses/{licenseId}
Delete a specified license.
deleteLicense 1 param → 204400401403404

Schemas 136

The contract defines 136 schemas that model the data the API accepts and returns. The most detailed are WorkQueueItem (24 properties), WorkQueueItemNoData (23 properties), WorkQueueSummary (20 properties), SessionSummary (19 properties). Each schema is shown below with its type and property counts.

DataCollection
object
Represents a Blue Prism collection.
1 property
RadioButtonsArray
array
Used for the RadioButtons data type.
DataRow
object
A dictionary which represents a row of data from a Blue Prism collection.
DataRowSchedule
object
A dictionary which represents a row of data from a Blue Prism collection.
DataValue
object
Represents a single item of data in a Blue Prism format.
3 properties
DataValueSchedule
object
Represents a single item of data in a Blue Prism format.
2 properties
CreateScheduleDefinitionResponseModel
object
Contains the ID of a schedule.
1 property
ScheduleDefinitionResponseModel
object
Contains the details of a Schedule.
18 properties
UpdateScheduleDetails
Contains the details of a schedule.
CloneScheduleDetails
Contains the details of a schedule.
ScheduleDetailsOptionalName
Contains the details of a schedule.
ScheduleDetails
object
Contains the details of a schedule.
13 properties
MonthlyDetails
object
Monthly details that apply to the monthly interval schedule type.
7 properties
WeeklyDetails
object
Weekly details that apply to the weekly interval schedule type.
4 properties
YearlyDetails
object
Yearly details that apply to the yearly interval schedule type.
1 property
DailyDetails
object
Daily details that apply to the daily interval schedule type.
2 properties
HourlyMinutelyDetails
object
Hourly and minute details that apply to the hourly and minute interval schedule type.
4 properties
ScheduleSummary
object
Contains basic details of a session.
16 properties
ScheduleItemsPage
object
Contains details of a page of schedules.
2 properties
ScheduleLogItemsPage
object
Contains details of a page of schedule logs.
2 properties
ScheduleLogSummary
object
Contains basic details about a schedule log.
8 properties
ScheduleLogDeprecatedItemsPage
object
Contains details of a page of schedule logs.
2 properties
ScheduleLogDeprecatedSummary
object
Contains basic details about a schedule log.
7 properties
CreateSession
object
Contains details for creating a new session.
2 properties
UpdateSession
object
Contains details for updating a session.
1 property
SessionDetails
object
Contains details of a session.
4 properties
SessionLogsPage
object
Contains details of a page of session logs.
2 properties
SessionLogParametersResponse
object
Contains input and output parameters of a session log.
2 properties
SessionLogSummary
object
Contains basic details of a session log.
17 properties
SessionSummary
object
Contains basic details of a session,
19 properties
SessionItemsPage
object
Contains details of a page of sessions.
2 properties
SessionStartUpParameters
object
Contains start-up parameters of a session.
1 property
CreateSessionParameters
object
Contain a parameter used to create a new session
2 properties
StageType
string
The stage type of a session
ResultType
string
The result type of a session
SessionStatus
string
The status of a session
SessionSource
string
The source of a session
TimeZones
array
A collection of time zones.
TimeZone
object
Contains details of a time zone.
4 properties
WorkQueueGroup
object
Contains basic details of a work queue group.
5 properties
WorkQueuesFromGroupItemsPage
object
Contains details of a page of work queues from the work queue group.
2 properties
WorkQueueInGroup
object
Contains details of the work queue from the work queue group.
2 properties
CreateWorkQueueGroup
object
Contains details for creating a new work queue group.
2 properties
CreateWorkQueueGroupResponseModel
object
Contains the ID of a new work queue group.
1 property
WorkQueueChildGroups
object
Contains basic details of a work queue group.
2 properties
WorkQueueSummary
object
Contains basic details of a work queue.
20 properties
ActiveWorkQueueConfiguration
object
Contains details of an active work queue.
2 properties
ActiveWorkQueueStatistics
object
Contains statistics for an active work queue.
5 properties
WorkQueueConfigurationSummary
object
Contains details of a work queue configuration.
4 properties
WorkQueueConfigurationsPage
object
Contains details of a page of work queues configrations.
2 properties
WorkQueuesItemsPage
object
Contains details of a page of work queues.
2 properties
ReferencesItemsPage
object
Contains references of a specified object.
2 properties
CreateWorkQueue
object
Contains details for creating a new work queue.
9 properties
UpdateWorkQueue
object
Contains details for updating a work queue's information.
5 properties
WorkQueueItemsPage
object
Contains details of a page of work queue items.
2 properties
WorkQueueItemNoData
object
Contains details of a work queue item but does not return the data contained in it.
23 properties
WorkQueueItem
object
Contains details of a work queue item including the data.
24 properties
CreateWorkQueueItems
array
Contains details for creating a number of work queue items.
CreateWorkQueueItem
object
Contains details for creating a work queue item in a queue.
8 properties
QueueStatus
string
The current status of the queue.
CreateWorkQueueItemAttemptResponseModel
object
Contains the ID of a new work queue item attempt.
1 property
CreateWebhookWorkQueueItem
object
Contains details for creating a webhook subscriptions for a work queue item in a queue.
3 properties 2 required
WorkQueueItemWebhookSubscriptionResponse
object
Response containing webhook subscription details.
3 properties 3 required
WorkQueueItemSubscriptionCustomResponse
object
Response containing custom subscription details.
1 property 2 required
WorkQueueItemEventSubscriptionResponse
object
The subscription created for an event type.
2 properties
EncryptionScheme
object
Contains details of an encryption scheme.
4 properties
EnvironmentVariable
object
Contains details of an environment variable.
5 properties
EnvironmentVariableItemsPage
object
Contains details of a page of environment variables.
2 properties
EnvironmentVariableReferencesItemsPage
object
Contains details of a page of environment variables references.
2 properties
Health
object
Contains details of API health and its dependencies.
2 properties
Dependency
object
Contains details of API dependency health
2 properties
License
object
Contains details of the license.
13 properties
LicensesItemsPage
object
Contains basic details of a licenses.
2 properties
AddLicense
object
Contains details for adding a new license key.
1 property
AddLicenseResponseModel
object
Contains the information of an added license.
4 properties
ScheduleSessionStart
object
A request to start a schedule at startTime.
1 property
ScheduleSessionStartResponse
object
A response to a start request containing the date-time when the schedule is expected to run.
1 property
ScheduledTask
object
Contains details of a scheduled task.
10 properties
CreateScheduledTask
object
Contains details of a scheduled task.
6 properties
ScheduledSessionParameters
object
Contains parameters of a scheduled session.
2 properties
CreateScheduledSessionResponse
object
Contains ID of created scheduled session.
1 property
CreateScheduledTaskResponse
object
Contains ID of created task.
1 property
UpdateSchedule
object
Contains details for updating a schedule.
1 property
ScheduledSessionArguments
array
Contains details of start-up parameters.
ScheduledSessionArgumentsModel
object
Contains details of start-up parameters.
2 properties
ScheduledSession
array
Contains details of a schedule session.
Process
object
Contains details of a published process.
6 properties
ProcessAttribute
string
The attributes of the process.
ProcessAttributeFilter
string
The attributes of the process to filter by.
ProcessItemsPage
object
Contains details of a page of processes.
2 properties
ProcessGroupItemItemsPage
object
Contains details of a page of nodes in the process group tree.
2 properties
ProcessGroupItem
object
Contains details of a process group tree node.
4 properties
Resource
object
Contains details of a runtime resource.
13 properties
ResourceAttribute
string
The attributes of the resource.
UpdateResource
object
Contains details to update a runtime resource's attributes.
1 property
ResourceItemsPage
object
Contains details of a page of runtime resources.
2 properties
CreateEnvironmentVariableModel
object
Contains details for creating a new environment variable.
4 properties
RadioButtons
array
Contains details for creating a new collection of radio buttons.
RadioButton
object
Contains details for creating a new radio button.
2 properties
FullStringFilter
object
Used to filter strings. Check for strings that start with, contain, equal, are greater than, are less than, or are between the given value(s).
BasicStringFilter
object
Used to filter strings. Check for strings that start with, equal, are greater than, are less than, or are between the given value(s).
BasicNumericFilter
object
Used to filter numbers. Check for numbers that start with, equal, are greater than, are less than, or are between the given values(s).
RangeOrEqualFilter
object
Used to filter values. Check for values that are equal to, greater than or equal to, less than or equal to, or between the given value(s).
RangeFilter
object
Used to filter values. Check for values that are greater than or equal to, less than or equal to, or between the given value(s).
StringFilter
object
Used to filter strings. Check for strings that start with, and/or contain the given value(s).
ContainsStringFilter
object
Used to filter strings. Check for strings that contain the given value.
1 property
StartsWithStringFilter
object
Used to filter strings. Check for strings that start with the given value.
1 property
GreaterThanOrEqualToFilter
object
Used to filter values. Check for values that are greater than or equal to the given value.
1 property
LessThanOrEqualToFilter
object
Used to filter values. Check for values that are less than or equal to the given value.
1 property
EqualsFilter
object
Used to filter values. Check for values that are equal to the given value.
1 property
PatchRequest
array
A request containing a JSON Patch document. See PatchDocument for details.
PatchDocument
object
A JSONPatch document as defined by RFC 6902. See http://jsonpatch.com/
4 properties 2 required
Error
object
A general error occurred. See errorMessage for details.
1 property
ErrorMessage
string
A message describing the problem encountered.
ValidationError
object
An error occurred during validation. See the response body for details on the invalid field.
2 properties
UrlParameterError
object
An error occurred due to incorrect data supplied to url parameter.
2 properties
Identifier
object
A GUID resource ID.
1 property
Identifiers
object
A collection of GUID resource IDs.
1 property
PagingToken
string
The token to be used in the next request to return the next collection of items.
Reference
object
Contains details of referenced item.
4 properties
ProcessType
string
The process type of environment variable reference.
Calendar
object
A model of calendar.
4 properties
Region
object
A model of region.
2 properties
HolidayRegion
object
A model of holiday region.
2 properties
HolidayByRegionId
object
A model of holiday by region id.
3 properties
CreateCalendarModel
object
Contains details for creating a new calendar.
3 properties
CloneCalendarModel
object
Contains details for cloning a calendar with a new name.
1 property
OtherHolydaysModel
object
Contains details for other holidays.
1 property
CreateCalendarResponseModel
object
Contains the ID of a calendar.
1 property
ResourcePool
object
A model of resource pool.
4 properties
ResourceUtilization
object
A model of resource utilization per hour.
4 properties
ResourcesSummaryUtilization
object
A model of average resource utilization per day.
2 properties
WorkQueueComposition
object
A summary of work queue items.
7 properties
LicensesEntitlement
object
A summary of an aggregated licenses entitlement data.
3 properties
BaseEntitlement
object
An aggregated licenses entitlement data.
4 properties
LicenseUsageDetailsModel
object
A summary of active licenses limits and usages
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

blue-prism-enterprise-api-openapi.yml Raw ↑

Other APIs Blue Prism publishes across the network.

Process Intelligence API
AE Profile APIs.io
#AI Automation#RPA#Intelligent Automation#Workflow-Automation
← Back to B APIs
API Details
ID
blue-prism:blue-prism
Base URL
https://{address}/api/v7
Docs
https://documentation.blueprism.com/bp-7-5/en-us/bp-api/api-spec-home.htm
Provider
Blue Prism
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=blue-prism&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/blue-prism"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Blue Prism API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.