API docs by Redocly

Blue Prism API (7.1.2)

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

Calendars

Return a list of calendars.

Authorizations:
BearerOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Dashboards

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

Authorizations:
BearerOAuth2
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:
BearerOAuth2
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:
BearerOAuth2
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:
BearerOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Health

Return health of API.

Authorizations:
BearerOAuth2

Responses

Response samples

Content type
application/json
{
  • "healthy": true,
  • "dependencies": [
    ]
}

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:
BearerOAuth2
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:
BearerOAuth2
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:
BearerOAuth2
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:
BearerOAuth2

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:
BearerOAuth2
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 per 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 schedule definition.

Permissions required: Create Schedule

and Edit Schedule

Authorizations:
BearerOAuth2
query Parameters
copyFrom
integer

Schedule ID to create copy against.

Request Body schema: application/json

Details of the schedule definition to create or to update when cloning. To send a request without a body, enter a null value (swagger only).

name
string

The name of the schedule.

description
string

The description of the schedule.

initialTaskId
integer or null

The ID of the initial task this schedule executes.

intervalType
string
Enum: "Once" "Minute" "Hour" "Day" "Week" "Month" "Year"

The type of interval the schedule runs at.

startDate
string <date-time>

The earliest date the schedule will run.

endDate
string or null <date-time>

The last date on which the schedule will run. If this value is null or missing then the schedule will run indefinitely.

timeZoneId
string or null

The ID of the time zone.

adjustForDaylightSaving
boolean or null

Determines if to use daylight savings time when time zone is a valid time zone ID.

object (HourlyMinutelyDetails)

Hourly and minute details that apply to the hourly and minute interval schedule type.

object (HourlyMinutelyDetails)

Hourly and minute details that apply to the hourly and minute interval schedule type.

object (DailyDetails)

Daily details that apply to the daily interval schedule type.

object (WeeklyDetails)

Weekly details that apply to the weekly interval schedule type.

object (MonthlyDetails)

Monthly details that apply to the monthly interval schedule type.

object (YearlyDetails)

Yearly details that apply to the yearly interval schedule type.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "initialTaskId": 0,
  • "intervalType": "Once",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "timeZoneId": "string",
  • "adjustForDaylightSaving": true,
  • "minutelyDetails": {
    },
  • "hourlyDetails": {
    },
  • "dailyDetails": {
    },
  • "weeklyDetails": {
    },
  • "monthlyDetails": {
    },
  • "yearlyDetails": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0
}

Return requested schedule summary.

Permissions required

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

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule to return.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "initialTaskId": 0,
  • "initialTaskName": "string",
  • "isRetired": true,
  • "tasksCount": 0,
  • "intervalType": "Once",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "timeZoneId": "string",
  • "adjustForDaylightSaving": true,
  • "hourlyDetails": {
    },
  • "minutelyDetails": {
    },
  • "dailyDetails": {
    },
  • "weeklyDetails": {
    },
  • "monthlyDetails": {
    },
  • "yearlyDetails": {
    }
}

Update a given schedule.

Permissions required

For editing: Edit Schedule

For retiring all of the following: Edit Schedule | Retire Schedule

For unretiring all of the following: Edit Schedule | Retire Schedule | Create Schedule

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule to update.

Request Body schema: application/json
name
string

The name of the schedule.

description
string

The description of the schedule.

initialTaskId
integer or null

The ID of the initial task this schedule executes.

isRetired
boolean

If the schedule is retired or not.

intervalType
string
Enum: "Once" "Minute" "Hour" "Day" "Week" "Month" "Year"

The type of interval the schedule runs at.

startDate
string <date-time>

The earliest date the schedule will run.

endDate
string or null <date-time>

The last date on which the schedule will run. If this value is null or missing then the schedule will run indefinitely.

timeZoneId
string or null

The ID of the time zone.

adjustForDaylightSaving
boolean or null

Determines if to use daylight savings time when time zone is a valid time zone ID.

object (HourlyMinutelyDetails)

Hourly and minute details that apply to the hourly and minute interval schedule type.

object (HourlyMinutelyDetails)

