Blue Prism API user permissions

The following tables list the Blue Prism user permissions required to successfully pass requests to different Blue Prism API endpoints. The Control Room plugin within Hub leverages the API, and therefore has the same permission set. The tables provides an overview of the available endpoints, requests, and required permissions with full details available in the Blue Prism reference. To access the API reference, see Blue Prism API.

For information on how to set user permissions, see Blue Prism user roles.

Permissions

Requests are grouped by the following categories:

Calendars

Request

Endpoint

Required user permission

Response

GET

/api/v7/calendars

Requires the following System Manager permissions:

  • System – Calendars

Returns a list of calendars.

POST

/api/v7/calendars

Requires the following System Manager permissions:

  • System – Calendars

Creates a calendar.

GET

/api/v7/calendars/{calendarId}

Requires the following System Manager permissions:

  • System – Calendars

Returns the specified calendar.

DELETE

/api/v7/calendars/{calendarId}

Requires the following System Manager permissions:

  • System – Calendars

Deletes the specified calendar.

PATCH

/api/v7/calendars/{calendarId}

Requires the following System Manager permissions:

  • System – Calendars

Updates the specified calendar.

POST

/api/v7/calendars/{calendarId}/clones

Requires the following System Manager permissions:

  • System – Calendars

Creates a clone of the specified calendar.

GET

/api/calendars/{calendarId}/otherHolidays

Requires the following System Manager permissions:

  • System – Calendars

Returns other holidays for the specified calendar.

POST

/api/calendars/{calendarId}/otherHolidays/batch

Requires the following System Manager permissions:

  • System – Calendars

Creates other holidays for the specified calendar.

DELETE

/api/calendars/{calendarId}/otherHolidays/batch

Requires the following System Manager permissions:

  • System – Calendars

Deletes any configured other holidays for the specified calendar.

GET

/api/v7/calendars/{calendarId}/references

Requires the following System Manager permissions:

  • System – Calendars

Returns all processes and objects that use the specified calendar.

GET

/api/v7/holidayRegions

Requires the following System Manager permissions:

  • System – Calendars

Returns a list of holiday regions.

GET

/api/v7/holidayRegions/{holidayRegionId}/publicHolidays

Requires the following System Manager permissions:

  • System – Calendars

Returns a list of public holidays for the specified region.

Dashboards

Request

Endpoint

Required user permission

Response

GET

/api/v7/dashboards
/workQueueCompositions

This endpoint is not restricted by user permissions.

Returns a list of work queue composition details.

GET

/api/v7/dashboards
/resourceUtilization

This endpoint is not restricted by user permissions.

Returns a list of utilization details.

GET

/api/v7/dashboards/
resourcesSummaryUtilization

This endpoint is not restricted by user permissions.

Returns a list of resource utilization details for the specified date range.

GET

/api/v7/dashboards/
currentLimitsAndUsage

Requires the following Resource permissions:

  • Configure Resource

  • Control Resource

  • View Resource

  • View Resource Screen Capture

And at least one of the following Process Alerts permissions:

  • Configure Process Alerts

  • Subscribe To Process Alerts

Or the following System Manager permission:

  • Audit – Alerts

Return current active licenses, and associated limits and usages.

GET

/api/v7/dashboards/
licensesEntitlement

Requires the following System Manager permissions:

  • System – License

Returns current active licenses and their entitlements.

Encryption schemes

Request

Endpoint

Required user permission

Response

GET

/api/v7/encryptionschemes

Requires the following System Manager permission:

  • Security – View Encryption Scheme Configuration

Returns a list of encryption schemes.

Environment variables

Request

Endpoint

Required user permission

Response

GET

/api/v7/environmentvariables

Requires the following System Manager permissions:

  • Business Objects – View Environment Variables

Returns a list of environment variables.

POST

/api/v7/environmentvariables

Requires at least one of the following System Manager permissions:

  • Business Objects – Configure Environment Variables
  • Business Objects – View Environment Variables

Creates an environment variable.

PATCH

/api/v7/environmentvariables/{environmentVariableId}

Requires at least one of the following System Manager permissions:

  • Business Objects – Configure Environment Variables
  • Processes – Configure Environment Variables

Updates the specified environment variable.

DELETE

/api/v7/environmentvariables/{environmentVariableId}

Requires at least one of the following System Manager permissions:

  • Business Objects – Configure Environment Variables
  • Processes – Configure Environment Variables

Deletes the specified environment variable.

