openapi: 3.2.0
info:
  title: Blue Prism Schedules API
  description: An API to expose core functionality of the Blue Prism product.
  version: 7.5.1
security:
- Bearer:
  - bp-api
  - bpserver
- OAuth2:
  - bp-api
  - bpserver
tags:
- name: Schedules
paths:
  /api/v7/schedules:
    get:
      summary: Return a list of schedules in the environment
      operationId: getSchedules
      description: '> ### Permissions required

        At least one of: `View Schedule` | `Edit Schedule` | `Delete Schedule`

        | `Create Schedule` | `Retire Schedule` | `System - Scheduler`'
      tags:
      - Schedules
      parameters:
      - name: name
        description: A filter to search for name of the schedule.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/BasicStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: retirementStatus
        description: A filter to search for the retirement status of the schedule. The default behavior is to search for all statuses.
        in: query
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - Active
            - Retired
      - name: itemsPerPage
        in: query
        description: The maximum number of items to retrieve per page.
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        in: query
        description: The token to point to the last item previously returned.
        schema:
          type: string
      responses:
        '200':
          description: A list of schedule summaries was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      summary: Create a new schedule definition
      operationId: createSchedule
      description: '> ### Permissions required: `Create Schedule`


        and `Edit Schedule`'
      tags:
      - Schedules
      parameters:
      - name: copyFrom
        in: query
        description: Schedule ID to create copy against.
        deprecated: true
        schema:
          type: integer
      requestBody:
        description: 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).
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleDetailsOptionalName'
      responses:
        '201':
          description: The schedule definition was successfully created/copied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateScheduleDefinitionResponseModel'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/schedules/{scheduleId}:
    get:
      summary: Return requested schedule summary
      operationId: getSchedule
      description: '> ### Permissions required

        At least one of: `View Schedule` | `Edit Schedule` | `Delete Schedule`

        | `Create Schedule` | `Retire Schedule` | `System - Scheduler`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule to return.
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: The schedule summary was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleDefinitionResponseModel'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      summary: Update a given schedule
      operationId: updateSchedule
      description: '> ### 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`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule to update.
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleDetailsOptionalName'
      responses:
        '200':
          description: The schedule was successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleDefinitionResponseModel'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      summary: Delete a specified schedule
      operationId: deleteSchedule
      description: '> ### Permissions required: `Delete Schedule`


        and `Edit Schedule`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule to delete.
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: The schedule was successfully deleted.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/schedules/{scheduleId}/clones:
    post:
      summary: Clone a new schedule definition
      operationId: CloneSchedule
      description: '> ### Permissions required

        `Create Schedule` and `Edit Schedule`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule to copy.
        required: true
        schema:
          type: integer
      requestBody:
        description: Details of the schedule definition to update. Name can not be a null value.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneScheduleDetails'
      responses:
        '200':
          description: The schedule summary was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateScheduleDefinitionResponseModel'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/schedules/{scheduleId}/sessions:
    post:
      deprecated: true
      summary: Create a session and set a schedule to run at a specific date and time
      operationId: startSchedule
      description: '> ### Permissions required: `Edit Schedule`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule to start.
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleSessionStart'
      responses:
        '202':
          description: The schedule was successfully set to run at a specified date and time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleSessionStartResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      deprecated: true
      summary: Request the schedule to stop
      operationId: stopSchedule
      description: '> ### Permissions required: `Edit Schedule`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule.
        required: true
        schema:
          type: integer
      responses:
        '202':
          description: The request to stop the schedule was successfully sent.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/schedules/{scheduleId}/runs/active:
    delete:
      summary: Request the schedule to stop
      operationId: stopSchedule
      description: '> ### Permissions required: `Edit Schedule`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule.
        required: true
        schema:
          type: integer
      responses:
        '202':
          description: The request to stop the schedule was successfully sent.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/schedules/{scheduleId}/tasks:
    get:
      summary: Return a list of tasks in a schedule
      operationId: getScheduleTasks
      description: '> ### Permissions required

        At least one of: `View Schedule` | `Edit Schedule` | `Delete Schedule`

        | `Create Schedule` | `Retire Schedule` | `System - Scheduler`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule for which to retrieve tasks.
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: A list of tasks is successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScheduledTask'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      summary: Create a task in a schedule
      operationId: createScheduleTask
      description: '> ### Permissions required

        At least one of: `Create Schedule` | `Edit Schedule`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule for which to create task.
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScheduledTask'
      responses:
        '201':
          description: An ID of successfully created task.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateScheduledTaskResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorMessage'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
  /api/v7/schedules/{scheduleId}/tasks/{taskId}:
    get:
      summary: Return a given scheduled task
      operationId: getScheduleTask
      description: '> ### Permissions required

        At least one of: `View Schedule` | `Edit Schedule` | `Delete Schedule`

        | `Create Schedule` | `Retire Schedule` | `System - Scheduler`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule that task belongs to.
        required: true
        schema:
          type: integer
      - name: taskId
        in: path
        description: The ID of the scheduled task to return.
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: The schedule task  was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledTask'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      summary: Delete a given scheduled task
      operationId: deleteScheduleTask
      description: '> ### Permissions required: `Edit Schedule`


        and `Delete Schedule`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule that task belongs to.
        required: true
        schema:
          type: integer
      - name: taskId
        in: path
        description: The ID of the task to delete.
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: The task was successfully deleted.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      summary: Update a given scheduled task
      operationId: updateScheduleTask
      description: '> ### Permissions required: `Edit Schedule`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule that task belongs to
        required: true
        schema:
          type: integer
      - name: taskId
        in: path
        description: The ID of the scheduled task to update.
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScheduledTask'
      responses:
        '204':
          description: The scheduled task was successfully updated.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/schedules/{scheduleId}/tasks/{taskId}/sessions/{sessionId}:
    delete:
      summary: Delete scheduled task session
      operationId: deleteScheduledTaskSession
      description: '> ### Permissions required: `Edit Schedule`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule.
        required: true
        schema:
          type: integer
      - name: taskId
        in: path
        description: The ID of the scheduled task.
        required: true
        schema:
          type: integer
      - name: sessionId
        in: path
        description: The ID of the scheduled task session.
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: The scheduled task session was successfully deleted.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/schedules/{scheduleId}/tasks/{taskId}/sessions:
    get:
      summary: Return a list of the scheduled sessions for a specified task
      operationId: getScheduledSessionForTask
      description: '> ### Permissions required

        At least one of: `View Schedule` | `Edit Schedule` | `Delete Schedule`

        | `Create Schedule` | `Retire Schedule` | `System - Scheduler`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule that task belongs to.
        required: true
        schema:
          type: integer
      - name: taskId
        in: path
        description: The ID of the task to retrieve data for.
        required: true
        schema:
          type: integer
          minimum: 1
      responses:
        '200':
          description: A collection of the associated scheduled sessions for a specific task.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledSession'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      summary: Create a scheduled session in task
      operationId: createScheduleSessionForTask
      description: '> ### 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`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule that task belongs to.
        required: true
        schema:
          type: integer
          minimum: 1
      - name: taskId
        in: path
        description: The ID of the task for which to create scheduled session.
        required: true
        schema:
          type: integer
          minimum: 1
      requestBody:
        description: Parameters of the scheduled session to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduledSessionParameters'
      responses:
        '201':
          description: A successfully created scheduled session ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateScheduledSessionResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorMessage'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/schedules/tasks/{taskId}/sessions:
    get:
      deprecated: true
      summary: Return a list of the scheduled sessions for a specified task
      operationId: getSchduledSessionsForTask
      description: '> ### Permissions required

        At least one of: `View Schedule` | `Edit Schedule` | `Delete Schedule`

        | `Create Schedule` | `Retire Schedule` | `System - Scheduler`'
      tags:
      - Schedules
      parameters:
      - name: taskId
        in: path
        description: The ID of the task to retrieve data for.
        required: true
        schema:
          type: integer
          minimum: 1
      responses:
        '200':
          description: A collection of the associated scheduled sessions for a specific task.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledSession'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/schedules/{scheduleId}/tasks/{taskId}/scheduledSessionParameters:
    put:
      summary: Update start-up parameters
      operationId: updateStartupParameters
      description: '> ### Permissions required: `Edit Schedule`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule to update start-up parameters for.
        required: true
        schema:
          type: integer
          minimum: 1
      - name: taskId
        in: path
        description: The ID of the task to update start-up parameters for.
        required: true
        schema:
          type: integer
          minimum: 1
      requestBody:
        description: A collection of start up parameters.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduledSessionArguments'
      responses:
        '204':
          description: Associated scheduled sessions for a specific task were updated.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    get:
      summary: Return start-up parameters
      operationId: getStartupParameters
      description: '> ### Permissions required

        At least one of: `View Schedule` | `Edit Schedule` | `Delete Schedule`

        | `Create Schedule` | `Retire Schedule` | `System - Scheduler`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule to retrieve start-up parameters for.
        required: true
        schema:
          type: integer
          minimum: 1
      - name: taskId
        in: path
        description: The ID of the task to retrieve start-up parameters for.
        required: true
        schema:
          type: integer
          minimum: 1
      responses:
        '200':
          description: A collection of start up parameters for a specific task.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledSessionArguments'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/schedules/{scheduleId}/logs:
    get:
      deprecated: true
      summary: Return all logs for a specified schedule
      operationId: getLogsForSchedule
      description: '> ### Permissions required

        At least one of: `View Schedule` | `Edit Schedule` | `Delete Schedule`

        | `Create Schedule` | `Retire Schedule` | `System - Scheduler`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        description: The ID of the schedule to retrieve data for
        in: path
        required: true
        schema:
          type: integer
      - name: sortBy
        description: The field that results should be sorted by and the direction they should be sorted in.
        in: query
        required: false
        schema:
          type: string
          enum:
          - EndTimeAsc
          - EndTimeDesc
          - ScheduleLogIdAsc
          - ScheduleLogIdDesc
          - ScheduleNameAsc
          - ScheduleNameDesc
          - ServerNameAsc
          - ServerNameDesc
          - StartTimeAsc
          - StartTimeDesc
          - StatusAsc
          - StatusDesc
      - name: itemsPerPage
        description: The number of items to show per page
        in: query
        required: false
        schema:
          type: integer
      - name: scheduleLogStatus
        description: A filter to search for the status of the log.
        in: query
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - Pending
            - Running
            - Terminated
            - Completed
            - PartExceptioned
      - name: startTime
        description: A filter to search for the log start time.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: endTime
        description: A filter to search for the log end time.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: pagingToken
        description: The token to point to the last item previously returned
        in: query
        schema:
          type: string
      - name: scheduleName
        description: A filter to search for name of the schedule.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/BasicStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: serverName
        description: A filter to search for name of the server.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/BasicStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      responses:
        '200':
          description: A page containing a list of schedule log items and paging token are successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleLogDeprecatedItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/schedules/logs:
    get:
      deprecated: true
      summary: Return all schedule logs
      operationId: getAllScheduleLogs
      description: '> ### Permissions required

        At least one of: `View Schedule` | `Edit Schedule` | `Delete Schedule`

        | `Create Schedule` | `Retire Schedule` | `System - Scheduler`'
      tags:
      - Schedules
      parameters:
      - name: sortBy
        description: The field that results should be sorted by and the direction they should be sorted in.
        in: query
        required: false
        schema:
          type: string
          enum:
          - EndTimeAsc
          - EndTimeDesc
          - ScheduleLogIdAsc
          - ScheduleLogIdDesc
          - ScheduleNameAsc
          - ScheduleNameDesc
          - ServerNameAsc
          - ServerNameDesc
          - StartTimeAsc
          - StartTimeDesc
          - StatusAsc
          - StatusDesc
      - name: itemsPerPage
        description: The maximum number of items to retrieve per page.
        in: query
        required: false
        schema:
          type: integer
      - name: scheduleLogStatus
        description: A filter to search for the status of the log.
        in: query
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - Pending
            - Running
            - Terminated
            - Completed
            - PartExceptioned
      - name: startTime
        description: A filter to search for the log start time.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: endTime
        description: A filter to search for the log end time.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: pagingToken
        in: query
        description: The token to point to the last item previously returned.
        schema:
          type: string
      - name: scheduleName
        description: A filter to search for name of the schedule.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/BasicStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: serverName
        description: A filter to search for name of the server.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/BasicStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      responses:
        '200':
          description: A page containing a list of schedule log items and a paging token are successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleLogDeprecatedItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/schedules/{scheduleId}/runs:
    post:
      summary: Create a session and set a schedule to run at a specific date and time
      operationId: createSessionRun
      description: '> ### Permissions required: `Edit Schedule`'
      tags:
      - Schedules
      parameters:
      - name: scheduleId
        in: path
        description: The ID of the schedule to start.
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleSessionStart'
      responses:
        '202':
          description: The schedule was successfully set to run at a specified date and time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleSessionStartResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    CreateScheduleDefinitionResponseModel:
      description: Contains the ID of a schedule.
      type: object
      properties:
        id:
          type: integer
          description: The ID of the schedule.
    CreateScheduledTaskResponse:
      description: Contains ID of created task.
      type: object
      properties:
        taskId:
          type: integer
          description: The ID of the created task.
    UrlParameterError:
      description: An error occurred due to incorrect data supplied to url parameter.
      type: object
      properties:
        message:
          type: string
          description: A message about the error.
        messageDetail:
          type: string
          description: A detailed description about the error.
    ScheduledTask:
      description: Contains details of a scheduled task.
      type: object
      properties:
        id:
          type: integer
          description: The ID of the scheduled task.
        name:
          type: string
          description: The name of the scheduled task.
        description:
          type: string
          description: The description of the scheduled task.
        failFastOnError:
          type: boolean
          description: Determines if all errors should be regarded as a task failure.
        delayAfterEnd:
          type: integer
          description: The delay after task end.
        onSuccessTaskId:
          type: integer
          description: The ID for the task to commence on the success of this task.
        onSuccessTaskName:
          type: string
          description: The name of the task to commence on the success of this task.
        onFailureTaskId:
          type: integer
          description: The ID for the task to commence on the failure of this task.
        onFailureTaskName:
          type: string
          description: The name of the task to commence on the failure of this task.
        sessionsCount:
          type: integer
          description: The number of scheduled sessions a task has.
    WeeklyDetails:
      description: Weekly details that apply to the weekly interval schedule type.
      type: object
      properties:
        period:
          type: integer
          description: The schedule frequency.
        type:
          type: string
          description: The type of weekly interval.
          enum:
          - WeekDay
          - WorkingDay
        weekDay:
          type:
          - string
          - 'null'
          description: Which working day the schedule will run on.
          enum:
          - First
          - Last
        calendarId:
          type:
          - integer
          - 'null'
          description: The ID of the calendar to use.
    DataRow:
      description: A dictionary which represents a row of data from a Blue Prism collection.
      type: object
      additionalProperties:
        $ref: '#/components/schemas/DataValue'
    BasicStringFilter:
      description: Used to filter strings. Check for strings that start with, equal, are greater than, are less than, or are between the given value(s).
      type: object
      anyOf:
      - $ref: '#/components/schemas/RangeOrEqualFilter'
      - $ref: '#/components/schemas/StartsWithStringFilter'
      example:
        strtw: null
        gte: null
        lte: null
        eq: null
    ScheduleLogDeprecatedItemsPage:
      description: Contains details of a page of schedule logs.
      type: object
      properties:
        pagingToken:
          type: string
          description: The token to be used in the next request to return the next collection of items.
        items:
          type: array
          description: A collection of schedule log summary
          items:
            $ref: '#/components/schemas/ScheduleLogDeprecatedSummary'
    RangeOrEqualFilter:
      description: Used to filter values. Check for values that are equal to, greater than or equal to, less than or equal to, or between the given value(s).
      type: object
      oneOf:
      - $ref: '#/components/schemas/RangeFilter'
      - $ref: '#/components/schemas/EqualsFilter'
      example:
        gte: null
        lte: null
        eq: null
    GreaterThanOrEqualToFilter:
      description: Used to filter values. Check for values that are greater than or equal to the given value.
      type: object
      properties:
        gte:
          type:
          - object
          - 'null'
          description: The value that the field should be greater than or equal to.
      example:
        gte: null
    DataValue:
      description: Represents a single item of data in a Blue Prism format.
      type: object
      properties:
        valueType:
          description: The type of object contained in the value field.
          type: string
          enum:
          - Binary
          - Collection
          - Date
          - DateTime
          - Flag
          - Image
          - Number
          - Password
          - RadioButtons
          - Text
          - Time
          - TimeSpan
        value:
          description: The value of the object.
          oneOf:
          - type: string
            format: base64
            description: Used for Binary and Image data types. The image format must only be one of these BPM, JPG, JPEG, GIF, PNG, ICO or TIFF.
          - $ref: '#/components/schemas/DataCollection'
            description: Used for the Collection data type.
          - type: string
            format: date
            description: Used for Date and Time data types.
          - type: boolean
            description: Used for the Flag data type.
          - type: number
            description: Used for the Number data type.
          - type: string
            description: Used for Password and Text data types.
          - type: string
            format: time
            description: Used for the TimeSpan data type.
          - $ref: '#/components/schemas/RadioButtonsArray'
        additionalParameters:
          description: Custom extra parameters i.e. Binary's file path.
          type: array
          items:
            type: string
    ScheduleDetails:
      description: Contains the details of a schedule.
      type: object
      properties:
        description:
          type: string
          description: The description of the schedule.
        initialTaskId:
          type:
          - integer
          - 'null'
          description: The ID of the initial task this schedule executes.
        intervalType:
          type: string
          description: The type of interval the schedule runs at.
          enum:
          - Once
          - Minute
          - Hour
          - Day
          - Week
          - Month
          - Year
        startDate:
          type: string
          description: The earliest date the schedule will run.
          format: date-time
        endDate:
          type:
          - string
          - 'null'
          description: The last date on which the schedule will run. If this value is null or missing then the schedule will run indefinitely.
          format: date-time
        timeZoneId:
          type:
          - string
          - 'null'
          description: The ID of the time zone.
        adjustForDaylightSaving:
          type:
          - boolean
          - 'null'
          description: Determines if to use daylight savings time when time zone is a valid time zone ID.
        minutelyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/HourlyMinutelyDetails'
          description: Minute details that apply to the minute interval schedule type.
        hourlyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/HourlyMinutelyDetails'
          description: Hourly details that apply to the hour interval schedule type.
        dailyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/DailyDetails'
          description: Daily details that apply to the daily interval schedule type.
        weeklyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/WeeklyDetails'
          description: Weekly details that apply to the weekly interval schedule type.
        monthlyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/MonthlyDetails'
          description: Monthly details that apply to the monthly interval schedule type.
        yearlyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/YearlyDetails'
          description: Yearly details that apply to the yearly interval schedule type.
    ScheduleSessionStart:
      description: A request to start a schedule at startTime.
      type: object
      properties:
        startTime:
          type: string
          description: The date and time that the schedule should be run at.
          format: date-time
          example: '2020-10-02T12:34:56+02:00'
    CreateScheduledTask:
      description: Contains details of a scheduled task.
      type: object
      properties:
        name:
          type: string
          description: The name of the scheduled task.
        description:
          type: string
          description: The description of the scheduled task.
        failFastOnError:
          type: boolean
          description: Determines if all errors should be regarded as a task failure.
        delayAfterEnd:
          type: integer
          description: The delay after task end.
        onSuccessTaskId:
          type: integer
          description: The ID for the task to commence on the success of this task.
        onFailureTaskId:
          type: integer
          description: The ID for the task to commence on the failure of this task.
    StartsWithStringFilter:
      description: Used to filter strings. Check for strings that start with the given value.
      type: object
      properties:
        strtw:
          type:
          - string
          - 'null'
          description: The value that the field should start with.
      example:
        strtw: null
    ScheduledSessionParameters:
      description: Contains parameters of a scheduled session.
      type: object
      properties:
        processId:
          type: string
          format: uuid
          description: The ID of the process.
        resourceId:
          type: string
          format: uuid
          description: The ID of the resource.
    DataCollection:
      description: Represents a Blue Prism collection.
      type: object
      properties:
        rows:
          description: A collection of rows representing the data contained within the collection.
          type: array
          items:
            $ref: '#/components/schemas/DataRow'
    ValidationError:
      description: An error occurred during validation. See the response body for details on the invalid field.
      type: object
      properties:
        invalidField:
          type: string
          description: The field which is invalid.
        message:
          type: string
          description: A description of the error found with the field.
    YearlyDetails:
      description: Yearly details that apply to the yearly interval schedule type.
      type: object
      properties:
        period:
          type: integer
          description: The schedule frequency.
    ScheduledSessionArguments:
      description: Contains details of start-up parameters.
      type: array
      items:
        $ref: '#/components/schemas/ScheduledSessionArgumentsModel'
    ErrorMessage:
      description: A message describing the problem encountered.
      type: string
    CreateScheduledSessionResponse:
      description: Contains ID of created scheduled session.
      type: object
      properties:
        scheduledSessionId:
          description: The ID of the created scheduled session.
          type: integer
    ScheduledSession:
      description: Contains details of a schedule session.
      type: array
      items:
        type: object
        properties:
          processName:
            type: string
            description: The particular process associated with that session.
          resourceName:
            type: string
            description: The particular resource associated with that session.
          taskSessionId:
            type: integer
            description: The ID of the session to run associated with the task.
    CloneScheduleDetails:
      description: Contains the details of a schedule.
      allOf:
      - type: object
        properties:
          name:
            type: string
            description: The name of the schedule.
        required:
        - name
      - $ref: '#/components/schemas/ScheduleDetails'
    ScheduleSessionStartResponse:
      description: A response to a start request containing the date-time when the schedule is expected to run.
      type: object
      properties:
        scheduledTime:
          type: string
          description: The date and time that the schedule has been scheduled to run at.
          format: date-time
          example: '2020-10-02T12:34:56+02:00'
    ScheduledSessionArgumentsModel:
      description: Contains details of start-up parameters.
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/DataRow'
        taskSessionId:
          type: integer
          description: The ID of scheduled task session.
          format: integer
      example:
        parameters:
          parameter1:
            valueType: Text
            value: Example value
            additionalParameters:
            - UTF-8
          parameter2:
            valueType: Number
            value: 123
            additionalParameters: null
          parameter3:
            valueType: Image
            value: isAWPOCldncNSNLnacnKNsnaNAlknKLKScnsaklcn...
            additionalParameters:
            - C:\Path\To\File.ext
            - 01/01/2022 01:01:01 AM
        taskSessionId: 3
    ScheduleDefinitionResponseModel:
      description: Contains the details of a Schedule.
      type: object
      properties:
        id:
          type: integer
          description: The ID of the schedule.
        name:
          type: string
          description: The name of the schedule.
        description:
          type: string
          description: The description of the schedule.
        initialTaskId:
          type: integer
          description: The ID of the initial task this schedule executes.
        initialTaskName:
          type: string
          description: The Name of the initial task this schedule executes.
        isRetired:
          type: boolean
          description: If the schedule is retired or not.
        tasksCount:
          type: integer
          description: The number of tasks a schedule has.
        intervalType:
          type: string
          description: The type of interval the schedule runs at.
          enum:
          - Once
          - Minute
          - Hour
          - Day
          - Week
          - Month
          - Year
        startDate:
          type: string
          description: The earliest date the schedule will run.
          format: date-time
        endDate:
          type:
          - string
          - 'null'
          description: The last date on which the schedule will run. If this value is null or missing, the schedule will run indefinitely.
          format: date-time
        timeZoneId:
          type:
          - string
          - 'null'
          description: The ID of the time zone.
        adjustForDaylightSaving:
          type:
          - boolean
          - 'null'
          description: Determines if to use daylight savings time when time one is a valid time zone ID.
        hourlyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/HourlyMinutelyDetails'
          description: Hourly details that apply to the hour interval schedule type.
        minutelyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/HourlyMinutelyDetails'
          description: Minute details that apply to the minute interval schedule type.
        dailyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/DailyDetails'
          description: Daily details that apply to the daily interval schedule type.
        weeklyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/WeeklyDetails'
          description: Weekly details that apply to the weekly interval schedule type.
        monthlyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/MonthlyDetails'
          description: Monthly details that apply to the monthly interval schedule type.
        yearlyDetails:
          type:
          - object
          - 'null'
          $ref: '#/components/schemas/YearlyDetails'
          description: Yearly details that apply to the yearly interval schedule type.
    HourlyMinutelyDetails:
      description: Hourly and minute details that apply to the hourly and minute interval schedule type.
      type: object
      properties:
        period:
          type: integer
          description: The schedule frequency (minutes or hours).
        start:
          type: string
          format: time
          description: The time of day from which the given schedule is active.
        end:
          type: string
          format: time
          description: The time of day until which the given schedule is active.
        calendarId:
          type:
          - integer
          - 'null'
          description: The ID of the calendar to use.
    MonthlyDetails:
      description: Monthly details that apply to the monthly interval schedule type.
      type: object
      properties:
        period:
          type: integer
          description: The schedule frequency.
        type:
          type: string
          description: The type of monthly interval.
          enum:
          - NthDay
          - NthWeekDay
          - NthWorkingDay
        missingDateAction:
          type:
          - string
          - 'null'
          description: If startdate month day > 28, selects a substitute month day to execute schedule on (required when NthDay is selected).
          enum:
          - Skip
          - LastSupportedDayInMonth
          - FirstsupportedDayInNextMonth
        weekNumber:
          type:
          - string
          - 'null'
          description: Which week number to repeat the schedule on (required when NthWeekDay is selected).
          enum:
          - First
          - Second
          - Third
          - Fourth
          - Fifth
          - Last
        weekDay:
          type:
          - string
          - 'null'
          description: Which weekday to repeat the schedule on (required when NthWeekDay is selected).
          enum:
          - Sunday
          - Monday
          - Tuesday
          - Wednesday
          - Thursday
          - Friday
          - Saturday
        workingDay:
          type:
          - string
          - 'null'
          description: Which working day the schedule will run on (required when NthWorkingDay is selected).
          enum:
          - First
          - Last
        calendarId:
          type:
          - integer
          - 'null'
          description: The ID of the calendar to use (required when NthWorkingDay is selected).
    LessThanOrEqualToFilter:
      description: Used to filter values. Check for values that are less than or equal to the given value.
      type: object
      properties:
        lte:
          type:
          - object
          - 'null'
          description: The value that the field should be less than or equal to.
      example:
        lte: null
    EqualsFilter:
      description: Used to filter values. Check for values that are equal to the given value.
      type: object
      properties:
        eq:
          type:
          - object
          - 'null'
          description: The value that the field should be equal to.
      example:
        eq: null
    RadioButtonsArray:
      description: Used for the RadioButtons data type.
      type: array
      items:
        type: object
        properties:
          name:
            type: string
          selected:
            type: boolean
    ScheduleItemsPage:
      description: Contains details of a page of schedules.
      type: object
      properties:
        pagingToken:
          type: string
          description: The token to be used in the next request to return the next collection of items.
        items:
          type: array
          description: A collection of schedule summary.
          items:
            $ref: '#/components/schemas/ScheduleSummary'
      example:
        pagingToken: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
        items:
        - id: 123
          name: Example schedule
          description: A schedule for API example purposes.
          initialTaskId: 4
          isRetired: false
          tasksCount: 3
          intervalType: Hour
          timePeriod: 2
          startPoint: '0001-01-01T09:00:00+01:00'
          endPoint: '0001-01-01T17:30:00+01:00'
          dayOfWeek: Tuesday
          dayOfMonth: First
          startDate: '2020-10-02T00:00:00Z'
          endDate: '2020-10-03T02:20:00Z'
          calendarId: 1
          calendarName: Example calendar name
    RangeFilter:
      description: Used to filter values. Check for values that are greater than or equal to, less than or equal to, or between the given value(s).
      type: object
      anyOf:
      - $ref: '#/components/schemas/GreaterThanOrEqualToFilter'
      - $ref: '#/components/schemas/LessThanOrEqualToFilter'
      example:
        gte: null
        lte: null
    ScheduleLogDeprecatedSummary:
      description: Contains basic details about a schedule log.
      type: object
      properties:
        scheduleLogId:
          type: integer
          description: The ID of the schedule log.
        startTime:
          type: string
          format: date-time
          description: The start time of the schedule.
        endTime:
          type: string
          format: date-time
          description: The end time of the schedule.
        status:
          type: string
          description: The current status of the schedule.
          enum:
          - pending
          - running
          - terminated
          - completed
          - partExceptioned
        serverName:
          type: string
          description: The name of the application server this schedule instance ran on.
        scheduleId:
          type: integer
          description: The ID of the schedule.
        scheduleName:
          type: string
          description: The name of the schedule.
    ScheduleDetailsOptionalName:
      description: Contains the details of a schedule.
      allOf:
      - type: object
        properties:
          name:
            type: string
            description: The name of the schedule.
      - $ref: '#/components/schemas/ScheduleDetails'
    ScheduleSummary:
      description: Contains basic details of a session.
      type: object
      properties:
        id:
          type: integer
          description: The ID of the schedule.
        name:
          type: string
          description: The name of the schedule.
        description:
          type: string
          description: The description of the schedule.
        initialTaskId:
          type: integer
          description: The ID of the initial task this schedule executes.
        isRetired:
          type: boolean
          description: If the schedule is retired or not.
        tasksCount:
          type: integer
          description: The number of tasks a schedule has.
        intervalType:
          type: string
          description: The type of interval the schedule runs at.
          enum:
          - Once
          - Minute
          - Hour
          - Day
          - Week
          - Month
          - Year
        timePeriod:
          type: integer
          description: The time period to apply to the intervalType on which the schedule will run. This cannot be applied to an intervalType of "Once". For example, timePeriod "2" with intervalType "Day" will run the schedule every 2 days.
        startPoint:
          type: string
          description: The earliest time from which a schedule will run when the intervalType is set to "Day".
          format: date-time
        endPoint:
          type: string
          description: The latest time from which a schedule will run when the intervalType is set to "Day".
          format: date-time
        dayOfWeek:
          type:
          - string
          - 'null'
          description: The day of the week that the schedule will run on when intervalType is "Week" or "Month".
          enum:
          - Sunday
          - Monday
          - Tuesday
          - Wednesday
          - Thursday
          - Friday
          - Saturday
        dayOfMonth:
          type: string
          description: The position of the specified day in the month on which a schedule will run. This should be combined with the dayOfWeek value. For example, the "Second Monday" in the month, or the "Third Friday" in the month.
          enum:
          - Last
          - None
          - First
          - Second
          - Third
          - Fourth
          - Fifth
        startDate:
          type:
          - string
          - 'null'
          description: The earliest date the schedule will run.
          format: date-time
        endDate:
          type:
          - string
          - 'null'
          description: The last date on which the schedule will run. If this value is null or missing, the schedule will run indefinitely.
          format: date-time
        calendarId:
          type: integer
          description: The ID of the calendar.
        calendarName:
          type: string
          description: The name of the calendar.
      example:
        id: 123
        name: Example schedule
        description: A schedule for API example purposes.
        initialTaskId: 4
        isRetired: false
        tasksCount: 3
        intervalType: Hour
        timePeriod: 2
        startPoint: '0001-01-01T09:00:00+01:00'
        endPoint: '0001-01-01T17:30:00+01:00'
        dayOfWeek: Tuesday
        dayOfMonth: First
        startDate: '2020-10-02T00:00:00Z'
        endDate: '2020-10-03T02:20:00Z'
        calendarId: 1
        calendarName: Example calendar name
    DailyDetails:
      description: Daily details that apply to the daily interval schedule type.
      type: object
      properties:
        period:
          type: integer
          description: The schedule frequency.
        calendarId:
          type:
          - integer
          - 'null'
          description: The ID of the calendar to use.
  examples:
    StringGreaterThanExample:
      value:
        gte: Example
      summary: Search for a value alphanumerically after or equal to "Example".
    DateTimeEqualsExample:
      value:
        eq: '2020-10-02T12:34:56+01:00'
      summary: Search for a value equal to 2020-10-02 at 12:34:56 (GMT+1).
    StringStartsWithExample:
      value:
        strtw: Exa
      summary: Search a value starting with "Exa".
    DateTimeRangeExample:
      value:
        gte: '2020-10-02T12:34:56+01:00'
        lte: '2020-11-02T12:34:56+01:00'
      summary: 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).
    StringEqualsExample:
      value:
        eq: Example
      summary: Search for a value equal to "Example".
    DateTimeGreaterThanExample:
      value:
        gte: '2020-10-02T12:34:56+01:00'
      summary: Search for a value after or equal to 2020-10-02 at 12:34:56 (GMT+1).
    StringRangeExample:
      value:
        gte: Ex
        lte: F
      summary: Search for a value alphanumerically between "Ex" and "F".
  responses:
    Conflict:
      description: The request conflicts with the current state of the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    NotAuthorized:
      description: The authentication token was either missing or invalid and must be refreshed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    BadRequestErrorMessage:
      description: The request is malformed or contains incorrect information. See the response for more details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    Forbidden:
      description: The authentication token does not give sufficient permissions to perform this action.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    BadRequest:
      description: The request is malformed or contains incorrect information. See the response for more details.
      content:
        application/json:
          schema:
            oneOf:
            - $ref: '#/components/schemas/UrlParameterError'
            - $ref: '#/components/schemas/ValidationError'
    NotFound:
      description: The requested resource could not be found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      description: JWT token issued from Authentication Server.
      bearerFormat: JWT
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth-server/connect/token
          scopes:
            bp-api: API scope
            bpserver: Blue Prism Application scope