Hourly and minute details that apply to the hourly and minute interval schedule type.

object (DailyDetails)

Daily details that apply to the daily interval schedule type.

object (WeeklyDetails)

Weekly details that apply to the weekly interval schedule type.

object (MonthlyDetails)

Monthly details that apply to the monthly interval schedule type.

object (YearlyDetails)

Yearly details that apply to the yearly interval schedule type.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "initialTaskId": 0,
  • "isRetired": true,
  • "intervalType": "Once",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "timeZoneId": "string",
  • "adjustForDaylightSaving": true,
  • "minutelyDetails": {
    },
  • "hourlyDetails": {
    },
  • "dailyDetails": {
    },
  • "weeklyDetails": {
    },
  • "monthlyDetails": {
    },
  • "yearlyDetails": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "initialTaskId": 0,
  • "initialTaskName": "string",
  • "isRetired": true,
  • "tasksCount": 0,
  • "intervalType": "Once",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "timeZoneId": "string",
  • "adjustForDaylightSaving": true,
  • "hourlyDetails": {
    },
  • "minutelyDetails": {
    },
  • "dailyDetails": {
    },
  • "weeklyDetails": {
    },
  • "monthlyDetails": {
    },
  • "yearlyDetails": {
    }
}

Delete a specified schedule.

Permissions required: Delete Schedule

and Edit Schedule

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule to delete.

Responses

Response samples

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

Create a session and set a schedule to run at a specific date and time.

Permissions required: Edit Schedule

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

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-02T12:34:56+02:00"
}

Response samples

Content type
application/json
{
  • "scheduledTime": "2020-10-02T12:34:56+02:00"
}

Request the schedule to stop.

Permissions required: Edit Schedule

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule.

Responses

Response samples

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

Return a list of tasks in a schedule.

Permissions required

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

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule for which to retrieve tasks.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a task in a schedule.

Permissions required

At least one of: Create Schedule | Edit Schedule

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule for which to create task.

Request Body schema: application/json
name
string

The name of the scheduled task.

description
string

The description of the scheduled task.

failFastOnError
boolean

Determines if all errors should be regarded as a task failure.

delayAfterEnd
integer

The delay after task end.

onSuccessTaskId
integer

The ID for the task to commence on the success of this task.

onFailureTaskId
integer

The ID for the task to commence on the failure of this task.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "failFastOnError": true,
  • "delayAfterEnd": 0,
  • "onSuccessTaskId": 0,
  • "onFailureTaskId": 0
}

Response samples

Content type
application/json
{
  • "taskId": 0
}

Return a given scheduled task.

Permissions required

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

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule that task belongs to.

taskId
required
integer

The ID of the scheduled task to return.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "failFastOnError": true,
  • "delayAfterEnd": 0,
  • "onSuccessTaskId": 0,
  • "onSuccessTaskName": "string",
  • "onFailureTaskId": 0,
  • "onFailureTaskName": "string",
  • "sessionsCount": 0
}

Delete a given scheduled task.

Permissions required: Edit Schedule

and Delete Schedule

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule that task belongs to.

taskId
required
integer

The ID of the task to delete.

Responses

Response samples

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

Update a given scheduled task.

Permissions required: Edit Schedule

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule that task belongs to

taskId
required
integer

The ID of the scheduled task to update.

Request Body schema: application/json
name
string

The name of the scheduled task.

description
string

The description of the scheduled task.

failFastOnError
boolean

Determines if all errors should be regarded as a task failure.

delayAfterEnd
integer

The delay after task end.

onSuccessTaskId
integer

The ID for the task to commence on the success of this task.

onFailureTaskId
integer

The ID for the task to commence on the failure of this task.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "failFastOnError": true,
  • "delayAfterEnd": 0,
  • "onSuccessTaskId": 0,
  • "onFailureTaskId": 0
}

Response samples

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

Delete scheduled task session.

Permissions required: Edit Schedule

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule.

taskId
required
integer

The ID of the scheduled task.

sessionId
required
integer

The ID of the scheduled task session.

Responses

Response samples

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

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

Permissions required

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

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule that task belongs to.

taskId
required
integer >= 1