GET

/api/v7/environmentvariables/{environmentVariableId}/references

Requires at least one of the following System Manager permissions:

  • Business Objects – Configure Environment Variables
  • Business Objects – View Environment Variable

Returns all processes and objects that use the specified environment variable.

Health

Request

Endpoint

Required user permission

Response

GET

/api/v7/health

This endpoint is not restricted by user permissions.

Returns the health of the API dependencies, for example, the database.

Licenses

Request

Endpoint

Required user permission

Response

GET

/api/v7/licenses

Requires the following System Manager permissions:

  • System – License

Returns a list of licenses.

POST

/api/v7/licenses

Requires the following System Manager permissions:

  • System – License

Creates a new license.

DELETE

/api/v7/licenses/{licenseId}

Requires the following System Manager permissions:

  • System – License

Deletes the specified license.

Processes

Request

Endpoint

Required user permission

Response

GET

/api/v7/processes

Requires at least one of the following Process Studio permissions:

  • Create Process
  • Delete Process
  • Edit Process
  • Execute Process
  • Execute Process as Web Service
  • Edit Process Groups
  • Export Process
  • Manage Process Access Rights
  • View Process Definition

Returns a list of processes.

Resources

Request

Endpoint

Required user permission

Response

GET

/api/v7/resources

Requires at least one of the following Resource permissions:

  • View Resource
  • View Resource Screen Captures
  • Configure Resource
  • Control Resource
  • Manage Resource Access Rights
  • View Resource Details

Returns a list of resources in the environment.

PUT

/api/v7/resources/{resourceId}

Requires the following Resource permission:

  • Configure Resource

Returns the specified resource.

GET

/api/v7/resources/pools

Requires at least one of the following Resource permissions:

  • View Resource
  • View Resource Screen Captures
  • Configure Resource
  • Control Resource
  • Manage Resource Access Rights
  • View Resource Details

Return a list of resource pools.

Schedule logs

Request

Endpoint

Required user permission

Response

GET

/api/v7/scheduleLogs

Requires at least one of the following Scheduler permissions:

  • View Schedule
  • Edit Schedule
  • Delete Schedule
  • Create Schedule
  • Retire Schedule
  • System – Scheduler

Returns all schedule logs.

GET

/api/v7/scheduleLogs/{scheduleId}

Requires at least one of the following Scheduler permissions:

  • View Schedule
  • Edit Schedule
  • Delete Schedule
  • Create Schedule
  • Retire Schedule
  • System – Scheduler

Returns all logs for the specified schedule.

Schedules

Request

Endpoint

Required user permission

Response

GET

/api/v7/schedules

Requires at least one of the following Scheduler permissions:

  • View Schedule
  • Edit Schedule
  • Delete Schedule
  • Create Schedule
  • Retire Schedule
  • System – Scheduler

Returns a list of schedules in the environment.

POST

/api/v7/schedules

Requires the following Scheduler permissions:

  • Create Schedule
  • Edit Schedule

Creates a new schedule definition.

GET

/api/v7/schedules/logs

Requires at least one of the following Scheduler permissions:

  • View Schedule
  • Edit Schedule
  • Delete Schedule
  • Create Schedule
  • Retire Schedule
  • System – Scheduler

Returns all schedule logs.

This endpoint will be deprecated in a future release, and is replaced by the /api/v7/scheduleLogs endpoint.

GET

/api/v7/schedules/{scheduleId}

Requires at least one of the following Scheduler permissions:

  • View Schedule
  • Edit Schedule
  • Delete Schedule
  • Create Schedule
  • Retire Schedule
  • System – Scheduler

Returns the requested schedule summary.

PUT

/api/v7/schedules/{scheduleId}

Requires all of the following Scheduler permissions to retire a schedule:

  • Edit Schedule
  • Retire Schedule

Requires all of the following Scheduler permissions to unretire a schedule:

  • Edit Schedule
  • Retire Schedule
  • Create Schedule

Updates the specified schedule.

DELETE

/api/v7/schedules/{scheduleId}

Requires the following Scheduler permissions:

  • Edit Schedule
  • Delete Schedule

Deletes the specified schedule.

POST

/api/v7/schedules/{scheduleId}/clones

Requires the following Scheduler permissions:

  • Create Schedule
  • Edit Schedule

Creates a clone of the specified schedule.

GET

/api/v7/schedules/
{scheduleId}/logs