The ID of the task to retrieve data for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a scheduled session in task.

Permissions required

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

And at least one of: View Process Definition | Export Process | Execute Process | Manage Process Access Rights | Execute Process as Web Service | Edit Process Groups | Edit Process | Delete Process | Create Process

and Edit Schedule

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer >= 1

The ID of the schedule that task belongs to.

taskId
required
integer >= 1

The ID of the task for which to create scheduled session.

Request Body schema: application/json

Parameters of the scheduled session to create.

processId
string <uuid>

The ID of the process.

resourceId
string <uuid>

The ID of the resource.

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6"
}

Response samples

Content type
application/json
{
  • "scheduledSessionId": 0
}

Return a list of the scheduled sessions for a specified task. Deprecated

Permissions required

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

Authorizations:
BearerOAuth2
path Parameters
taskId
required
integer >= 1

The ID of the task to retrieve data for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update start-up parameters.

Permissions required: Edit Schedule

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer >= 1

The ID of the schedule to update start-up parameters for.

taskId
required
integer >= 1

The ID of the task to update start-up parameters for.

Request Body schema: application/json

A collection of start up parameters.

Array
object (DataRow)

A dictionary which represents a row of data from a Blue Prism collection.

taskSessionId
integer <integer>

The ID of scheduled task session.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Return start-up parameters.

Permissions required

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

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer >= 1

The ID of the schedule to retrieve start-up parameters for.

taskId
required
integer >= 1

The ID of the task to retrieve start-up parameters for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return all logs for a specified schedule Deprecated

Permissions required

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

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule to retrieve data for

query Parameters
sortBy
string
Enum: "EndTimeAsc" "EndTimeDesc" "ScheduleLogIdAsc" "ScheduleLogIdDesc" "ScheduleNameAsc" "ScheduleNameDesc" "ServerNameAsc" "ServerNameDesc" "StartTimeAsc" "StartTimeDesc" "StatusAsc" "StatusDesc"

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

itemsPerPage
integer

The number of items to show per page

scheduleLogStatus
Array of strings
Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned"

A filter to search for the status of the log.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • startTime[eq]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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

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

A filter to search for name of the schedule.

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

A filter to search for name of the server.

Responses

Response samples

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

Return all schedule logs. Deprecated

Permissions required

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

Authorizations:
BearerOAuth2
query Parameters
sortBy
string
Enum: "EndTimeAsc" "EndTimeDesc" "ScheduleLogIdAsc" "ScheduleLogIdDesc" "ScheduleNameAsc" "ScheduleNameDesc" "ServerNameAsc" "ServerNameDesc" "StartTimeAsc" "StartTimeDesc" "StatusAsc" "StatusDesc"

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

itemsPerPage
integer

The maximum number of items to retrieve per page.

scheduleLogStatus
Array of strings
Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned"

A filter to search for the status of the log.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • startTime[eq]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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.

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

A filter to search for name of the schedule.

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

A filter to search for name of the server.

Responses

Response samples

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

ScheduleLogs

Return all schedule logs.

Permissions required

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

Authorizations:
BearerOAuth2
query Parameters
sortBy
string
Enum: "EndTimeAsc" "EndTimeDesc" "ScheduleLogIdAsc" "ScheduleLogIdDesc" "ScheduleNameAsc" "ScheduleNameDesc" "ServerNameAsc" "ServerNameDesc" "StartTimeAsc" "StartTimeDesc" "StatusAsc" "StatusDesc" "DurationAsc" "DurationDesc"

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

itemsPerPage
integer

The maximum number of items to retrieve per page.

scheduleLogStatus
Array of strings
Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned"

A filter to search for the status of the log.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • startTime[eq]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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.

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

A filter to search for the schedules duration.

pagingToken
string

The token to point to the last item previously returned.

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

A filter to search for name of the schedule.

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

A filter to search for name of the server.

Responses

Response samples

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

Return all logs for a specified schedule.

Permissions required

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

Authorizations:
BearerOAuth2
path Parameters
scheduleId
required
integer

The ID of the schedule to retrieve data for.