Requires at least one of the following Scheduler permissions:

  • View Schedule
  • Edit Schedule
  • Delete Schedule
  • Create Schedule
  • Retire Schedule
  • System – Scheduler

Returns all logs for the specified schedule.

This endpoint will be deprecated in a future release, and is replaced by the api/v7/scheduleLogs/{scheduleId} endpoint.

GET

/api/v7/schedules
/{scheduleId}/tasks

Requires at least one of the following Scheduler permissions:

  • View Schedule
  • Edit Schedule
  • Delete Schedule
  • Create Schedule
  • Retire Schedule
  • System – Scheduler

Returns a list of tasks in the specified schedule.

POST

/api/v7/schedules
/{scheduleId}/tasks

Requires at least one of the following Scheduler permissions:

  • Create Schedule
  • Edit Schedule

Creates a task for the specified schedule.

GET

/api/v7/schedules
/{scheduleId}/tasks/{taskId}

Requires at least one of the following Scheduler permissions:

  • View Schedule
  • Edit Schedule
  • Delete Schedule
  • Create Schedule
  • Retire Schedule
  • System – Scheduler

Returns a specified scheduled task.

PUT

/api/v7/schedules
/{scheduleId}/tasks/{taskId}

Requires the following Scheduler permissions:

  • Edit Schedule

Updates a specified scheduled task.

DELETE

/api/v7/schedules
/{scheduleId}/tasks/{taskId}

Requires the following Scheduler permissions:

  • Edit Schedule
  • Delete Schedule

Deletes a specified task in specified schedule.

GET

/api/v7/schedules/tasks/
{taskId}/sessions

Requires at least one of the following Scheduler permissions:

  • View Schedule
  • Edit Schedule
  • Delete Schedule
  • Create Schedule
  • Retire Schedule
  • System – Scheduler

Returns a list of the scheduled sessions for a specified task.

This endpoint will be deprecated in a future release, and is replaced by the /api/v7/schedules/{scheduleId}/tasks/{taskId}/sessions endpoint.

GET

/api/v7/schedules/{scheduleId}
/tasks/{taskId}/sessions

Requires at least one of the following Scheduler permissions:

  • View Schedule
  • Edit Schedule
  • Delete Schedule
  • Create Schedule
  • Retire Schedule
  • System – Scheduler

Returns a list of the scheduled sessions for a specified task.

POST

/api/v7/schedules/{scheduleId}
/tasks/{taskId}/sessions

Requires at least one of the following Process Studio permissions:

  • 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 the following Resource permissions:

  • View Resource
  • View Resource Screen Captures
  • Configure Resource
  • Control Resource
  • Manage Resource Access Rights
  • View Resource Details

And the following Scheduler permission:

  • Edit Schedule

Creates a scheduled session for the specified task.

GET

/api/v7/schedules
/{scheduleId}/tasks/{taskId}
/scheduledSessionParameters

Requires at least one of the following Scheduler permissions:

  • View Schedule
  • Edit Schedule
  • Delete Schedule
  • Create Schedule
  • Retire Schedule
  • System – Scheduler

Returns start-up parameters.

PUT

/api/v7/schedules
/{scheduleId}/tasks/{taskId}
/scheduledSessionParameters

Requires the following Scheduler permissions:

  • Edit Schedule

Updates start-up parameters.

DELETE

/api/v7/schedules
/{scheduleId}/tasks/{taskId}
/sessions/{sessionId}

Requires the following Scheduler permissions:

  • Edit Schedule

Deletes the specified scheduled task session.

Schedule sessions

Request

Endpoint

Required user permission

Response

POST

/api/v7/schedules/{scheduleId}
/sessions

Requires the following Scheduler permission:

  • Edit Schedule

Sets a schedule to run at a specific date and time.

This endpoint will be deprecated in a future release, and is replaced by the api/v7/schedules/{scheduleId}​/runs endpoint.

DELETE

/api/v7/schedules/{scheduleId}
/sessions

Requires the following Scheduler permission:

  • Edit Schedule

Requests the specified schedule to stop.

This endpoint will be deprecated in a future release, and is replaced by the /api/v7/schedules/{scheduleId}​/runs/active endpoint.

POST

/api​/v7​/schedules​/{scheduleId}​/runs

Requires the following Scheduler permission:

  • Edit Schedule

Creates a session for the schedule to be run at a specified date and time.

DELETE

/api/v7/schedules/{scheduleId}​/runs/active

Requires the following Scheduler permission:

  • Edit Schedule