query Parameters
sortBy
string
Enum: "EndTimeAsc" "EndTimeDesc" "ScheduleLogIdAsc" "ScheduleLogIdDesc" "ServerNameAsc" "ServerNameDesc" "StartTimeAsc" "StartTimeDesc" "StatusAsc" "StatusDesc" "DurationAsc" "DurationDesc"

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

itemsPerPage
integer

The maximum number of items to retrieve per page.

scheduleLogStatus
Array of strings
Items Enum: "Pending" "Running" "Terminated" "Completed" "PartExceptioned"

A filter to search for the status of the log.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • startTime[eq]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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.

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

A filter to search for the schedules duration.

pagingToken
string

The token to point to the last item previously returned.

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

A filter to search for name of the server.

Responses

Response samples

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

Sessions

Return a list of sessions in the environment.

Permissions required

At least one of: Create Process | Delete Process | Edit Process | Edit Process Groups | Export Process | Execute Process | Execute Process as Web Service | View Process Definition | Manage Process Access Rights

And at least one of: View Resource | View Resource Screen Captures | Configure Resource | Control Resource | Manage Resource Access Rights

Authorizations:
BearerOAuth2
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) (BasicNumericFilter)
Examples:
  • sessionNumber[strtw]=123 - Search for a value starting with 123
  • sessionNumber[eq]=123 - Search for a value equal to 123.
  • sessionNumber[gte]=123&sessionNumber[lte]=321 - Search for a value between 123 and 321 inclusive.
  • sessionNumber[gte]=123 - Search for a value greater than or equal to 123.

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]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • startTime[gte]=2020-10-02T12:34:56+01:00&startTime[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • endTime[gte]=2020-10-02T12:34:56+01:00&endTime[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • latestStage[gte]=2020-10-02T12:34:56+01:00&latestStage[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • stageStarted[gte]=2020-10-02T12:34:56+01:00&stageStarted[lte]=2020-11-02T12:34:56+01:00 - 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]=2020-10-02T12:34:56+01:00 - 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.

onlySessionsForCurrentUser
boolean

Flag to restrict sessions to API user.

Responses

Response samples

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

Create a new session for the given resource ID and process ID.

Permissions required

At least one of: Create Process | Edit Process | Execute Process

and Control Resource

Authorizations:
BearerOAuth2
Request Body schema: application/json

Parameters to create a new session

resourceId
string <uuid>

The ID of the resource or pool to create session.

processId
string <uuid>

The ID of the process to create session.

Responses

Request samples

Content type
application/json
{
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Return details of a specified session.

Permissions required

At least one of: Create Process | Delete Process | Edit Process | Edit Process Groups | Export Process | Execute Process | Execute Process as Web Service | View Process Definition | Manage Process Access Rights

And at least one of: View Resource | View Resource Screen Captures | Configure Resource | Control Resource | Manage Resource Access Rights

Authorizations:
BearerOAuth2
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,
  • "areStartupParamsSet": true,
  • "processId": "01234567-89ab-cdef-0123-456789abcdef",
  • "processName": "Example process",
  • "resourceId": "01234567-89ab-cdef-0123-456789abcdef",
  • "resourceName": "Example resource",
  • "username": "Example user",
  • "status": "Running",
  • "startTime": "2020-10-02T12:34:56+02:00",
  • "endTime": "2020-10-03T13:36:21+02:00",
  • "latestStage": "Example stage",
  • "stageStarted": "2020-10-02T12:35:30+02:00",
  • "exceptionMessage": "Exception message",
  • "terminationReason": "InternalError",
  • "exceptionType": "Exception type"
}

Update the session for the given session ID.

Permissions required

At least one of: Create Process | Edit Process | Execute Process

and Control Resource

Authorizations:
BearerOAuth2
path Parameters
sessionId
required
string <uuid>

The ID of the session to update.

Request Body schema: application/json

Details of the session to update, only supports 'running' status.

status
string
Enum: "pending" "running" "stopped" "terminated" "completed" "stopping" "warning"

The status of the session.

Responses

Request samples

Content type
application/json
{
  • "status": "pending"
}

Response samples

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

Get start-up parameters for a specified session.

Permissions required

At least one of: Create Process | Edit Process | Export Process | Execute Process | View Process Definition

And at least one of: View Resource | View Resource Screen Captures | Configure Resource | Control Resource | Manage Resource Access Rights

Authorizations:
BearerOAuth2
path Parameters
sessionId
required
string <uuid>

The ID of the session to retrieve start-up parameters for.

Responses

Response samples

Content type
application/json
{
  • "parameters": {
    }
}

Update start-up parameters for a specified session.

Permissions required

At least one of: Create Process | Edit Process | Execute Process

and Control Resource

Authorizations:
BearerOAuth2
path Parameters
sessionId
required
string <uuid>

The ID of the session to update start-up parameters for.

Request Body schema: application/json

A start-up parameters for session.

object (DataRow)

A dictionary which represents a row of data from a Blue Prism collection.

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

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

Return all logs for a specified session.

Permissions required

At least one of: Create Process | Delete Process | Edit Process | Edit Process Groups | Export Process | Execute Process | Execute Process as Web Service | View Process Definition | Manage Process Access Rights

And at least one of: View Resource | View Resource Screen Captures | Configure Resource | Control Resource | Manage Resource Access Rights

and Audit - Process Logs

Authorizations:
BearerOAuth2
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 per page.

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.

Permissions required

At least one of: Create Process | Delete Process | Edit Process | Edit Process Groups | Export Process | Execute Process | Execute Process as Web Service | View Process Definition | Manage Process Access Rights

And at least one of: View Resource | View Resource Screen Captures | Configure Resource | Control Resource | Manage Resource Access Rights

and Audit - Process Logs

Authorizations:
BearerOAuth2
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": {
    }
}