Requests the specified schedule to stop.

Session logs

Request

Endpoint

Required user permission

Response

GET

/api/v7/sessions
/{sessionId}/logs

Requires at least one of the following Process Studio permissions:

  • 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 the following Resource permissions:

  • View Resource
  • View Resource Screen Captures
  • Configure Resource
  • Control Resource
  • Manage Resource Access Rights
  • View Resource Details

And the following System Manager permission:

  • Audit – Process Logs

Sets a schedule to run at a specific date and time.

GET

/api/v7/sessions/
{sessionId}/logs/
{logId}/parameters

Requires at least one of the following Process Studio permissions:

  • 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 the following Resource permissions:

  • View Resource
  • View Resource Screen Captures
  • Configure Resource
  • Control Resource
  • Manage Resource Access Rights
  • View Resource Details

And the following System Manager permission:

  • Audit – Process Logs

Returns all parameters for the specified session log.

Sessions

Request

Endpoint

Required user permission

Response

GET

/api/v7/sessions

Requires at least one of the following Resources permissions:

  • View Resource
  • View Resource Screen Captures
  • Configure Resource
  • Control Resource
  • Manage Resource Access Rights

And at least one of the following Process Studio permissions:

  • 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

Returns a list of sessions in the environment.

POST

/api/v7/sessions

Requires the following Resource permission:

  • Control Resource

And at least one of the following Process Studio permissions:

  • Create Process
  • Edit Process
  • Execute Process

Creates new session(s) for the specified resource ID and process IDs.

GET

/api/v7/sessions/{sessionId}

Requires at least one of the following Resources permissions:

  • View Resource
  • View Resource Screen Captures
  • Configure Resource
  • Control Resource
  • Manage Resource Access Rights

And at least one of the following Process Studio permissions:

  • 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

Returns details of the specified session.

PATCH

/api/v7/sessions/{sessionId}

Requires the following Resource permission:

  • Control Resource

And at least one of the following Process Studio permissions:

  • Create Process
  • Edit Process
  • Execute Process

Updates the specified session.

DELETE

/api/v7/sessions/{sessionId}

Requires the following Resource permission:

  • Control Resource

And at least one of the following Process Studio permissions:

  • Create Process
  • Edit Process

  • View Process Definition

Deletes a specified pending session.

GET

/api/v7/sessions
/{sessionId}/parameters

Requires at least one of the following Resources permissions:

  • View Resource
  • View Resource Screen Captures
  • Configure Resource
  • Control Resource
  • Manage Resource Access Rights

And at least one of the following Process Studio permissions:

  • Create Process
  • Edit Process
  • Export Process
  • Execute Process
  • View Process Definition

Returns start-up parameters for the specified session.

PUT

/api/v7/sessions
/{sessionId}/parameters

Requires the following Resource permission:

  • Control Resource

And at least one of the following Process Studio permissions:

  • Create Process
  • Edit Process
  • Execute Process

Updates start-up parameters for the specified session.

Time zones

Request

Endpoint

Required user permission

Response

GET

/api/v7/timezones

This endpoint is not restricted by user permissions.

Returns a list of time zones.

Users

Request

Endpoint

Required user permission

Response

GET

/api/v7/user/permissions

This endpoint is not restricted by user permissions.

Returns the permissions enabled for the currently authenticated user.

Work queues

Request

Endpoint

Required user permission

Response

GET

/api/v7/workqueues

Requires at least one of the following Control Room permissions:

  • Read Access to Queue Management
  • Full Access to Queue Management

Returns a list of work queues in the environment.

POST

/api/v7/workqueues

Requires the following System Manager permission:

  • Workflow – Work Queue Configuration

Creates a new work queue.

GET

/api/v7/workqueues/
{workQueueId}

Requires at least one of the following Control Room permissions:

  • Read Access to Queue Management
  • Full Access to Queue Management

Returns details of the specified work queue.

DELETE

/api/v7/workqueues/
{workQueueId}

Requires the following System Manager permission:

  • Workflow – Work Queue Configuration

Deletes the specified work queue.

PATCH

/api/v7/workqueues/
{workQueueId}

Requires at least one of the following Control Room permissions:

  • Read Access to Queue Management
  • Full Access to Queue Management

And the following System Manager permission:

  • Workflow – Work Queue Configuration

Modifies the specified work queue as described in the patch document.

GET

/api/v7/workqueues/
{workQueueId}/references

Requires the following System Manager permission:

  • Workflow – Work Queue Configuration