Time Zones

Return a list of time zones.

Authorizations:
BearerOAuth2

Responses

Response samples

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

User

Return a list of permissions for the currently authenticated user.

Authorizations:
BearerOAuth2

Responses

Response samples

Content type
application/json
[
  • "Permission_1",
  • "Permission_2",
  • "Permission_3"
]

Work Queues

Return a list of work queues in the environment.

Permissions required

At least one of: Read Access to Queue Management | Full Access to Queue Management

Authorizations:
BearerOAuth2
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=12:34:56 - Search for a value equal to 12:34:56.
  • gte=01:23:45&lte=12:34:56 - Search for a value between 01:23:45 and 12:34:56 (inclusive)
  • lte=12:34:56 - 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=12:34:56 - Search for a value equal to 12:34:56.
  • gte=01:23:45&lte=12:34:56 - Search for a value between 01:23:45 and 12:34:56 (inclusive)
  • lte=12:34:56 - 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 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": [
    ]
}

Create a new work queue.

Permissions required: Workflow - Work Queue Configuration

Authorizations:
BearerOAuth2
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, 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.

Permissions required

At least one of: Read Access to Queue Management | Full Access to Queue Management

Authorizations:
BearerOAuth2
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"
}

Modify the work queue as described in the patch document.

Permissions required

At least one of: Read Access to Queue Management | Full Access to Queue Management

and Workflow - Work Queue Configuration

Authorizations:
BearerOAuth2
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
[
  • {
    }
]

Response samples

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

Delete a specified work queue.

Permissions required: Workflow - Work Queue Configuration

Authorizations:
BearerOAuth2
path Parameters
workQueueId
required
string <uuid>

The ID of the queue to delete.

Responses

Response samples

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

Return items in a specified work queue.

Permissions required

At least one of: Read Access to Queue Management | Full Access to Queue Management

Additional permissions for accessing Active Queue items

At least one of: Create Process | Edit Process | Execute Process And Control Resource

Authorizations:
BearerOAuth2
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" "SlaAsc" "SlaDesc" "SlaDateTimeAsc" "SlaDateTimeDesc" "ProcessNameAsc" "ProcessNameDesc" "IsSuggestedAsc" "IsSuggestedDesc"

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

(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter)
Examples:
  • 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.

state
Array of strings
Items Enum: "Pending" "Locked" "Deferred" "Completed" "Exceptioned"