Returns all processes and objects that use the specified work queue.

GET

/api/v7/workqueues/
{workQueueId}/items

Requires at least one of the following Control Room permissions:

  • Read Access to Queue Management
  • Full Access to Queue Management

If accessing active queue items, at least one of the following Process Studio permissions is also required:

  • Create Process
  • Edit Process
  • Execute Process

And the following Resource permission:

  • Control Resource

Returns items in the specified work queue.

POST

/api/v7/workqueues/
{workQueueId}/items

Requires at least one of the following Control Room permissions:

  • Read Access to Queue Management
  • Full Access to Queue Management

If accessing active queue items, at least one of the following Process Studio permissions are also required:

  • Create Process
  • Edit Process
  • Execute Process

Adds items to a work queue.

This endpoint will be deprecated in a future release, and is replaced by the /api/v7/workqueues/{workQueueId}/items/batch endpoint.

POST

/api/v7/workqueues/
{workQueueId}/items/
batch

Requires at least one of the following Control Room permissions:

  • Read Access to Queue Management
  • Full Access to Queue Management

If accessing active queue items, at least one of the following Process Studio permissions are also required:

  • Create Process
  • Edit Process
  • Execute Process

Creates multiple work queue items.

GET

/api/v7/workqueues/items/
{workQueueItemId}

Requires at least one of the following Control Room permissions:

  • Read Access to Queue Management
  • Full Access to Queue Management

If accessing active queue items, at least one of the following Process Studio permissions are also required:

  • Create Process
  • Edit Process
  • Execute Process

Returns details of the specified item in a work queue.

This endpoint will be deprecated in a future release, and is replaced by the /api/v7/workqueues/
{workQueueId}/items/{workQueueItemId} endpoint.

GET

/api/v7/workqueues/
{workQueueId}/items/
{workQueueItemId}

Requires at least one of the following Control Room permissions:

  • Read Access to Queue Management
  • Full Access to Queue Management

If accessing active queue items, at least one of the following Process Studio permissions are also required:

  • Create Process
  • Edit Process
  • Execute Process

Returns details of the specified item in a work queue.

GET

/api/v7/workqueues/
{workQueueId}/items/
{workQueueItemId}/attempts

Requires at least one of the following Control Room permissions:

  • Read Access to Queue Management
  • Full Access to Queue Management

If accessing active queue items, at least one of the following Process Studio permissions are also required:

  • Create Process
  • Edit Process
  • Execute Process

Returns all attempts for the specified work queue item.

POST

/api/v7/workqueues/
{workQueueId}/items/
{workQueueItemId}/attempts

Requires at least one of the following Control Room permissions:

  • Full Access to Queue Management

Creates a new work queue item attempt by forcing an item to retry.

PATCH

/api/v7/workqueues/
{workQueueId}/items/
{workQueueItemId}/attempts/
{attemptId}

Requires at least one of the following Control Room permissions:

  • Full Access to Queue Management

Modifies the work queue item as described in the patch document. This request can be used to update a work queue item's status, or to defer a pending item.

DELETE

/api/v7/workqueues/
{workQueueId}/items
/{workQueueItemId}/attempts/
{attemptId}

Requires at least one of the following Control Room permissions:

  • Full Access to Queue Management

Deletes a worked queue item.

Work queue groups

Request

Endpoint

Required user permission

Response

POST

/api/v7/workqueuegroup

Requires the following System Manager permission:

  • Workflow – Work Queue Configuration

Creates a work queue group.

GET

/api/v7/workqueuegroups/{workQueueGroupId}

Requires the following System Manager permission:

  • Workflow – Work Queue Configuration

Returns details of the specified work queue group.

PATCH

/api/v7/workqueuegroups/{workQueueGroupId}

Requires the following System Manager permission:

  • Workflow – Work Queue Configuration

Modifies the work queue group as described in the patch document.

DELETE

/api/v7/workqueuegroups/{workQueueGroupId}

Requires the following System Manager permission:

  • Workflow – Work Queue Configuration

Deletes a work queue group.

GET

/api/v7/workqueuegroups/{workQueueGroupId}/items

Requires the following System Manager permission:

  • Workflow – Work Queue Configuration

Returns a list of work queue group items.

GET

/api/v7/workqueuegroups/{workQueueGroupId}/child-groups

Requires the following System Manager permission:

  • Workflow – Work Queue Configuration

Returns details of child groups of the specified work queue group.