A filter to search for the current state of the work queue item.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=12:34:56 - Search for a value equal to 12:34:56.
  • gte=01:23:45&lte=12:34:56 - Search for a value between 01:23:45 and 12:34:56 (inclusive)
  • lte=12:34:56 - 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=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - 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.

(RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object) (RangeOrEqualFilter)
Examples:
  • eq=2020-10-02T12:34:56+01:00 - Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
  • gte=2020-10-02T12:34:56+01:00&lte=2020-11-02T12:34:56+01:00 - 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=2020-10-02T12:34:56+01:00 - Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).

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

(StringFilter (ContainsStringFilter (object) or StartsWithStringFilter (object))) or (RangeOrEqualFilter ((RangeFilter (GreaterThanOrEqualToFilter (object) or LessThanOrEqualToFilter (object))) or EqualsFilter (object))) (FullStringFilter)
Examples:
  • 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 process name of the work queue item.

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

A filter to search for the sla time of the work queue item.

withinSla
boolean

Flag to get work queue items within sla time.

object (EqualsFilter)
Example:

A filter to search the work queue items which is used to help troubleshoot issues.

itemsPerPage
integer

The maximum number of items to retrieve per page.

pagingToken
string

The token to point to the last item previously returned.

Responses

Response samples

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

Create work queue item(s). Deprecated

Permissions required: Full Access to Queue Management

Additional permissions for accessing Active Queue items

At least one of: Create Process | Edit Process | Execute Process And Control Resource

Authorizations:
BearerOAuth2
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": [
    ]
}

Create work queue items.

Permissions required: Full Access to Queue Management

Additional permissions for accessing Active Queue items

At least one of: Create Process | Edit Process | Execute Process And Control Resource This endpoint does not support application server-based encryption keys. Only work queues that are not encrypted, or use database-based encryption keys can use this endpoint.

Authorizations:
BearerOAuth2
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. Deprecated

Permissions required

At least one of: Read Access to Queue Management | Full Access to Queue Management

Additional permissions for accessing Active Queue items

At least one of: Create Process | Edit Process | Execute Process And Control Resource This endpoint does not support application server-based encryption keys. Only work queues that are not encrypted, or use database-based encryption keys can use this endpoint.

Authorizations:
BearerOAuth2
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-02T12:34:56+01:00",
  • "deferredDate": "2020-10-02T12:34:56+01:00",
  • "lockedDate": "0001-01-01T00:00:00Z",
  • "completedDate": "2020-10-02T13:00:00+01:00",
  • "exceptionedDate": "0001-01-01T00:00:00Z",
  • "exceptionReason": "Example reason",
  • "lastUpdated": "2020-10-02T13:00:00+01:00",
  • "workTimeInSeconds": 123,
  • "attemptWorkTimeInSeconds": 123,
  • "resource": "Example resource",
  • "data": {
    },
  • "sla": 7200,
  • "sladatetime": "0001-01-01T00:00:00Z",
  • "processname": "Example process name",
  • "issuggested": false
}

Return details of a specified item from a work queue.

Permissions required

At least one of: Read Access to Queue Management | Full Access to Queue Management.

Additional permissions for accessing Active Queue item

At least one of: Create Process | Edit Process | Execute Process And Control Resource This endpoint does not support application server-based encryption keys. Only work queues that are not encrypted, or use database-based encryption keys can use this endpoint.

Authorizations:
BearerOAuth2
path Parameters
workQueueId
required
string <uuid>

The queue ID of the item to get.

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-02T12:34:56+01:00",
  • "deferredDate": "2020-10-02T12:34:56+01:00",
  • "lockedDate": "0001-01-01T00:00:00Z",
  • "completedDate": "2020-10-02T13:00:00+01:00",
  • "exceptionedDate": "0001-01-01T00:00:00Z",
  • "exceptionReason": "Example reason",
  • "lastUpdated": "2020-10-02T13:00:00+01:00",
  • "workTimeInSeconds": 123,
  • "attemptWorkTimeInSeconds": 123,
  • "resource": "Example resource",
  • "data": {
    },
  • "sla": 7200,
  • "sladatetime": "0001-01-01T00:00:00Z",
  • "processname": "Example process name",
  • "issuggested": false
}