openapi: 3.0.3
info:
  title: Blue Prism API
  description: An API to expose core functionality of the Blue Prism product.
  version: 7.5.1
servers:
- url: https://{address}
  description: 'Customer-hosted Blue Prism API instance. Blue Prism Enterprise is self-hosted: the API ships as an IIS site
    installed on the customer''s own web server, so the host is environment-specific. Documented base URL format: http(s)://<address>/api/v7
    (https://documentation.blueprism.com/bp-7-5/en-us/bp-api/api-example-usage.htm).'
  variables:
    address:
      default: bpapi.example.com
      description: Host name of the web server where the Blue Prism API is installed.
security:
- Bearer:
  - bp-api
  - bpserver
- OAuth2:
  - bp-api
  - bpserver
paths:
  /api/v7/calendars:
    get:
      summary: Return a list of calendars.
      description: '### Permissions required: `System - Calendar permission`

        '
      operationId: getCalendars
      tags:
      - Calendars
      parameters:
      - name: sortBy
        description: The field that results should be sorted by and the direction they should be sorted in.
        in: query
        schema:
          type: string
          enum:
          - IdAsc
          - IdDesc
          - NameAsc
          - NameDesc
          - RegionIdAsc
          - RegionIdDesc
      - name: id
        description: A filter to search for calendar id.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: name
        description: A filter to search for the name of the calendar.
        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: region
        description: A filter to search for the region id.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: workingWeek
        in: query
        style: form
        explode: false
        description: The working week to search for.
        schema:
          type: array
          items:
            type: string
            enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
      responses:
        '200':
          description: A list calendars was successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Calendar'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      summary: Creates a Calendar.
      description: '> ### Permissions required: `System - Calendars`

        '
      tags:
      - Calendars
      requestBody:
        description: Details of the calendar to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCalendarModel'
      responses:
        '201':
          description: The calendar was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCalendarResponseModel'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/calendars/{calendarId}:
    get:
      summary: Returns a calendar by Id
      description: '### Permissions required: `System - Calendar permission`

        '
      tags:
      - Calendars
      parameters:
      - name: calendarId
        in: path
        description: The ID of the calendar to get.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A calendar was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Calendar'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      summary: Deletes a specified calendar.
      description: '### Permissions required: `System - Calendar permission`

        '
      tags:
      - Calendars
      parameters:
      - name: calendarId
        in: path
        description: The ID of the calendar to delete.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: The calendar was successfully deleted.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
    patch:
      summary: Update a calendar by Id
      operationId: updateCalendar
      description: '>  ### Permissions required: `System - Calendar permission`

        '
      tags:
      - Calendars
      parameters:
      - name: calendarId
        in: path
        required: true
        description: The ID of the Calendar to update.
        schema:
          type: integer
          format: int32
      requestBody:
        description: Details of the calendar to update.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchRequest'
            examples:
              add (to array):
                $ref: '#/components/examples/PatchAddToArrayExample'
              add (to object):
                $ref: '#/components/examples/PatchAddToObjectExample'
              copy:
                $ref: '#/components/examples/PatchCopyExample'
              move:
                $ref: '#/components/examples/PatchMoveExample'
              remove:
                $ref: '#/components/examples/PatchRemoveExample'
              replace:
                $ref: '#/components/examples/PatchReplaceExample'
      responses:
        '204':
          description: The calendar 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/calendars/{calendarId}/clones:
    post:
      summary: Clones a calendar by Id
      description: '### Permissions required: `System - Calendar permission`

        '
      tags:
      - Calendars
      parameters:
      - name: calendarId
        in: path
        description: The ID of the calendar to clone.
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: Details of the calendar to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneCalendarModel'
      responses:
        '201':
          description: The calendar was successfully cloned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCalendarResponseModel'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/calendars/{calendarId}/otherHolidays:
    get:
      summary: Returns calendar other holidays by calendar Id
      description: '### Permissions required: `System - Calendar permission`

        '
      tags:
      - Calendars
      parameters:
      - name: calendarId
        in: path
        description: The ID of the calendar used to get other holidays.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The calendar other holidays were successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
              example:
              - '2021-01-04'
              - '2021-10-25'
              - '2022-03-05'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/calendars/{calendarId}/otherHolidays/batch:
    delete:
      summary: Deletes other holidays in calendar.
      description: '### Permissions required: `System - Calendar permission`

        '
      tags:
      - Calendars
      parameters:
      - name: calendarId
        in: path
        description: The ID of the calendar used to remove other holidays.
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: The list of other holidays to delete.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OtherHolydaysModel'
      responses:
        '204':
          description: Other holidays were successfully deleted.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      summary: Creates other holidays in calendar.
      description: '### Permissions required: `System - Calendar permission`

        '
      tags:
      - Calendars
      parameters:
      - name: calendarId
        in: path
        description: The ID of the calendar used to add other holidays.
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: The list of other holidays to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OtherHolydaysModel'
      responses:
        '204':
          description: Other holidays were successfully created.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/calendars/{calendarId}/references:
    get:
      summary: Returns a list of process that reference a given calendar.
      description: ''
      tags:
      - Calendars
      parameters:
      - name: calendarId
        in: path
        description: The ID of the calendar to find references for.
        required: true
        schema:
          type: integer
          format: int32
      - name: sortBy
        description: The field that results should be sorted by and the direction they should be sorted in.
        in: query
        schema:
          type: string
          enum:
          - NameAsc
          - NameDesc
          - DescriptionAsc
          - DescriptionDesc
          - ProcessTypeAsc
          - ProcessTypeDesc
      - name: itemsPerPage
        description: The maximum number of items to retrieve.
        in: query
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      - name: name
        description: A filter to search for the name of the reference.
        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: description
        in: query
        style: deepObject
        description: A filter to search for the description of the reference.
        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: processType
        in: query
        style: form
        explode: false
        description: The type of the process to search for.
        schema:
          type: array
          items:
            type: string
            enum:
            - Process
            - Object
      responses:
        '200':
          description: A list of Calendar references were succesfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferencesItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/dashboards/workQueueCompositions:
    get:
      summary: Return aggregate work queue data for each of the requested queues.
      operationId: getWorkQueueData
      tags:
      - Dashboards
      parameters:
      - name: workQueueIds
        in: query
        description: Array of work queue IDs to retrieve data for.
        required: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: A list of work queue composition details was successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkQueueComposition'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/dashboards/resourceUtilization:
    get:
      summary: Return runtime resource utilization.
      operationId: getResourceUtilization
      tags:
      - Dashboards
      parameters:
      - name: startDate
        in: query
        required: true
        description: The start date.
        schema:
          type: string
          format: date-time
      - name: resourceIds
        in: query
        description: Array of resource IDs to filter on.
        schema:
          type: array
          items:
            type: string
            format: uuid
      - name: pageNumber
        in: query
        description: Page number parameter used for data paging of utilization heat map.
        schema:
          type: integer
      - name: pageSize
        in: query
        description: Page size parameter used for data paging of utilization heat map.
        schema:
          type: integer
      responses:
        '200':
          description: A list of resource utilization details was successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResourceUtilization'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/dashboards/resourcesSummaryUtilization:
    get:
      summary: Return runtime resources summary utilization by date range.
      operationId: getResourceSummaryUtilizationByDate
      tags:
      - Dashboards
      parameters:
      - name: startDate
        in: query
        required: true
        description: The start date.
        schema:
          type: string
          format: date-time
      - name: endDate
        in: query
        required: true
        description: The end date.
        schema:
          type: string
          format: date-time
      - name: resourceIds
        in: query
        description: Resource IDs to filter on.
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: A list of resource utilization by date range was successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResourcesSummaryUtilization'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/dashboards/licensesEntitlement:
    get:
      summary: Return aggregated licenses entitlement data.
      description: '> ### Permissions required: `System - License permission`

        '
      tags:
      - Dashboards
      responses:
        '200':
          description: An aggregated licenses entitlement data was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicensesEntitlement'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/dashboards/currentLimitsAndUsage:
    get:
      summary: Return current active licenses limits and usages.
      operationId: getLicenseLimits
      description: '> ### Permissions required

        At least one of: `View Resource Screen Capture` | `View Resource`

        | `Control Resource` | `Configure Resource` <br>

        And at least one of: `Audit Alerts` | `Subscribe To Process Alerts`

        | `Configure Process Alerts`

        '
      tags:
      - Dashboards
      responses:
        '200':
          description: Details of current active licenses limits and usages was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseUsageDetailsModel'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/encryptionschemes:
    get:
      summary: Return a list of encryption schemes in the environment.
      operationId: getEncryptionSchemes
      description: '> ### Permissions required: `Security - View Encryption Scheme Configuration`

        '
      tags:
      - Encryption Schemes
      responses:
        '200':
          description: A list of encryption schemes was successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EncryptionScheme'
  /api/v7/environmentvariables:
    get:
      summary: Return a list of environment variables.
      operationId: getEnvironmentVariables
      description: '> ### Permissions required

        At least one of: `Business Objects - View Environment Variables` | `Business Objects -  Configure Environment Variables`

        | `Processes - View Environment Variables` | `Processes - Configure Environment Variables`

        '
      tags:
      - Environment Variables
      parameters:
      - name: sortBy
        description: The field that results should be sorted by and the direction they should be sorted in.
        in: query
        schema:
          type: string
          enum:
          - NameAsc
          - NameDesc
          - DescriptionAsc
          - DescriptionDesc
          - DataTypeAsc
          - DataTypeDesc
      - name: itemsPerPage
        description: The maximum number of items to retrieve.
        in: query
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      - name: name
        description: A filter to search for the name of the environment variable.
        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: description
        in: query
        style: deepObject
        description: A filter to search for the description of the environment variable.
        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: dataType
        in: query
        style: form
        explode: false
        description: The type of the environment variable to search for.
        schema:
          type: array
          items:
            type: string
            enum:
            - Binary
            - Date
            - DateTime
            - Flag
            - Image
            - Number
            - Password
            - RadioButtons
            - Text
            - Time
            - TimeSpan
      responses:
        '200':
          description: A list of environment variables was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariableItemsPage'
              examples:
                text:
                  $ref: '#/components/examples/EnvironmentVariableTextExample'
                radiobuttons:
                  $ref: '#/components/examples/EnvironmentVariableRadioButtonsExample'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      summary: Creates an Environment Variable.
      operationId: createEnvironmentVariable
      description: '> ### Permissions required: `Business Objects - Configure Environment Variables`, `Process - Configure
        Environment Variables`

        '
      tags:
      - Environment Variables
      requestBody:
        description: Details of the environment variable to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEnvironmentVariableModel'
      responses:
        '201':
          description: The environment variable was successfully created.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/environmentvariables/{environmentVariableId}/references:
    get:
      summary: Return references to a specified environment variable.
      operationId: getEnvironmentVariableReferences
      description: '> ### Permissions required:

        At least one of: `Business Objects - Configure Environment Variables`, `Processes - Configure Environment Variables`

        '
      tags:
      - Environment Variables
      parameters:
      - name: environmentVariableId
        in: path
        description: The id of the environment variable.
        required: true
        schema:
          type: string
          format: uuid
      - name: sortBy
        description: The field that results should be sorted by and the direction they should be sorted in.
        in: query
        schema:
          type: string
          enum:
          - NameAsc
          - NameDesc
          - DescriptionAsc
          - DescriptionDesc
          - ProcessTypeAsc
          - ProcessTypeDesc
      - name: itemsPerPage
        description: The maximum number of items to retrieve.
        in: query
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      - name: name
        description: A filter to search for the name of the environment variable.
        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: description
        in: query
        style: deepObject
        description: A filter to search for the description of the environment variable reference.
        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: processType
        description: A filter to search for the references by process type.
        in: query
        schema:
          $ref: '#/components/schemas/ProcessType'
      responses:
        '200':
          description: A list of environment variables references was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariableReferencesItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/environmentvariables/{environmentVariableId}:
    delete:
      summary: Delete environment variable by ID.
      operationId: deleteEnvironmentVariable
      description: '> ### Permissions required: `Business Objects - Configure Environment Variables` or `Processes - Configure
        Environment Variables`

        '
      tags:
      - Environment Variables
      parameters:
      - name: environmentVariableId
        in: path
        description: The id of the environment variable.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Environment variable was successfuly deleted
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      summary: Updates the Environment Variable by ID.
      operationId: updateEnvironmentVariable
      description: '> ### Permissions required: `Business Objects - Configure Environment Variables` Or `Processes - Configure
        Environment Variables`

        '
      tags:
      - Environment Variables
      parameters:
      - name: environmentVariableId
        in: path
        required: true
        description: The id of the environment variable to update.
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchRequest'
            examples:
              add (to array):
                $ref: '#/components/examples/PatchAddToArrayExample'
              add (to object):
                $ref: '#/components/examples/PatchAddToObjectExample'
              copy:
                $ref: '#/components/examples/PatchCopyExample'
              move:
                $ref: '#/components/examples/PatchMoveExample'
              remove:
                $ref: '#/components/examples/PatchRemoveExample'
              replace:
                $ref: '#/components/examples/PatchReplaceExample'
      responses:
        '204':
          description: The environment variable 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/health:
    get:
      summary: Return health of API.
      tags:
      - Health
      responses:
        '200':
          description: Health of API was retrieved with OK health.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
        '503':
          description: Health of API was retrieved with Service Unavailable health.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
              example:
                healthy: false
                dependencies:
                - name: databse
                  healthy: false
  /api/v7/holidayRegions:
    get:
      summary: Return a list of holiday regions.
      description: '### Permissions required: `System - Calendars permission`

        '
      operationId: getHolidayRegions
      tags:
      - Calendars
      responses:
        '200':
          description: A list of holiday regions was successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HolidayRegion'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/holidayRegions/{holidayRegionId}/publicHolidays:
    get:
      summary: Return a list of holiday by region id.
      description: '### Permissions required: `System - Calendars permission`

        '
      operationId: getHolidayByRegionId
      tags:
      - Calendars
      parameters:
      - name: holidayRegionId
        in: path
        description: The ID of the holiday region.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A list of holiday by region id was successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HolidayByRegionId'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/processes:
    get:
      summary: Return a list of all the processes in the environment.
      operationId: GetProcesses
      description: '> ### 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`

        '
      tags:
      - Processes
      parameters:
      - name: processName
        description: A filter to search for the name of the process.
        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: description
        description: A filter to search for the description of the process.
        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: groupName
        description: A filter to search for the group name of the process.
        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: attributesInclude
        in: query
        description: A filter to search for attributes to be included.
        style: form
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ProcessAttributeFilter'
      - name: attributesExclude
        in: query
        description: A filter to search for attributes to be excluded.
        style: form
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ProcessAttributeFilter'
      - name: sortBy
        in: query
        description: The field that results should be sorted by and the direction they should be sorted in.
        schema:
          type: string
          title: getProcessSortBy
          enum:
          - NameAsc
          - NameDesc
          - DescriptionAsc
          - DescriptionDesc
          - GroupAsc
          - GroupDesc
      - 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: An array of processes summaries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/processgroups/root/descendants:
    get:
      summary: Return a list of all the processes / process groups in the process group tree.
      operationId: getAllProcessGroupItems
      description: '> ### 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`

        '
      tags:
      - Processes
      parameters:
      - name: name
        in: query
        description: A filter to search for the name of the process / group.
        style: deepObject
        required: false
        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: sortBy
        in: query
        description: The field that results should be sorted by and the direction they should be sorted in.
        required: false
        schema:
          title: getAllProcessGroupItemsSortBy
          type: string
          enum:
          - NameAsc
          - NameDesc
      - name: itemsPerPage
        in: query
        description: The maximum number of items to retrieve per page.
        required: false
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        in: query
        description: The token to point to the last item previously returned.
        required: false
        schema:
          type: string
      - name: attributesInclude
        in: query
        description: A filter to search for attributes to be included.
        style: form
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ProcessAttributeFilter'
      - name: attributesExclude
        in: query
        description: A filter to search for attributes to be excluded.
        style: form
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ProcessAttributeFilter'
      responses:
        '200':
          description: An array of process / process group summaries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessGroupItemItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/resources:
    get:
      summary: Return a list of resources in the environment.
      operationId: getResources
      description: '> ### Permissions required

        At least one of: `View Resource` | `View Resource Screen Captures` | `Configure Resource`

        | `Control Resource` | `Manage Resource Access Rights` | `View Resource Details`

        '
      tags:
      - Resources
      parameters:
      - name: name
        description: A filter to search for the name of the resource.
        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: groupName
        description: A filter to search for the group name of the resource.
        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: poolName
        description: A filter to search for the pool name of the resource.
        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: activeSessionCount
        description: A filter to search for resource's active session count.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: pendingSessionCount
        description: A filter to search for resource's pending session count.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: displayStatus
        description: A filter to search for the current status of the resource.
        in: query
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - Working
            - Idle
            - Warning
            - Offline
            - Missing
            - LoggedOut
            - Private
            - Details
            - BPD
            - Hybrid
      - name: retirementFilter
        description: A filter to search for the retirement status of the resource. The default behavior is to search for non-retired
          resources.
        in: query
        schema:
          type: string
          enum:
          - NonRetired
          - Retired
          - All
      - name: resourceType
        description: A filter to search for the resource type.
        in: query
        schema:
          type: string
          enum:
          - Enterprise
          - Desktop
          - RemoteDigitalWorker
      - name: includeResourcePools
        description: Includes resource pools in the results.
        in: query
        schema:
          type: boolean
      - name: sortBy
        description: The field that results should be sorted by and the direction they should be sorted in.
        in: query
        schema:
          type: string
          enum:
          - NameAsc
          - NameDesc
          - PoolAsc
          - PoolDesc
          - GroupAsc
          - GroupDesc
          - PendingAsc
          - PendingDesc
          - ActiveAsc
          - ActiveDesc
          - DisplayStatusAsc
          - DisplayStatusDesc
      - name: itemsPerPage
        in: query
        description: The maximum number of items to retrieve per page.
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        nullable: true
        in: query
        description: The token to point to the last item previously returned.
        schema:
          type: string
      responses:
        '200':
          description: An array of resource summaries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/resources/{resourceId}:
    put:
      operationId: updateResource
      summary: Retire or unretire a resource with the given ID.
      description: '> ### Permissions required: `Configure Resource`

        '
      tags:
      - Resources
      parameters:
      - name: resourceId
        in: path
        description: The ID of the resource or pool.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        description: '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.

          '
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateResource'
      responses:
        '204':
          description: The resource has been successfully updated.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: The resource could not be updated. See errorMessage for more details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v7/resources/pools:
    get:
      summary: Return a list of resource pools.
      operationId: getResourcePools
      description: '> ### Permissions required

        At least one of: `View Resource` | `View Resource Screen Captures` | `Configure Resource`

        | `Control Resource` | `Manage Resource Access Rights` | `View Resource Details`

        '
      tags:
      - Pools
      responses:
        '200':
          description: A list pools was successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResourcePool'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /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`<br><br>

        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`<br><br>

        For retiring all of the following: `Edit Schedule` | `Retire Schedule`<br><br>

        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`<br><br>

        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\n`Create Schedule` and  `Edit Schedule` \n"
      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`<br><br>

        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`<br><br>

        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`<br><br>

        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'
  /api/v7/scheduleLogs:
    get:
      summary: Return all schedule logs.
      operationId: getScheduleLogs
      description: '> ### Permissions required

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

        | `Create Schedule` | `Retire Schedule` | `System - Scheduler`

        '
      tags:
      - ScheduleLogs
      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
          - DurationAsc
          - DurationDesc
      - 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: duration
        description: A filter to search for the schedules duration.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/TimeEqualsExample'
          range:
            $ref: '#/components/examples/TimeRangeExample'
          greater:
            $ref: '#/components/examples/TimeLessThanExample'
      - 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/ScheduleLogItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/scheduleLogs/{scheduleId}:
    get:
      summary: Return all logs for a specified schedule.
      operationId: getScheduleLogsById
      description: '> ### Permissions required

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

        | `Create Schedule` | `Retire Schedule` | `System - Scheduler`

        '
      tags:
      - ScheduleLogs
      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
          - ServerNameAsc
          - ServerNameDesc
          - StartTimeAsc
          - StartTimeDesc
          - StatusAsc
          - StatusDesc
          - DurationAsc
          - DurationDesc
      - 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: duration
        description: A filter to search for the schedules duration.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/TimeEqualsExample'
          range:
            $ref: '#/components/examples/TimeRangeExample'
          greater:
            $ref: '#/components/examples/TimeLessThanExample'
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      - 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/ScheduleLogItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/sessions:
    get:
      summary: Return a list of sessions in the environment.
      operationId: GetSessions
      description: '> ### 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`<br><br>

        And at least one of: `View Resource` | `View Resource Screen Captures` | `Configure Resource`

        | `Control Resource` | `Manage Resource Access Rights`

        '
      tags:
      - Sessions
      parameters:
      - name: sortBy
        description: The field that results should be sorted by and the direction they should be sorted in.
        in: query
        required: false
        style: form
        explode: false
        schema:
          title: getSessionsSortBy
          type: string
          enum:
          - SessionNumberAsc
          - SessionNumberDesc
          - ProcessNameAsc
          - ProcessNameDesc
          - ResourceNameAsc
          - ResourceNameDesc
          - UserNameAsc
          - UserNameDesc
          - StatusAsc
          - StatusDesc
          - ExceptionTypeAsc
          - ExceptionTypeDesc
          - StartTimeAsc
          - StartTimeDesc
          - EndTimeAsc
          - EndTimeDesc
          - LatestStageAsc
          - LatestStageDesc
          - StageStartedAsc
          - StageStartedDesc
      - name: itemsPerPage
        description: The maximum number of items to retrieve.
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        required: false
        schema:
          type: string
      - name: processName
        description: A filter to search for the name of the process being run by the session.
        in: query
        style: deepObject
        required: false
        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: sessionNumber
        description: A filter to search for the session number.
        style: deepObject
        required: false
        in: query
        schema:
          $ref: '#/components/schemas/BasicNumericFilter'
        examples:
          startsWith:
            $ref: '#/components/examples/IntegerStartsWithExample'
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          greater:
            $ref: '#/components/examples/IntegerGreaterThanExample'
      - name: resourceName
        description: A filter to search for the name of the resource on which the session is running/ran.
        in: query
        required: false
        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: userName
        description: A filter to search for the name of the user that triggered the session.
        in: query
        required: false
        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: status
        description: The status of the sessions to search for.
        in: query
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/SessionStatus'
      - name: sessionSource
        description: The source of the sessions to search for.
        in: query
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/SessionSource'
      - name: startTime
        description: A filter to search for the time that the session started.
        in: query
        style: deepObject
        required: false
        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 time that the session ended.
        in: query
        style: deepObject
        schema:
          nullable: true
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: latestStage
        description: A filter to search for the name of the latest stage.
        in: query
        style: deepObject
        schema:
          nullable: true
          $ref: '#/components/schemas/BasicStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: stageStarted
        description: A filter to search for the time when the latest stage started.
        in: query
        style: deepObject
        schema:
          nullable: true
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: onlySessionsForCurrentUser
        description: Flag to restrict sessions to API user.
        in: query
        schema:
          nullable: true
          type: boolean
      - name: processId.eq
        description: The ID of the process to retrieve data for.
        in: query
        required: false
        schema:
          nullable: true
          type: string
          format: uuid
      responses:
        '200':
          description: An array of session summaries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      summary: Create a new session for the given resource ID and process ID.
      operationId: createSession
      description: '> ### Permissions required

        At least one of: `Create Process` | `Edit Process` | `Execute Process`<br><br>

        and `Control Resource`

        '
      tags:
      - Sessions
      requestBody:
        description: Parameters to create a new session
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSessionParameters'
      responses:
        '200':
          description: A newly created session ID.
          content:
            application/json:
              schema:
                type: string
                format: uuid
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/sessions/{sessionId}:
    get:
      summary: Return details of a specified session.
      operationId: getSession
      description: '> ### 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`<br><br>

        And at least one of: `View Resource` | `View Resource Screen Captures` | `Configure Resource`

        | `Control Resource` | `Manage Resource Access Rights`

        '
      tags:
      - Sessions
      parameters:
      - name: sessionId
        in: path
        description: The ID of the session to retrieve data for.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The session was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionSummary'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFoundSession'
    delete:
      summary: Deletes a specified pending session.
      operationId: deleteSession
      description: "> ### Permissions required\n `Control Resource` <br><br>\n  And at least one of: `View Process Definition`\
        \ | `Edit Process` | `Create Process`\n"
      tags:
      - Sessions
      parameters:
      - name: sessionId
        in: path
        description: The ID of the pending session to delete.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: The pending session was successfully deleted.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      summary: Update the session for the given session ID.
      operationId: updateSession
      description: '> ### Permissions required

        At least one of: `Create Process` | `Edit Process` | `Execute Process`<br><br>

        and `Control Resource`

        '
      tags:
      - Sessions
      parameters:
      - name: sessionId
        in: path
        description: The ID of the session to update.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Details of the session to update, only supports 'Running', 'Stopping' and 'Stopped' statuses.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSession'
      responses:
        '202':
          description: The session has been successfully updated.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/SessionForbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
  /api/v7/sessions/{sessionId}/parameters:
    get:
      summary: Get start-up parameters for a specified session.
      operationId: getSessionStartUpParameters
      description: '> ### Permissions required

        At least one of: `Create Process` | `Edit Process` | `Export Process`

        | `Execute Process` | `View Process Definition`<br><br>

        And at least one of: `View Resource` | `View Resource Screen Captures` | `Configure Resource`

        | `Control Resource` | `Manage Resource Access Rights`

        '
      tags:
      - Sessions
      parameters:
      - name: sessionId
        in: path
        description: The ID of the session to retrieve start-up parameters for.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Start-up parameters of the requested session were successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionStartUpParameters'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      summary: Update start-up parameters for a specified session.
      operationId: updateSessionStartupParameters
      description: '> ### Permissions required

        At least one of: `Create Process` | `Edit Process` | `Execute Process`<br><br>

        and `Control Resource`

        '
      tags:
      - Sessions
      parameters:
      - name: sessionId
        in: path
        description: The ID of the session to update start-up parameters for.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: A start-up parameters for session.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionStartUpParameters'
      responses:
        '204':
          description: Associated parameters for a specific session were successfully updated.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
  /api/v7/sessions/{sessionId}/logs:
    get:
      summary: Return all logs for a specified session.
      operationId: getSessionLogs
      description: '> ### 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`<br><br>

        And at least one of: `View Resource` | `View Resource Screen Captures`

        | `Configure Resource` | `Control Resource` | `Manage Resource Access Rights`<br><br>

        and `Audit - Process Logs`

        '
      tags:
      - Sessions
      parameters:
      - name: sessionId
        in: path
        description: The ID of the session to retrieve data for.
        required: true
        schema:
          type: string
          format: uuid
      - name: sortBy
        in: query
        description: The field that results should be sorted by and the direction they should be sorted in.
        required: false
        style: form
        explode: false
        schema:
          title: getSessionLogsSortBy
          type: string
          enum:
          - LogNumberAsc
          - LogNumberDesc
          - StageIdAsc
          - StageIdDesc
          - StageNameAsc
          - StageNameDesc
          - StageTypeAsc
          - StageTypeDesc
          - ProcessNameAsc
          - ProcessNameDesc
          - PageNameAsc
          - PageNameDesc
          - ObjectNameAsc
          - ObjectNameDesc
          - ActionNameAsc
          - ActionNameDesc
          - ResultAsc
          - ResultDesc
          - ResultTypeAsc
          - ResultTypeDesc
          - ResourceStartTimeAsc
          - ResourceStartTimeDesc
          - ResourceEndTimeAsc
          - ResourceEndTimeDesc
          - BluePrismMemoryAsc
          - BluePrismMemoryDesc
          - TargetAppIdAsc
          - TargetAppIdDesc
          - TargetMemoryAsc
          - TargetMemoryDesc
      - name: logNumber
        in: query
        description: A filter to search for the log id/number.
        style: deepObject
        required: false
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: stageId
        in: query
        description: A filter to search for the id of the stage.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/EqualsFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
      - name: stageName
        in: query
        description: A filter to search for the name of the stage.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: stageType
        in: query
        description: A filter to search for the type of the stage.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/StageType'
      - name: processName
        in: query
        description: A filter to search for the name of the process.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: pageName
        in: query
        description: A filter to search for the name of the page.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: objectName
        in: query
        description: A filter to search for the name of the object.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: actionName
        in: query
        description: A filter to search for the name of the action.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: result
        in: query
        description: A filter to search for the result.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: resultType
        in: query
        description: A filter to search for the type of the result.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ResultType'
      - name: resourceStartTime
        description: A filter to search for the time that the session started.
        in: query
        style: deepObject
        required: false
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: resourceEndTime
        description: A filter to search for the time that the ended started.
        in: query
        style: deepObject
        required: false
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: bluePrismMemory
        in: query
        description: A filter to search for the blue prism memory.
        style: deepObject
        required: false
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: targetAppId
        in: query
        description: A filter to search for the target app id.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: targetMemory
        in: query
        description: A filter to search for the target memory.
        style: deepObject
        required: false
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - 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 session logs was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionLogsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/sessions/{sessionId}/logslight:
    get:
      summary: Return fewer logs fields (logid,startdatetime,starttimezoneoffset,stagetype,objectname,actionname,processname,pagename,stagename,result,resulttype,attributexml
        and logNumber) for a specified session in apis calls.
      operationId: getSessionLogsLight
      description: '> ### 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`<br><br>

        And at least one of: `View Resource` | `View Resource Screen Captures`

        | `Configure Resource` | `Control Resource` | `Manage Resource Access Rights`<br><br>

        and `Audit - Process Logs`

        '
      tags:
      - Sessions
      parameters:
      - name: sessionId
        in: path
        description: The ID of the session to retrieve data for.
        required: true
        schema:
          type: string
          format: uuid
      - name: sortBy
        in: query
        description: The field that results should be sorted by and the direction they should be sorted in.
        required: false
        style: form
        explode: false
        schema:
          title: getSessionLogsSortBy
          type: string
          enum:
          - LogNumberAsc
          - LogNumberDesc
          - StageIdAsc
          - StageIdDesc
          - StageNameAsc
          - StageNameDesc
          - StageTypeAsc
          - StageTypeDesc
          - ProcessNameAsc
          - ProcessNameDesc
          - PageNameAsc
          - PageNameDesc
          - ObjectNameAsc
          - ObjectNameDesc
          - ActionNameAsc
          - ActionNameDesc
          - ResultAsc
          - ResultDesc
          - ResultTypeAsc
          - ResultTypeDesc
          - ResourceStartTimeAsc
          - ResourceStartTimeDesc
          - ResourceEndTimeAsc
          - ResourceEndTimeDesc
          - BluePrismMemoryAsc
          - BluePrismMemoryDesc
          - TargetAppIdAsc
          - TargetAppIdDesc
          - TargetMemoryAsc
          - TargetMemoryDesc
      - name: logNumber
        in: query
        description: A filter to search for the log id/number.
        style: deepObject
        required: false
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: stageId
        in: query
        description: A filter to search for the id of the stage.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/EqualsFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
      - name: stageName
        in: query
        description: A filter to search for the name of the stage.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: stageType
        in: query
        description: A filter to search for the type of the stage.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/StageType'
      - name: processName
        in: query
        description: A filter to search for the name of the process.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: pageName
        in: query
        description: A filter to search for the name of the page.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: objectName
        in: query
        description: A filter to search for the name of the object.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: actionName
        in: query
        description: A filter to search for the name of the action.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: result
        in: query
        description: A filter to search for the result.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: resultType
        in: query
        description: A filter to search for the type of the result.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ResultType'
      - name: resourceStartTime
        description: A filter to search for the time that the session started.
        in: query
        style: deepObject
        required: false
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: resourceEndTime
        description: A filter to search for the time that the ended started.
        in: query
        style: deepObject
        required: false
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: bluePrismMemory
        in: query
        description: A filter to search for the blue prism memory.
        style: deepObject
        required: false
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: targetAppId
        in: query
        description: A filter to search for the target app id.
        required: false
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: targetMemory
        in: query
        description: A filter to search for the target memory.
        style: deepObject
        required: false
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - 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 session logs was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionLogsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/sessions/{sessionId}/logs/{logId}/parameters:
    get:
      summary: Return all parameters for a specified session log.
      operationId: getSessionLogParameters
      description: '> ### 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`<br><br>

        And at least one of: `View Resource` | `View Resource Screen Captures`

        | `Configure Resource` | `Control Resource` | `Manage Resource Access Rights`<br><br>

        and `Audit - Process Logs`

        '
      tags:
      - Sessions
      parameters:
      - name: sessionId
        in: path
        description: The ID of the session to retrieve data for.
        required: true
        schema:
          type: string
          format: uuid
      - name: logId
        in: path
        description: The ID of the log to retrieve for the session.
        required: true
        schema:
          type: integer
          minimum: 1
      responses:
        '200':
          description: A list of session log parameters was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionLogParametersResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/subscriptions/{subscriptionId}:
    patch:
      summary: Update the subscription for the given subscription ID.
      operationId: updatesubscription
      description: '> ### Permissions required

        At least one of:  `Full Access to webhooks`

        '
      tags:
      - Subscriptions
      parameters:
      - name: subscriptionId
        in: path
        description: The ID of the subscription to update.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchRequest'
              examples: null
              replace:
                $ref: '#/components/examples/PatchReplaceExample'
      responses:
        '202':
          description: The session has been successfully updated.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/timezones:
    get:
      summary: Return a list of time zones.
      operationId: getTimezones
      tags:
      - Time Zones
      responses:
        '200':
          description: A list of time zones was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeZones'
        '401':
          $ref: '#/components/responses/NotAuthorized'
  /api/v7/user/permissions:
    get:
      summary: Return a list of permissions for the currently authenticated user.
      operationId: getPermissionsForUser
      tags:
      - User
      responses:
        '200':
          description: A list of user permissions was successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
              example:
              - Permission_1
              - Permission_2
              - Permission_3
        '401':
          $ref: '#/components/responses/NotAuthorized'
  /api/v7/workqueues:
    get:
      summary: Return a list of work queues in the environment.
      operationId: getWorkqueues
      description: '> ### Permissions required

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

        '
      tags:
      - Work Queues
      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:
          - NameAsc
          - NameDesc
          - StatusAsc
          - StatusDesc
          - KeyFieldAsc
          - KeyFieldDesc
          - MaxAttemptsAsc
          - MaxAttemptsDesc
          - IsEncryptedAsc
          - IsEncryptedDesc
          - TotalItemCountAsc
          - TotalItemCountDesc
          - CompletedItemCountAsc
          - CompletedItemCountDesc
          - PendingItemCountAsc
          - PendingItemCountDesc
          - LockedItemCountAsc
          - LockedItemCountDesc
          - ExceptionedItemCountAsc
          - ExceptionedItemCountDesc
          - TotalCaseDurationAsc
          - TotalCaseDurationDesc
          - AverageWorkTimeAsc
          - AverageWorkTimeDesc
      - name: name
        description: A filter to search for the name of the work queue.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: keyField
        description: A filter to search for the name of the work queue's key field.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: status.eq
        description: A filter to search for the current status of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/QueueStatus'
      - name: maxAttempts
        description: A filter to search for the configured maximum attempts of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: pendingItemCount
        description: A filter to search for the pending item count of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: lockedItemCount
        description: A filter to search for the locked item count of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: completedItemCount
        description: A filter to search for the completed item count of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: exceptionedItemCount
        description: A filter to search for the exceptioned item count of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: totalItemCount
        description: A filter to search for the total item count of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: averageWorkTime
        description: A filter to search for the average work time of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/TimeEqualsExample'
          range:
            $ref: '#/components/examples/TimeRangeExample'
          greater:
            $ref: '#/components/examples/TimeLessThanExample'
      - name: totalCaseDuration
        description: A filter to search for the total case duration of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/TimeEqualsExample'
          range:
            $ref: '#/components/examples/TimeRangeExample'
          greater:
            $ref: '#/components/examples/TimeLessThanExample'
      - name: itemsPerPage
        description: The maximum number of items to retrieve per page.
        in: query
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A list of work queue summaries was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkQueuesItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      summary: Create a new work queue.
      operationId: createWorkQueue
      description: '> ### Permissions required

        For creating work queue: `Workflow - Work Queue Configuration`<br>

        For creating active work queue: `Workflow - Work Queue Configuration` and `Control Resource` and at least one of:
        `Create Process` | `Edit Process` | `Execute Process`

        > This endpoint does not support application server-based encryption keys. Only database-based encryption keys can
        be used.

        '
      tags:
      - Work Queues
      requestBody:
        description: Details of the queue to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkQueue'
      responses:
        '201':
          description: The work queue was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Identifier'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: A work queue with this name already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v7/workqueues/light:
    get:
      summary: Return fewer information about work queue(all fields except work queue configuration and sessionexceptionretry).
      operationId: getWorkqueuesLight
      description: '> ### Permissions required

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

        '
      tags:
      - Work Queues
      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:
          - NameAsc
          - NameDesc
          - StatusAsc
          - StatusDesc
          - KeyFieldAsc
          - KeyFieldDesc
          - MaxAttemptsAsc
          - MaxAttemptsDesc
          - IsEncryptedAsc
          - IsEncryptedDesc
          - TotalItemCountAsc
          - TotalItemCountDesc
          - CompletedItemCountAsc
          - CompletedItemCountDesc
          - PendingItemCountAsc
          - PendingItemCountDesc
          - LockedItemCountAsc
          - LockedItemCountDesc
          - ExceptionedItemCountAsc
          - ExceptionedItemCountDesc
          - TotalCaseDurationAsc
          - TotalCaseDurationDesc
          - AverageWorkTimeAsc
          - AverageWorkTimeDesc
      - name: name
        description: A filter to search for the name of the work queue.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: keyField
        description: A filter to search for the name of the work queue's key field.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: status.eq
        description: A filter to search for the current status of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/QueueStatus'
      - name: maxAttempts
        description: A filter to search for the configured maximum attempts of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: pendingItemCount
        description: A filter to search for the pending item count of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: lockedItemCount
        description: A filter to search for the locked item count of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: completedItemCount
        description: A filter to search for the completed item count of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: exceptionedItemCount
        description: A filter to search for the exceptioned item count of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: totalItemCount
        description: A filter to search for the total item count of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: averageWorkTime
        description: A filter to search for the average work time of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/TimeEqualsExample'
          range:
            $ref: '#/components/examples/TimeRangeExample'
          greater:
            $ref: '#/components/examples/TimeLessThanExample'
      - name: totalCaseDuration
        description: A filter to search for the total case duration of the work queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/TimeEqualsExample'
          range:
            $ref: '#/components/examples/TimeRangeExample'
          greater:
            $ref: '#/components/examples/TimeLessThanExample'
      - name: itemsPerPage
        description: The maximum number of items to retrieve per page.
        in: query
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A list of work queue summaries was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkQueuesItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/workqueues/configurations:
    get:
      summary: Return configuration(id, name, assignedProcessId, assignedResourceGroupId and activeQueueStats) for each active
        work queue.
      operationId: getWorkQueueConfiguration
      description: '> ### Permissions required

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

        '
      tags:
      - Work Queues
      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:
          - NameAsc
          - NameDesc
      - name: name
        description: A filter to search for the name of the work queue configuration.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: itemsPerPage
        description: The maximum number of items to retrieve per page.
        in: query
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A list of work queue configurations was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkQueueConfigurationsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/workqueues/{workQueueId}:
    get:
      summary: Return details of a work queue.
      operationId: getWorkQueue
      description: '> ### Permissions required

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

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        in: path
        description: The ID of the queue to retrieve details for.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The work queue details were successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkQueueSummary'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      summary: Modify the work queue as described in the patch document.
      operationId: updateWorkQueue
      description: '> ### Permissions required

        At least one of: `Read Access to Queue Management` | `Full Access to Queue Management`<br><br>

        and `Workflow - Work Queue Configuration`

        > This endpoint does not support application server-based encryption keys. Only database-based encryption keys can
        be used.

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        in: path
        description: The ID of the queue to modify.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchRequest'
            examples:
              add (to array):
                $ref: '#/components/examples/PatchAddToArrayExample'
              add (to object):
                $ref: '#/components/examples/PatchAddToObjectExample'
              copy:
                $ref: '#/components/examples/PatchCopyExample'
              move:
                $ref: '#/components/examples/PatchMoveExample'
              remove:
                $ref: '#/components/examples/PatchRemoveExample'
              replace:
                $ref: '#/components/examples/PatchReplaceExample'
      responses:
        '204':
          description: The work queue was successfully updated.
        '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 work queue.
      operationId: deleteWorkQueue
      description: '> ### Permissions required: `Workflow - Work Queue Configuration`

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        in: path
        description: The ID of the queue to delete.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: The queue was successfully deleted.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Either the queue is not empty or still has running sessions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v7/workqueues/{workQueueId}/references:
    get:
      summary: Return references to a specified work queue.
      operationId: getWorkQueueReferences
      description: '> ### Permissions required: `Workflow - Work Queue Configuration`

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        description: The ID of the queue to get references of.
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: sortBy
        description: The field that results should be sorted by and the direction they should be sorted in.
        in: query
        schema:
          type: string
          enum:
          - NameAsc
          - NameDesc
          - DescriptionAsc
          - DescriptionDesc
          - ProcessTypeAsc
          - ProcessTypeDesc
      - name: itemsPerPage
        description: The maximum number of items to retrieve.
        in: query
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      - name: name
        description: A filter to search for the name of the reference.
        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: description
        in: query
        style: deepObject
        description: A filter to search for the description of the reference.
        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: processType
        in: query
        style: form
        explode: false
        description: The type of the process to search for.
        schema:
          type: array
          items:
            type: string
            enum:
            - Process
            - Object
      responses:
        '200':
          description: An list of queue references was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferencesItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/workqueues/{workQueueId}/items:
    get:
      summary: Return items in a specified work queue.
      operationId: getWorkQueueItems
      description: '> ### 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`

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        description: The ID of the queue to get an item from.
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - 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:
          - 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
      - name: keyValue
        description: A filter to search for the value of the key field of the work queue item.
        in: query
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: status
        description: A filter to search for the status of the work queue item.
        in: query
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: state
        description: A filter to search for the current state of the work queue item.
        in: query
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - Pending
            - Locked
            - Deferred
            - Completed
            - Exceptioned
      - name: totalWorkTime
        description: A filter to search for the total work time of the work queue item.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/TimeEqualsExample'
          range:
            $ref: '#/components/examples/TimeRangeExample'
          greater:
            $ref: '#/components/examples/TimeLessThanExample'
      - name: loadedDate
        description: A filter to search for the time the work queue item was loaded onto the queue.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: deferredDate
        description: A filter to search for the time the work queue item is deferred until.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: lockedDate
        description: A filter to search for the time the work queue item was locked.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: completedDate
        description: A filter to search for the time the work queue item was completed.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: exceptionedDate
        description: A filter to search for the time the work queue item exceptioned.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: lastUpdated
        description: A filter to search for the time the work queue item was last updated.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: attempt
        description: A filter to search for the current attempt number of the work queue item.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: priority
        description: A filter to search for the priority of the work queue item.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: exceptionReason
        description: A filter to search for the reason that the work queue item exceptioned.
        in: query
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: slaDateTime
        description: A filter to search for the sla time the work queue item.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: processName
        description: A filter to search for the process name of the work queue item.
        in: query
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: sla
        description: A filter to search for the sla time of the work queue item.
        in: query
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/TimeEqualsExample'
          range:
            $ref: '#/components/examples/TimeRangeExample'
          greater:
            $ref: '#/components/examples/TimeLessThanExample'
      - name: withinSla
        in: query
        description: Flag to get work queue items within sla time.
        schema:
          type: boolean
      - name: isSuggested
        in: query
        description: A filter to search the work queue items which is used to help troubleshoot issues.
        schema:
          $ref: '#/components/schemas/EqualsFilter'
      - name: itemsPerPage
        description: The maximum number of items to retrieve per page.
        in: query
        schema:
          type: integer
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      responses:
        '200':
          description: An list of queue items was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkQueueItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      deprecated: true
      summary: Create work queue item(s).
      operationId: createWorkQueueItem
      description: '> ### 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`

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        in: path
        description: The ID of the queue to insert into.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Details of the queue items to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkQueueItems'
      responses:
        '201':
          description: The item was successfully added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Identifiers'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/workqueues/{workQueueId}/items/batch:
    post:
      summary: Create work queue items.
      operationId: createWorkQueueItems
      description: '> ### 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.

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        in: path
        description: The ID of the queue to insert into.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Details of the queue items to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkQueueItems'
      responses:
        '201':
          description: The item was successfully added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Identifiers'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/workqueues/items/{workQueueItemId}:
    get:
      deprecated: true
      summary: Return details of a specified item from a work queue.
      operationId: getWorkQueueItem
      description: '> ### 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.

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueItemId
        in: path
        description: The ID of the item to get.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The specified work queue item was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkQueueItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/workqueues/{workQueueId}/items/{workQueueItemId}:
    get:
      summary: Return details of a specified item from a work queue.
      operationId: getWorkQueueItemFromWorkQueue
      description: '> ### 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.

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        in: path
        description: The queue ID of the item to get.
        required: true
        schema:
          type: string
          format: uuid
      - name: workQueueItemId
        in: path
        description: The ID of the item to get.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The specified work queue item was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkQueueItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/attempts:
    get:
      summary: Returns all attempts for the given work queue item
      operationId: getWorkQueueItemAttempts
      description: '> ### 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`

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        in: path
        description: The queue ID of the item to return attempts.
        required: true
        schema:
          type: string
          format: uuid
      - name: workQueueItemId
        in: path
        description: The ID of the item to return attempts.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: A collection of work queue items.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkQueueItemNoData'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      summary: Creates a new work queue item attempt by forcing an item to retry.
      operationId: createWorkQueueItemAttempt
      description: '> ### Permissions required: `Full Access to Queue Management`

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        in: path
        description: The queue ID of the item to force retry.
        required: true
        schema:
          type: string
          format: uuid
      - name: workQueueItemId
        in: path
        description: The ID of the item to force retry.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '201':
          description: The work queue item attempt was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkQueueItemAttemptResponseModel'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/attempts/{attemptId}:
    delete:
      summary: Deletes a worked queue item.
      operationId: deleteWorkQueueItemAttempt
      description: '> ### Permissions required: `Full Access to Queue Management`

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        in: path
        description: The queue ID of the item to delete.
        required: true
        schema:
          type: string
          format: uuid
      - name: workQueueItemId
        in: path
        description: The ID of the item to delete.
        required: true
        schema:
          type: string
          format: uuid
      - name: attemptId
        in: path
        description: The ID of the attempt of the work queue item to delete
        required: true
        schema:
          type: number
      responses:
        '204':
          description: The worked queue item was successfully deleted.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      summary: Modify the work queue item as described in the patch document.
      operationId: updateWorkQueueItemAttempt
      description: '> ### Permissions required: `Full Access to Queue Management`

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        in: path
        description: The queue ID of the item to update.
        required: true
        schema:
          type: string
          format: uuid
      - name: workQueueItemId
        in: path
        description: The ID of the item to update.
        required: true
        schema:
          type: string
          format: uuid
      - name: attemptId
        in: path
        description: The ID of the attempt of the work queue item to update
        required: true
        schema:
          type: number
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchRequest'
            examples:
              replace:
                $ref: '#/components/examples/PatchReplaceExample'
      responses:
        '204':
          description: The work queue item 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/workqueues/{workQueueId}/items/{workQueueItemId}/callbacks:
    post:
      summary: Creates a new work queue web hook item .
      operationId: CreateWebHookWorkQueueItem
      description: '> ### Permissions required:

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

        And `Full Access to webhooks`

        '
      tags:
      - Work Queues
      parameters:
      - name: workQueueId
        in: path
        description: The queue ID of the item.
        required: true
        schema:
          type: string
          format: uuid
      - name: workQueueItemId
        in: path
        description: The ID of the item.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Details of the webhook subscriptions to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookWorkQueueItem'
      responses:
        '201':
          description: The work queue webhook item  was successfully created.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/WorkQueueItemWebhookSubscriptionResponse'
                - $ref: '#/components/schemas/WorkQueueItemSubscriptionCustomResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/workqueuegroups/{identifier}:
    get:
      summary: Return details of a work queue group.
      operationId: getWorkQueueGroup
      description: '> ### Permissions required: `Workflow - Work Queue Configuration`

        '
      tags:
      - Work Queue Groups
      parameters:
      - name: identifier
        in: path
        description: It can be 'root' value to get a root group or the ID of the work queue group to retrieve details for.
        required: true
        schema:
          type: string
          format: uuid or "root"
      responses:
        '200':
          description: The work queue group details were successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkQueueGroup'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      summary: Modify the work queue group as described in the patch document.
      operationId: updateWorkQueueGroup
      description: '> ### Permissions required: `Workflow - Work Queue Configuration`

        '
      tags:
      - Work Queue Groups
      parameters:
      - name: identifier
        in: path
        description: The ID of the work queue group to update.
        required: true
        schema:
          type: string
          format: uuid or "root"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchRequest'
            examples:
              replace:
                $ref: '#/components/examples/PatchReplaceExample'
      responses:
        '204':
          description: The work queue group 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/workqueuegroups:
    post:
      summary: Creates a work queue group.
      operationId: createWorkQueueGroup
      description: '> ### Permissions required: `Workflow - Work Queue Configuration`

        '
      tags:
      - Work Queue Groups
      requestBody:
        description: Details of the group to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkQueueGroup'
      responses:
        '201':
          description: The work queue group was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkQueueGroupResponseModel'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/workqueuegroups/{workQueueGroupId}:
    delete:
      summary: Deletes a work queue group.
      operationId: deleteWorkQueueGroup
      description: '> ### Permissions required: `Workflow - Work Queue Configuration`

        '
      tags:
      - Work Queue Groups
      parameters:
      - name: workQueueGroupId
        in: path
        description: The ID of the work queue group to delete.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: The work queue group 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/workqueuegroups/{identifier}/items:
    get:
      summary: Return a list of work queues belonging to a work queue group.
      operationId: getWorkQueuesInGroup
      description: '> ### Permissions required: `Workflow - Work Queue Configuration`

        '
      tags:
      - Work Queue Groups
      parameters:
      - name: identifier
        in: path
        description: It can be a 'root' value to get work queues from the root queue group or the ID of the work queue group
          to retrieve work queues from it.
        required: true
        schema:
          type: string
          format: uuid or "root"
      - 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:
          - NameAsc
          - NameDesc
      - name: itemsPerPage
        description: The maximum number of items to retrieve per page.
        in: query
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      - name: name
        description: A filter to search for the name of items inside work queue group.
        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: The work queue group work queues were successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkQueuesFromGroupItemsPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/workqueuegroups/{identifier}/childgroups:
    get:
      summary: Return details of child groups of work queue group.
      operationId: getChildGroupsInWorkQueueGroup
      description: '> ### Permissions required: `Workflow - Work Queue Configuration`

        '
      tags:
      - Work Queue Groups
      parameters:
      - name: identifier
        in: path
        description: It can be a 'root' value to get details of groups from the root or the ID of the parent work queue group
          to retrieve details of child groups.
        required: true
        schema:
          type: string
          format: uuid or "root"
      - name: sortBy
        description: The field that results should be sorted by and the direction they should be sorted in.
        in: query
        schema:
          type: string
          enum:
          - NameAsc
          - NameDesc
          - HasChildGroupsAsc
          - HasChildGroupsDesc
          - HasChildItemsAsc
          - HasChildItemsDesc
      - name: itemsPerPage
        description: The maximum number of items to retrieve per page.
        in: query
        schema:
          type: integer
          minimum: 1
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      - name: name
        description: A filter to search for the name of the queue group.
        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: hasChildGroups
        in: query
        style: form
        explode: false
        description: The availability of child groups in the group.
        schema:
          type: array
          items:
            type: string
            enum:
            - 'true'
            - 'false'
      - name: hasChildItems
        in: query
        style: form
        explode: false
        description: The availability of child items in the group.
        schema:
          type: array
          items:
            type: string
            enum:
            - 'true'
            - 'false'
      responses:
        '200':
          description: The work child groups details were successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkQueueChildGroups'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v7/licenses:
    get:
      summary: Return a list of licenses.
      operationId: getLicenses
      description: '> ### Permissions required: `System - License permission`

        '
      tags:
      - Licenses
      parameters:
      - name: pagingToken
        description: The token to point to the last item previously returned.
        in: query
        schema:
          type: string
      - name: itemsPerPage
        description: The maximum number of items to retrieve per page.
        in: query
        schema:
          type: integer
          minimum: 1
      - name: sortBy
        description: The field that results should be sorted by and the direction they should be sorted in.
        in: query
        schema:
          type: string
          enum:
          - LicenseIdAsc
          - LicenseIdDesc
          - StatusAsc
          - StatusDesc
          - ActivationStatusAsc
          - ActivationStatusDesc
          - OwnerAsc
          - OwnerDesc
          - TypeAsc
          - TypeDesc
          - StartsAsc
          - StartsDesc
          - ExpiresAsc
          - ExpiresDesc
          - ProcessesAsc
          - ProcessesDesc
          - SessionsAsc
          - SessionsDesc
          - ResourcesAsc
          - ResourcesDesc
          - AlertsAsc
          - AlertsDesc
          - StandaloneAsc
          - StandaloneDesc
          - DecipherIDPAsc
          - DecipherIDPDesc
      - name: status
        in: query
        style: form
        explode: false
        description: The status of the license to search for.
        schema:
          type: array
          items:
            type: string
            enum:
            - Future
            - Expired
            - ExpiresSoon
            - GracePeriodEndsSoon
            - RequiresActivation
            - Active
      - name: activationStatus
        in: query
        style: form
        explode: false
        description: The activation status of the license to search for.
        schema:
          type: array
          items:
            type: string
            enum:
            - NotApplicable
            - NotActivated
            - Activated
      - name: type
        in: query
        style: form
        explode: false
        description: The type of the license to search for.
        schema:
          type: array
          items:
            type: string
            enum:
            - None
            - Enterprise
            - NHS
            - Evaluation
            - Education
            - Desktop
      - name: owner
        description: A filter to search for the owner of the license.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/FullStringFilter'
        examples:
          equals:
            $ref: '#/components/examples/StringEqualsExample'
          startsWith:
            $ref: '#/components/examples/StringStartsWithExample'
          contains:
            $ref: '#/components/examples/StringContainsExample'
          range:
            $ref: '#/components/examples/StringRangeExample'
          greater:
            $ref: '#/components/examples/StringGreaterThanExample'
      - name: starts
        in: query
        style: deepObject
        description: A filter to search for the date that the license starts.
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: expires
        in: query
        style: deepObject
        description: A filter to search for the date that the license expires.
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/DateTimeEqualsExample'
          range:
            $ref: '#/components/examples/DateTimeRangeExample'
          greater:
            $ref: '#/components/examples/DateTimeGreaterThanExample'
      - name: processes
        description: A filter to search for the number of processes that may be published.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: sessions
        description: A filter to search for the number of sessions which may be run.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: resources
        description: A filter to search for the number of runtime resources which may be registered at any one time.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: alerts
        description: A filter to search for the number of machines on which Process Alerts may be used.
        in: query
        style: deepObject
        schema:
          $ref: '#/components/schemas/RangeOrEqualFilter'
        examples:
          equals:
            $ref: '#/components/examples/IntegerEqualsExample'
          range:
            $ref: '#/components/examples/IntegerRangeExample'
          less:
            $ref: '#/components/examples/IntegerLessThanExample'
      - name: standalone.eq
        description: A filter to check availability of license standalone.
        in: query
        schema:
          type: boolean
      - name: decipherIDP.eq
        description: A filter to check availability of license decipherIDP.
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: A list of licenses was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicensesItemsPage'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      summary: Add a license.
      operationId: createLicense
      description: '> ### Permissions required: `System - License permission`

        '
      tags:
      - Licenses
      requestBody:
        description: Encoded license key.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddLicense'
      responses:
        '201':
          description: The license was successfully added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddLicenseResponseModel'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v7/licenses/{licenseId}:
    delete:
      summary: Delete a specified license.
      operationId: deleteLicense
      description: '> ### Permissions required: `System - License permission `

        '
      tags:
      - Licenses
      parameters:
      - name: licenseId
        in: path
        description: The ID of the license to delete.
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: The license was successfully deleted.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  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
  responses:
    NotAuthorized:
      description: The authentication token was either missing or invalid and must be refreshed.
      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'
    BadRequestErrorMessage:
      description: The request is malformed or contains incorrect information. See the response for more details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    NotFound:
      description: The requested resource could not be found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    NotFoundSession:
      description: The requested session could not be found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    Conflict:
      description: The request conflicts with the current state of the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    SessionForbidden:
      description: The user does not have execute permission for this action, or the number of sessions permitted by the current
        license would be exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    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'
    RadioButtonsArray:
      description: Used for the RadioButtons data type.
      type: array
      items:
        type: object
        properties:
          name:
            type: string
          selected:
            type: boolean
    DataRow:
      description: A dictionary which represents a row of data from a Blue Prism collection.
      type: object
      additionalProperties:
        $ref: '#/components/schemas/DataValue'
    DataRowSchedule:
      description: A dictionary which represents a row of data from a Blue Prism collection.
      type: object
      additionalProperties:
        $ref: '#/components/schemas/DataValueSchedule'
    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.
          nullable: true
          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
    DataValueSchedule:
      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
          - Date
          - DateTime
          - Flag
          - Image
          - Number
          - Password
          - Text
          - Time
          - TimeSpan
        value:
          description: The value of the object.
          oneOf:
          - type: string
            format: base64
            description: Used for Binary and Image data types.
          - 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.
    CreateScheduleDefinitionResponseModel:
      description: Contains the ID of a schedule.
      type: object
      properties:
        id:
          type: integer
          description: The ID of the schedule.
    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
          nullable: true
          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
          nullable: true
          description: The ID of the time zone.
        adjustForDaylightSaving:
          type: boolean
          nullable: true
          description: Determines if to use daylight savings time when time one is a valid time zone ID.
        hourlyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/HourlyMinutelyDetails'
          description: Hourly details that apply to the hour interval schedule type.
        minutelyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/HourlyMinutelyDetails'
          description: Minute details that apply to the minute interval schedule type.
        dailyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/DailyDetails'
          description: Daily details that apply to the daily interval schedule type.
        weeklyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/WeeklyDetails'
          description: Weekly details that apply to the weekly interval schedule type.
        monthlyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/MonthlyDetails'
          description: Monthly details that apply to the monthly interval schedule type.
        yearlyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/YearlyDetails'
          description: Yearly details that apply to the yearly interval schedule type.
    UpdateScheduleDetails:
      description: Contains the details of a schedule.
      allOf:
      - type: object
        properties:
          name:
            type: string
            description: The name of the schedule.
      - $ref: '#/components/schemas/ScheduleDetails'
    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'
    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'
    ScheduleDetails:
      description: Contains the details of a schedule.
      type: object
      properties:
        description:
          type: string
          description: The description of the schedule.
        initialTaskId:
          type: integer
          nullable: true
          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
          nullable: true
          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
          nullable: true
          description: The ID of the time zone.
        adjustForDaylightSaving:
          type: boolean
          nullable: true
          description: Determines if to use daylight savings time when time zone is a valid time zone ID.
        minutelyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/HourlyMinutelyDetails'
          description: Minute details that apply to the minute interval schedule type.
        hourlyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/HourlyMinutelyDetails'
          description: Hourly details that apply to the hour interval schedule type.
        dailyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/DailyDetails'
          description: Daily details that apply to the daily interval schedule type.
        weeklyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/WeeklyDetails'
          description: Weekly details that apply to the weekly interval schedule type.
        monthlyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/MonthlyDetails'
          description: Monthly details that apply to the monthly interval schedule type.
        yearlyDetails:
          type: object
          nullable: true
          $ref: '#/components/schemas/YearlyDetails'
          description: Yearly details that apply to the yearly interval schedule type.
    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
          nullable: true
          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
          nullable: true
          description: Which week number to repeat the schedule on (required when NthWeekDay is selected).
          enum:
          - First
          - Second
          - Third
          - Fourth
          - Fifth
          - Last
        weekDay:
          type: string
          nullable: true
          description: Which weekday to repeat the schedule on (required when NthWeekDay is selected).
          enum:
          - Sunday
          - Monday
          - Tuesday
          - Wednesday
          - Thursday
          - Friday
          - Saturday
        workingDay:
          type: string
          nullable: true
          description: Which working day the schedule will run on (required when NthWorkingDay is selected).
          enum:
          - First
          - Last
        calendarId:
          type: integer
          nullable: true
          description: The ID of the calendar to use (required when NthWorkingDay is selected).
    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
          nullable: true
          description: Which working day the schedule will run on.
          enum:
          - First
          - Last
        calendarId:
          type: integer
          nullable: true
          description: The ID of the calendar to use.
    YearlyDetails:
      description: Yearly details that apply to the yearly interval schedule type.
      type: object
      properties:
        period:
          type: integer
          description: The schedule frequency.
    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
          nullable: true
          description: The ID of the calendar to use.
    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
          nullable: true
          description: The ID of the calendar to use.
    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
          nullable: true
          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
          nullable: true
          description: The earliest date the schedule will run.
          format: date-time
        endDate:
          type: string
          nullable: true
          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
    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
    ScheduleLogItemsPage:
      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/ScheduleLogSummary'
      example:
        pagingToken: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
        items:
        - scheduleLogId: 1
          startTime: '2019-08-27T14:15:22Z'
          endTime: '2019-08-27T14:15:22Z'
          duration: 00:01:23
          status: pending
          serverName: Example server
          scheduleId: 1
          scheduleName: Example schedule
    ScheduleLogSummary:
      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.
        duration:
          type: string
          format: time-span
          description: The duration 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.
    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'
    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.
    CreateSession:
      description: Contains details for creating a new session.
      type: object
      properties:
        processId:
          type: string
          description: The ID of the process to run in the session.
          format: uuid
        parameters:
          type: array
          description: Parameters to pass to the session.
          items:
            $ref: '#/components/schemas/DataValue'
    UpdateSession:
      description: Contains details for updating a session.
      type: object
      properties:
        status:
          type: string
          description: The status of the session.
          enum:
          - Pending
          - Running
          - Stopped
          - Terminated
          - Completed
          - Stopping
          - Warning
    SessionDetails:
      description: Contains details of a session.
      type: object
      properties:
        sessionId:
          type: string
          description: The ID of the session.
        processId:
          type: string
          description: The ID of the process in the session.
          format: uuid
        status:
          type: string
          description: The current status of the session.
          enum:
          - Pending
          - Running
          - Stopped
          - Terminated
        parameters:
          type: array
          description: Parameters to pass to the session.
          items:
            $ref: '#/components/schemas/DataValue'
    SessionLogsPage:
      description: Contains details of a page of session 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 items
          items:
            $ref: '#/components/schemas/SessionLogSummary'
      example:
        pagingToken: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
        items:
        - logId: 123
          logNumber: 123
          stageId: 00000000-0000-0000-0000-000000000000
          stageName: Example stage
          stageType: Calculation
          processName: Example process
          pageName: Example page
          objectName: Example object
          actionName: Example action
          result: Some result
          resultType: Collection
          resourceStartTime: '2020-10-02T12:34:56+01:00'
          resourceEndTime: '2020-10-02T13:34:56+01:00'
          bluePrismMemory: 123
          targetAppId: Example target
          targetMemory: 123
          hasParameters: true
    SessionLogParametersResponse:
      description: Contains input and output parameters of a session log.
      type: object
      properties:
        inputs:
          $ref: '#/components/schemas/DataRow'
        outputs:
          $ref: '#/components/schemas/DataRow'
      example:
        inputs:
          parameter1:
            valueType: Text
            value: Example value
          parameter2:
            valueType: Number
            value: 123
        outputs:
          parameter1:
            valueType: Collection
            value:
              rows:
              - valueType: Number
                value: 321
              - valueType: Date
                value: '2020-10-02T12:34:56+01:00'
    SessionLogSummary:
      description: Contains basic details of a session log.
      type: object
      properties:
        logId:
          type: integer
          description: The ID of the session log.
        logNumber:
          type: integer
          description: The number of the session log.
        stageId:
          type: string
          description: The id of the stage that created this log entry.
        stageName:
          type: string
          description: The name of the stage that created this log entry.
        stageType:
          description: The type of the stage that created this log entry.
          type: string
          $ref: '#/components/schemas/StageType'
        processName:
          type: string
          description: The name of the processes.
        pageName:
          type: string
          description: The name of the page.
        objectName:
          type: string
          description: The name of the object.
        actionName:
          type: string
          description: The name of the action.
        result:
          type: string
          description: The result of the stage.
        resultType:
          type: string
          description: The result type of the stage.
          $ref: '#/components/schemas/ResultType'
        resourceStartTime:
          type: string
          format: date-time
          description: The date and time that the resource started running.
        resourceEndTime:
          type: string
          format: date-time
          description: The date and time that the resource ended running.
        bluePrismMemory:
          type: integer
          description: The automate memory.
        targetAppId:
          type: string
          description: The id of the target app.
        targetMemory:
          type: integer
          description: The tareget memory.
        hasParameters:
          type: boolean
          description: If the session log has parameters.
      example:
        logId: 123
        logNumber: 123
        stageId: 00000000-0000-0000-0000-000000000000
        stageName: Example stage
        stageType: Calculation
        processName: Example process
        pageName: Example page
        objectName: Example object
        actionName: Example action
        result: Some result
        resultType: Collection
        resourceStartTime: '2020-10-02T12:34:56+01:00'
        resourceEndTime: '2020-10-02T13:34:56+01:00'
        bluePrismMemory: 123
        targetAppId: Example target
        targetMemory: 123
        hasParameters: true
    SessionSummary:
      description: Contains basic details of a session,
      type: object
      properties:
        sessionId:
          type: string
          description: The ID of the session,
          format: uuid
        sessionNumber:
          type: integer
          description: The unique number of the session,
        areStartupParamsSet:
          type: boolean
          description: The flag which shows whether startup parameters were set,
        AreInputParamsSet:
          type: boolean
          description: The flag which shows whether input parameters were set,
        processId:
          type: string
          description: The ID of the process in the session,
          format: uuid
        processName:
          type: string
          description: The name of the session's process,
        resourceId:
          type: string
          description: The ID of the resource in the session,
          format: uuid
        resourceName:
          type: string
          description: The name of the resource in the session,
        username:
          type: string
          description: The username of the user that initialized the session,
        status:
          $ref: '#/components/schemas/SessionStatus'
          description: The current state of the session,
        startTime:
          type: string
          nullable: true
          description: The start time of the session,
          format: date-time
        endTime:
          type: string
          nullable: true
          description: The end time of the session,
          format: date-time
        latestStage:
          type: string
          description: The latest stage name of the session,
          nullable: true
        stageStarted:
          type: string
          nullable: true
          description: The stage start time of the session,
          format: date-time
        exceptionMessage:
          type: string
          nullable: true
          description: The exception message of the failed session,
        terminationReason:
          type: string
          enum:
          - None
          - ProcessError
          - InternalError
          description: The reason for the termination of the session,
          nullable: true
        exceptionType:
          type: string
          description: Type of the exception.
          nullable: true
        sessionSource:
          $ref: '#/components/schemas/SessionSource'
          description: Source of the session.
        processAttribute:
          type: array
          description: The attributes of the process.
          items:
            $ref: '#/components/schemas/ProcessAttribute'
      example:
        sessionId: 01234567-89ab-cdef-0123-456789abcdef
        sessionNumber: 123
        areStartupParamsSet: true
        areInputParamsSet: 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
        sessionSource: Enterprise
        processAttribute:
        - Retired
        - Published
        - PublishedWebService
    SessionItemsPage:
      description: Contains details of a page of sessions.
      type: object
      properties:
        pagingToken:
          $ref: '#/components/schemas/PagingToken'
          nullable: true
        items:
          type: array
          description: A collection of session summary.
          items:
            $ref: '#/components/schemas/SessionSummary'
          example:
          - sessionId: 01234567-89ab-cdef-0123-456789abcdef
            sessionNumber: 123
            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
            sessionSource: Enterprise
            processAttribute: Published
    SessionStartUpParameters:
      description: Contains start-up parameters of a session.
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/DataRow'
      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
    CreateSessionParameters:
      description: Contain a parameter used to create a new session
      type: object
      properties:
        resourceId:
          type: string
          format: uuid
          description: The ID of the resource or pool to create session.
        processId:
          type: string
          format: uuid
          description: The ID of the process to create session.
    StageType:
      description: The stage type of a session
      type: string
      enum:
      - Undefined
      - Action
      - Decision
      - Calculation
      - Data
      - Collection
      - Process
      - SubSheet
      - ProcessInfo
      - SubSheetInfo
      - Start
      - End
      - Anchor
      - Note
      - LoopStart
      - LoopEnd
      - Read
      - Write
      - Navigate
      - Code
      - ChoiceStart
      - ChoiceEnd
      - WaitStart
      - WaitEnd
      - Alert
      - Exception
      - Recover
      - Resume
      - Block
      - MultipleCalculation
      - Skill
      - Input
      - Output
      - EnterpriseSession
    ResultType:
      description: The result type of a session
      type: string
      enum:
      - Unknown
      - Binary
      - Collection
      - Date
      - DateTime
      - Flag
      - Image
      - Number
      - Password
      - Text
      - Time
      - TimeSpan
      - RadioButton
    SessionStatus:
      description: The status of a session
      type: string
      enum:
      - Pending
      - Running
      - Terminated
      - Stopped
      - Completed
      - Stopping
      - Warning
    SessionSource:
      description: The source of a session
      type: string
      enum:
      - Desktop
      - Enterprise
    TimeZones:
      description: A collection of time zones.
      type: array
      items:
        $ref: '#/components/schemas/TimeZone'
      example:
        items:
        - id: Dateline Standard Time
          displayName: (UTC-12:00) International Date Line West
          baseUtcOffset: '-12:00:00'
          standardName: Dateline Standard Time
        - id: UTC-11
          displayName: (UTC-11:00) Co-ordinated Universal Time-11
          baseUtcOffset: '-11:00:00'
          standardName: UTC-11
    TimeZone:
      description: Contains details of a time zone.
      type: object
      properties:
        id:
          type: string
          description: The time zone identifier.
        displayName:
          type: string
          description: The general display name that represents the time zone.
        baseUtcOffset:
          type: string
          format: time-span
          description: The time difference between the current time zone's standard time and Coordinated Universal Time (UTC).
        standardName:
          type: string
          description: The display name for the time zone's standard time.
    WorkQueueGroup:
      description: Contains basic details of a work queue group.
      type: object
      properties:
        id:
          type: string
          description: The ID of the work queue group.
          format: uuid or "root"
        name:
          type: string
          description: The name of the work queue group.
        parentGroupId:
          type: string
          description: The ID of the parent work queue group.
          format: uuid or "root"
        hasChildGroups:
          type: boolean
          description: True if the group containes other groups; otherwise, false.
        hasChildItems:
          type: boolean
          description: True if the group containes work queues; otherwise, false.
      example:
        id: 01234567-89ab-cdef-0123-456789abcdef
        name: Example work queue group
        parentGroupId: fedcba98-7654-3210-fedc-ba9876543210
        hasChildGroups: false
        hasChildItems: false
    WorkQueuesFromGroupItemsPage:
      description: Contains details of a page of work queues from the work queue group.
      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 work queues from the work queue group.
          items:
            $ref: '#/components/schemas/WorkQueueInGroup'
      example:
        pagingToken: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
        items:
        - id: 01234567-89ab-cdef-0123-456789abcdef
          name: queue 1
    WorkQueueInGroup:
      description: Contains details of the work queue from the work queue group.
      type: object
      properties:
        id:
          type: string
          description: The ID of the queue.
          format: uuid
        name:
          type: string
          description: The name of the queue.
    CreateWorkQueueGroup:
      description: Contains details for creating a new work queue group.
      type: object
      properties:
        name:
          type: string
          description: The name of the group to create.
          minLength: 1
          maxLength: 255
        parentGroupId:
          type: string
          format: uuid or "root"
          description: The ID of the group to use as a parent.
      example:
        name: Test Group
        parentGroupId: a4e0b0ba-3b8f-443d-bdb0-ee519299bd01
    CreateWorkQueueGroupResponseModel:
      description: Contains the ID of a new work queue group.
      type: object
      properties:
        groupId:
          type: string
          format: uuid
          description: The ID of the created work queue group.
    WorkQueueChildGroups:
      description: Contains basic details of a work queue group.
      type: object
      properties:
        pagingToken:
          $ref: '#/components/schemas/PagingToken'
        items:
          type: array
          description: A collection of work queue groups.
          items:
            $ref: '#/components/schemas/WorkQueueGroup'
    WorkQueueSummary:
      description: Contains basic details of a work queue.
      type: object
      properties:
        id:
          type: string
          description: The ID of the queue.
          format: uuid
        name:
          type: string
          description: The name of the queue.
          minLength: 1
        keyField:
          type: string
          description: The name of the column used as the queue's key.
        status:
          $ref: '#/components/schemas/QueueStatus'
        isEncrypted:
          type: boolean
          description: True if the queue is encrypted; otherwise, false.
        maxAttempts:
          type: integer
          description: The maximum number of retry attempts for items in the queue.
        pendingItemCount:
          type: integer
          description: The number of items in the queue in a pending state.
        completedItemCount:
          type: integer
          description: The number of items in the queue in a completed state.
        lockedItemCount:
          type: integer
          description: The number of items in the queue in a locked state.
        exceptionedItemCount:
          type: integer
          description: The number of items in the queue in an exceptioned state.
        totalItemCount:
          type: integer
          description: The total number of items in the queue.
        averageWorkTime:
          type: string
          format: time-span
          description: The average amount of time an items spends being worked.
        totalCaseDuration:
          type: string
          format: time-span
          description: The total amount of time items have been worked.
        groupName:
          type: string
          description: The name of the group in which the queue is located.
        groupId:
          type: string
          description: ID of the group in which the queue is located.
          format: uuid
        isRetryItems:
          type: boolean
          description: True if Retry items in this queue in the event of an unexpected session termination is enabled; otherwise,
            false.
        isSnapshotEnabled:
          type: boolean
          description: True if there is information related to Snapshot Configuration; otherwise, false.
        isActiveQueue:
          type: boolean
          description: True if the queue is active; otherwise, false.
        activeWorkQueueConfiguration:
          nullable: true
          $ref: '#/components/schemas/ActiveWorkQueueConfiguration'
        activeQueueStats:
          $ref: '#/components/schemas/ActiveWorkQueueStatistics'
      example:
        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
        isRetryItems: true
        isSnapshotEnabled: true
        isActiveQueue: true
        activeWorkQueueConfiguration:
          assignedProcessId: axe34dfx-1234-2435-fedc-ba9876500987
          assignedResourceGroupId: xv3fd45s-6543-6231-exrf-we23e456781
    ActiveWorkQueueConfiguration:
      description: Contains details of an active work queue.
      type: object
      properties:
        assignedProcessId:
          type: string
          description: ID of the assigned process.
          format: uuid
        assignedResourceGroupId:
          type: string
          description: ID of the assigned resource group.
          format: uuid
      example:
        assignedProcessId: axe34dfx-1234-2435-fedc-ba9876500987
        assignedResourceGroupId: xv3fd45s-6543-6231-exrf-we23e456781
    ActiveWorkQueueStatistics:
      description: Contains statistics for an active work queue.
      type: object
      nullable: true
      properties:
        activeSessions:
          type: integer
          description: the current number of active sessions for this queue.
        availableResources:
          type: integer
          description: the current number of available resources assigned to this queue.
        timeRemaining:
          type: string
          description: the amount of time remaining for this queue based on the number of pending cases and the average work
            time for a case.
          format: time-span
        elapsedRemaining:
          type: string
          description: the amount of time remaining for all currently assigned sessions to work the remaining pending cases.
          format: time-span
        ETA:
          type: string
          description: the projected end time for this queue in local time.
          format: date-time
      example:
        activeSessions: '10'
        availableResources: '5'
        timeRemaining: 01:25:10
        elapsedRemaining: 00:05:10
        ETA: '2020-10-03T13:36:21+02:00'
    WorkQueueConfigurationSummary:
      description: Contains details of a work queue configuration.
      type: object
      properties:
        id:
          type: string
          description: The ID of the queue.
          format: uuid
        name:
          type: string
          description: The name of the queue.
          minLength: 1
        activeWorkQueueConfiguration:
          nullable: true
          $ref: '#/components/schemas/ActiveWorkQueueConfiguration'
        activeQueueStats:
          $ref: '#/components/schemas/ActiveWorkQueueStatistics'
      example:
        id: f83a55c4-1151-41b1-89b0-6ad81ad50d7e
        name: Example work queue
        activeWorkQueueConfiguration:
          assignedProcessId: 5ebaf769-6325-4f8a-b175-aefb150ea64f
          assignedResourceGroupId: 49df134f-974b-4f81-b4a7-8518c04fa970
        activeQueueStats:
          activeSessions: '10'
          availableResources: '5'
          timeRemaining: 01:25:10
          elapsedRemaining: 00:05:10
          ETA: '2020-10-03T13:36:21+02:00'
    WorkQueueConfigurationsPage:
      description: Contains details of a page of work queues configrations.
      type: object
      properties:
        pagingToken:
          nullable: true
          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 work queues configurations.
          items:
            $ref: '#/components/schemas/WorkQueueConfigurationSummary'
      example:
        pagingToken: A5VwZXIgg2VjcmV2IKLcdGEuLFNoaGhu
        items:
        - id: f83a55c4-1151-41b1-89b0-6ad81ad50d7e
          name: Example work queue
          activeWorkQueueConfiguration:
            assignedProcessId: 5ebaf769-6325-4f8a-b175-aefb150ea64f
            assignedResourceGroupId: 49df134f-974b-4f81-b4a7-8518c04fa970
          activeQueueStats:
            activeSessions: '10'
            availableResources: '5'
            timeRemaining: 01:25:10
            elapsedRemaining: 00:05:10
            ETA: '2020-10-03T13:36:21+02:00'
    WorkQueuesItemsPage:
      description: Contains details of a page of work queues.
      type: object
      properties:
        pagingToken:
          nullable: true
          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 work queues.
          items:
            $ref: '#/components/schemas/WorkQueueSummary'
      example:
        pagingToken: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
        items:
        - 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
          isRetryItems: true
          isSnapshotEnabled: true
          isActiveQueue: true
          activeWorkQueueConfiguration:
            assignedProcessId: axe34dfx-1234-2435-fedc-ba9876500987
            assignedResourceGroupId: xv3fd45s-6543-6231-exrf-we23e456781
          activeQueueStats:
            activeSessions: '10'
            availableResources: '5'
            timeRemaining: 01:25:10
            elapsedRemaining: 00:05:10
            ETA: '2020-10-03T13:36:21+02:00'
    ReferencesItemsPage:
      description: Contains references of a specified object.
      type: object
      properties:
        pagingToken:
          $ref: '#/components/schemas/PagingToken'
        items:
          type: array
          description: A collection of references.
          items:
            $ref: '#/components/schemas/Reference'
    CreateWorkQueue:
      description: Contains details for creating a new work queue.
      type: object
      properties:
        name:
          type: string
          description: The name of the queue to create.
          minLength: 1
          maxLength: 255
        keyField:
          type: string
          description: The name of the column to be used as the queue's key.
          minLength: 0
          maxLength: 255
        maxAttempts:
          type: integer
          description: The maximum number of retry attempts for items in the queue.
          minimum: 1
          maximum: 999999
        status:
          $ref: '#/components/schemas/QueueStatus'
        encryptionKeyId:
          type: integer
          description: The ID of the encryption key to use for the queue. If no encryption is required,  this field should
            be 0.
        sessionExceptionRetry:
          type: boolean
          description: Retry items in this queue in the event of an unexpected session termination.
        activeQueueAssignedProcessId:
          type: string
          format: uuid
          description: The ID of the process to use for an active queue.
        activeQueueAssignedResourceGroupId:
          type: string
          format: uuid
          description: The ID of the resource group to use for an active queue.
        groupid:
          type: object
          description: The ID of the group to use for the queue. If no group id is required, this field should be empty string
            like "" or empty Guid - "00000000-0000-0000-0000-000000000000".
      example:
        name: Example queue
        keyField: Example field
        maxAttempts: 3
        status: Running
        encryptionKeyId: 0
        sessionExceptionRetry: false
        activeQueueAssignedProcessId: 658de89c-a43d-4b18-a38c-d26d5eb26659
        activeQueueAssignedResourceGroupId: 5180390c-b21a-4d69-9753-b876e34f100d
        groupid: a4e0b0ba-3b8f-443d-bdb0-ee519299bd01
    UpdateWorkQueue:
      description: Contains details for updating a work queue's information.
      type: object
      properties:
        name:
          type: string
          description: The name of the queue.
          minLength: 1
        keyField:
          type: string
          description: The name of the column to be used as the queue's key.
        maxAttempts:
          type: integer
          description: The maximum number of retry attempts for items in the queue.
          minimum: 0
          default: 3
        status:
          $ref: '#/components/schemas/QueueStatus'
        encryptionKeyId:
          type: integer
          description: The ID of the encryption key to use for the queue. If no encryption is required, this field should
            be 0.
      example:
        name: Example queue
        keyField: Example field
        maxAttempts: 5
        status: Paused
        encryptionKeyId: 0
    WorkQueueItemsPage:
      description: Contains details of a page of work queue items.
      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 work queue items.
          items:
            $ref: '#/components/schemas/WorkQueueItemNoData'
      example:
        pagingToken: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
        items:
        - id: 01234567-89ab-cdef-0123-456789abcdef
          priority: 3
          ident: 5112
          state: Pending
          keyValue: Example value
          status: Example status
          tags:
          - Example tag 1
          - Example tag 2
          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: '0001-01-01T00:00:00Z'
          exceptionedDate: '0001-01-01T00:00:00Z'
          exceptionReason: Example reason
          lastUpdated: '2020-10-02T12:34:56+01:00'
          workTimeInSeconds: 123
          attemptWorkTimeInSeconds: 56
          resource: Example resource
          sessionId: 01234567-89ab-cdef-0123-456789abcdef
          sla: 7200
          slaDateTime: '0001-01-01T00:00:00Z'
          processName: Example process name
          isSuggested: false
    WorkQueueItemNoData:
      description: Contains details of a work queue item but does not return the data contained in it.
      type: object
      properties:
        id:
          type: string
          description: The ID of the item.
          format: uuid
        priority:
          type: integer
          description: The priority value assigned to the item.
        ident:
          type: integer
          description: The database-specific identity of the item.
        state:
          type: string
          enum:
          - None
          - Pending
          - Locked
          - Deferred
          - Completed
          - Exceptioned
          description: The current state of the item.
        keyValue:
          type: string
          description: The value of the key field.
        status:
          type: string
          description: The user-supplied status value.
        tags:
          type: array
          description: A collection of tags assigned to the item.
          items:
            type: string
        attemptNumber:
          type: integer
          description: The number of the attempt next time this item is worked.
          format: integer
          minimum: 1
        loadedDate:
          type: string
          description: The time and date that the item was loaded into the system.
          format: date-time
        deferredDate:
          type: string
          description: The earliest time and date that this item is deferred until.
          format: date-time
        lockedDate:
          type: string
          description: The time and date that this item was locked; or the minimum date-time value if not locked.
          format: date-time
        completedDate:
          type: string
          description: The time and date that this item was completed; or the minimum date-time value if not completed.
          format: date-time
        exceptionedDate:
          type: string
          description: The time and date that this item was marked as exceptioned; or the minimum date-time value if not exceptioned.
          format: date-time
        lastUpdated:
          type: string
          description: The time and date that this item was last updated.
          format: date-time
        workTimeInSeconds:
          type: integer
          description: The number of seconds that this item has been worked on so far (including any previous attempts).
          format: integer
        attemptWorkTimeInSeconds:
          type: integer
          description: The number of seconds that this item has been worked on so far in this attempt.
          format: integer
        exceptionReason:
          type: string
          description: The error message which caused the exception, if any.
        resource:
          type: string
          description: The name of the resource.
        sessionId:
          type: string
          description: The session ID of the item.
          format: uuid
        sla:
          type: integer
          description: Business SLA of the item in seconds.
          format: integer
        slaDatetime:
          type: string
          description: SLA DateTime
          format: date-time
        processName:
          type: string
          description: Process name
        isSuggested:
          type: boolean
          description: Is Suggested
      example:
        id: 01234567-89ab-cdef-0123-456789abcdef
        priority: 3
        ident: 5112
        state: Pending
        keyValue: Example value
        status: Example status
        tags:
        - Example tag 1
        - Example tag 2
        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: '0001-01-01T00:00:00Z'
        exceptionedDate: '0001-01-01T00:00:00Z'
        lastUpdated: '2020-10-02T12:34:56+01:00'
        workTimeInSeconds: 123
        attemptWorkTimeInSeconds: 56
        resource: Example resource
        sessionId: 01234567-89ab-cdef-0123-456789abcdef
        sla: 7200
        slaDateTime: '0001-01-01T00:00:00Z'
        processName: Example process name
        isSuggested: false
    WorkQueueItem:
      description: Contains details of a work queue item including the data.
      type: object
      properties:
        id:
          type: string
          description: The ID of the item.
          format: uuid
        priority:
          type: integer
          description: The priority value assigned to the item.
        ident:
          type: integer
          description: The database-specific identity of the item.
        state:
          type: string
          enum:
          - None
          - Pending
          - Locked
          - Deferred
          - Completed
          - Exceptioned
          description: The current state of the item.
        keyValue:
          type: string
          description: The value of the key field.
        status:
          type: string
          description: The user-supplied status value.
        tags:
          type: array
          description: A collection of tags assigned to the item.
          items:
            type: string
        attemptNumber:
          type: integer
          description: The number of the attempt next time this item is worked.
          format: integer
          minimum: 1
        loadedDate:
          type: string
          description: The time and date that the item was loaded into the system.
          format: date-time
        deferredDate:
          type: string
          description: The earliest time and date that this item is deferred until.
          format: date-time
        lockedDate:
          type: string
          description: The time and date that this item was locked; or the minimum date-time value if not locked.
          format: date-time
        completedDate:
          type: string
          description: The time and date that this item was completed; or the minimum date-time value if not completed.
          format: date-time
        exceptionedDate:
          type: string
          description: The time and date that this item was marked as exceptioned; or the minimum date-time value if not exceptioned.
          format: date-time
        exceptionReason:
          type: string
          description: The error message which caused the exception, if any.
        lastUpdated:
          type: string
          description: The time and date that this item was last updated.
          format: date-time
        workTimeInSeconds:
          type: integer
          description: The number of seconds that this item has been worked on so far (including any previous attempts).
          format: integer
        attemptWorkTimeInSeconds:
          type: integer
          description: The number of seconds that this item has been worked on so far in this attempt.
          format: integer
        resource:
          type: string
          description: The name of the resource.
        sessionId:
          type: string
          description: The ID of the session.
          format: uuid
        sla:
          type: integer
          description: Business SLA of the item in seconds.
          format: integer
        slaDateTime:
          type: string
          description: SLA DateTime
          format: date-time
        processName:
          type: string
          description: Process name
        isSuggested:
          type: boolean
          description: Is Suggested
        data:
          $ref: '#/components/schemas/DataCollection'
      example:
        id: 01234567-89ab-cdef-0123-456789abcdef
        priority: 3
        ident: 123
        state: Completed
        keyValue: Example value
        status: Example status
        tags:
        - Example tag 1
        - Example tag 2
        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
        sessionId: 01234567-89ab-cdef-0123-456789abcdef
        data:
          rows:
          - valueType: Number
            value: 321
          - valueType: Date
            value: '2020-10-02T12:34:56+01:00'
        sla: 7200
        slaDateTime: '0001-01-01T00:00:00Z'
        processName: Example process name
        isSuggested: false
    CreateWorkQueueItems:
      description: Contains details for creating a number of work queue items.
      type: array
      items:
        $ref: '#/components/schemas/CreateWorkQueueItem'
    CreateWorkQueueItem:
      description: Contains details for creating a work queue item in a queue.
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DataCollection'
        deferredDate:
          type: string
          nullable: true
          description: The earliest time and date that this item is deferred until.
          format: date-time
        priority:
          type: integer
          description: The priority value assigned to the item.
          format: integer
        tags:
          type: array
          description: A collection of tags assigned to the item.
          items:
            type: string
        status:
          type: string
          description: The user-supplied status value.
        sla:
          type: integer
          nullable: true
          description: The user-supplied sla value.
        processName:
          type: string
          description: The user-supplied process name value.
        isSuggested:
          type: boolean
          description: The user-supplied isSuggested value - default value should be false.
      example:
        data:
          rows:
          - valueType: Number
            value: 321
          - valueType: Date
            value: '2020-10-02T12:34:56+01:00'
        deferredDate: '2020-10-02T12:34:56+01:00'
        priority: 3
        tags:
        - Example tag 1
        - Example tag 2
        status: Example status
        sla: 7200
        processName: Example process name
        isSuggested: false
    QueueStatus:
      description: The current status of the queue.
      type: string
      enum:
      - Running
      - Paused
    CreateWorkQueueItemAttemptResponseModel:
      description: Contains the ID of a new work queue item attempt.
      type: object
      properties:
        attemptId:
          type: integer
          description: The ID of the work queue item attempt.
    CreateWebhookWorkQueueItem:
      description: Contains details for creating a webhook subscriptions for a work queue item in a queue.
      type: object
      required:
      - eventtypes
      - callbackurl
      properties:
        eventtypes:
          type: array
          description: List of events that trigger the webhook.
          items:
            type: string
            enum:
            - exception
            - completed
            - prioritychanged
            - dataupdated
            - status
            - deferred
            - locked
            - retryexception
        callbackurl:
          type: string
          description: The url to send callbacl request.
          format: uri
          example: https://your-api.com/webhook/callback
        extensions:
          type: object
          description: Optional security and metadata configuration.
          required:
          - security
          properties:
            data:
              type: object
              description: Custom JSON object for client-specific metadata. Can be empty
              additionalProperties: true
              example:
                clientId: '1'
            security:
              type: object
              description: The authentication callback detailes.
              required:
              - credentialName
              - type
              properties:
                credentialName:
                  description: The name of the credentials registered in BPE Credential Manager.
                  type: string
                  example: Client1
                type:
                  type: string
                  description: The type of the credentials.
                  example: BasicAuthentication
    WorkQueueItemWebhookSubscriptionResponse:
      description: Response containing webhook subscription details.
      type: object
      required:
      - id
      - secret
      - subscriptions
      properties:
        id:
          type: string
          format: uuid
          description: The ID of the webhook subscription.
        secret:
          type: string
          description: The secret for validating webhook payloads.
        subscriptions:
          type: array
          description: The list of subscriptions according to event types.
          items:
            $ref: '#/components/schemas/WorkQueueItemEventSubscriptionResponse'
    WorkQueueItemSubscriptionCustomResponse:
      description: Response containing custom subscription details.
      type: object
      required:
      - subscriptionId
      - subscriptions
      properties:
        subscriptionId:
          type: string
          format: uuid
          description: The ID of the subscription.
      subscriptions:
        type: array
        description: The list of subscriptions according to event types.
        items:
          $ref: '#/components/schemas/WorkQueueItemEventSubscriptionResponse'
    WorkQueueItemEventSubscriptionResponse:
      type: object
      description: The subscription created for an event type.
      properties:
        subscriptionId:
          type: string
          description: The ID of the subscription.
          format: uuid
        eventType:
          type: string
          description: The event type subscribed to.
          example: exception
    EncryptionScheme:
      description: Contains details of an encryption scheme.
      type: object
      properties:
        name:
          type: string
          description: The name of the encryption scheme.
        algorithm:
          type: string
          enum:
          - None
          - TripleDES
          - Rijndael256
          - AES256
          description: The name of the encryption algorithm.
        keyLocation:
          type: string
          enum:
          - Database
          - Server
          description: If the key is stored in the database or server.
        isAvailable:
          type: boolean
          description: If the encryption scheme is available.
      example:
        name: Example encryption scheme
        algorithm: AES256
        keyLocation: Server
        isAvailable: true
    EnvironmentVariable:
      description: Contains details of an environment variable.
      type: object
      properties:
        id:
          type: string
          description: The id of the environment variable.
          format: uuid
        name:
          type: string
          description: The name of the environment variable.
        description:
          type: string
          description: The description of the environment variable.
        dataType:
          type: string
          description: The type of the environment variable.
        value:
          type: object
          description: The value of the environment variable.
          nullable: true
    EnvironmentVariableItemsPage:
      description: Contains details of a page of environment variables.
      type: object
      properties:
        pagingToken:
          $ref: '#/components/schemas/PagingToken'
        items:
          type: array
          description: A collection of environment variables.
          items:
            $ref: '#/components/schemas/EnvironmentVariable'
    EnvironmentVariableReferencesItemsPage:
      description: Contains details of a page of environment variables references.
      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 environment variables references.
          items:
            $ref: '#/components/schemas/Reference'
    Health:
      description: Contains details of API health and its dependencies.
      type: object
      properties:
        healthy:
          type: boolean
          description: The overall health status of the API.
        dependencies:
          type: array
          description: The health of API dependencies
          items:
            $ref: '#/components/schemas/Dependency'
    Dependency:
      description: Contains details of API dependency health
      type: object
      properties:
        name:
          type: string
          description: The name of the dependency
          example: database
        healthy:
          type: boolean
          description: The health status of the dependency
    License:
      description: Contains details of the license.
      type: object
      properties:
        id:
          type: integer
          description: The ID of the license.
        status:
          type: string
          enum:
          - Future
          - Expired
          - ExpiresSoon
          - GracePeriodEndsSoon
          - RequiresActivation
          - Active
          description: The status of the license.
        activationStatus:
          type: string
          enum:
          - NotApplicable
          - NotActivated
          - Activated
          description: The activationStatus of the license.
        owner:
          type: string
          description: The owner of the license.
        type:
          type: string
          enum:
          - None
          - Enterprise
          - NHS
          - Evaluation
          - Education
          - Desktop
          description: The type of the license.
        starts:
          type: string
          description: The date on which this license comes into effect.
          format: date-time
        expires:
          type: string
          description: The date at which this license expires.
          format: date-time
        processes:
          type: string
          description: The number of processes.
        sessions:
          type: string
          description: The number of sessions.
        resources:
          type: string
          description: The number of resources.
        alerts:
          type: string
          description: The number of alerts.
        standalone:
          type: boolean
          description: Does this license standalone?
        decipherIDP:
          type: boolean
          description: Does this license have decipher permissions?
      example:
        id: 1
        status: Active
        owner: Test License
        activationStatus: NotApplicable
        type: Enterprise
        starts: '2021-01-31'
        expires: '2023-01-31'
        processes: '1'
        sessions: unlimited
        resources: '5'
        alerts: '50'
        standalone: true
        decipherIDP: false
    LicensesItemsPage:
      description: Contains basic details of a licenses.
      type: object
      properties:
        pagingToken:
          $ref: '#/components/schemas/PagingToken'
        items:
          type: array
          description: A collection of licenses.
          items:
            $ref: '#/components/schemas/License'
    AddLicense:
      description: Contains details for adding a new license key.
      type: object
      properties:
        encodedLicenseKey:
          type: string
          description: The encoded license key.
      example:
        encodedLicenseKey: PD94bWwgdmVyc2lvbj0iMS4
    AddLicenseResponseModel:
      description: Contains the information of an added license.
      type: object
      properties:
        id:
          type: integer
          description: The ID of the license.
        status:
          type: string
          enum:
          - Future
          - Expired
          - ExpiresSoon
          - GracePeriodEndsSoon
          - RequiresActivation
          - Active
          description: The status of the license.
        expires:
          type: string
          description: The date at which this license expires.
          format: date-time
        owner:
          type: string
          description: The owner of the license.
      example:
        id: 1
        status: Active
        expires: '2023-01-31'
        owner: Test License
    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'
    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'
    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.
    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.
    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.
    CreateScheduledSessionResponse:
      description: Contains ID of created scheduled session.
      type: object
      properties:
        scheduledSessionId:
          description: The ID of the created scheduled session.
          type: integer
    CreateScheduledTaskResponse:
      description: Contains ID of created task.
      type: object
      properties:
        taskId:
          type: integer
          description: The ID of the created task.
    UpdateSchedule:
      description: Contains details for updating a schedule.
      type: object
      properties:
        isRetired:
          type: boolean
          description: A new value for schedule retirement status.
    ScheduledSessionArguments:
      description: Contains details of start-up parameters.
      type: array
      items:
        $ref: '#/components/schemas/ScheduledSessionArgumentsModel'
    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
    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.
    Process:
      description: Contains details of a published process.
      type: object
      properties:
        processId:
          type: string
          description: The ID of the process.
          format: uuid
        processName:
          type: string
          description: The name of the process.
        processDescription:
          type: string
          description: The description of the process.
        groupId:
          type: string
          description: The ID of group related to the process.
          format: uuid
        groupName:
          type: string
          description: The name of the group related to the process.
        attributes:
          type: array
          description: The attributes of the process.
          items:
            $ref: '#/components/schemas/ProcessAttribute'
      example:
        processId: 01234567-89ab-cdef-0123-456789abcdef
        processName: Process_Name
        processDescription: Process_Description
        groupId: 99e23d41-e8ec-4ffe-89c9-93814d70d551
        groupName: Group_name
        attributes:
        - Retired
        - Published
        - PublishedWebService
    ProcessAttribute:
      description: The attributes of the process.
      type: string
      enum:
      - None
      - Retired
      - Published
      - PublishedWebService
      - PublishedDesktop
    ProcessAttributeFilter:
      description: The attributes of the process to filter by.
      type: string
      enum:
      - Retired
      - Published
      - PublishedWebService
      - PublishedDesktop
    ProcessItemsPage:
      description: Contains details of a page of processes.
      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 processes.
          items:
            $ref: '#/components/schemas/Process'
      example:
        pagingToken: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
        items:
        - processId: 01234567-89ab-cdef-0123-456789abcdef
          processName: Process_Name
          processDescription: Process_Description
          groupId: 99e23d41-e8ec-4ffe-89c9-93814d70d551
          groupName: Group_name
          attributes:
          - Retired
          - PublishedWebService
    ProcessGroupItemItemsPage:
      description: Contains details of a page of nodes in the process group tree.
      type: object
      properties:
        pagingToken:
          type: string
          description: The token to be used in the next request to return the next collection of items.
          nullable: true
        items:
          type: array
          description: A collection of processes / process groups.
          items:
            $ref: '#/components/schemas/ProcessGroupItem'
      example:
        pagingToken: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
        items:
        - id: 01234567-89ab-cdef-0123-456789abcdef
          name: Process_Name
          nodeType: Item
          lastModified: '2022-04-01T09:05:10.64+01:00'
    ProcessGroupItem:
      description: Contains details of a process group tree node.
      type: object
      properties:
        id:
          type: string
          description: The ID of the process or group.
          format: uuid
        name:
          type: string
          description: The name of the process or group.
        nodeType:
          type: string
          enum:
          - Item
          - Group
          description: The type of this tree node - Item or Group.
        lastModified:
          type: string
          format: date-time
          description: The last modified date of the process it this is an item node. Default date value is this is a group
            node.
          example: '2020-10-02T12:34:56+02:00'
      example:
        id: 01234567-89ab-cdef-0123-456789abcdef
        name: Process_Name
        nodeType: Item
        lastModified: '2022-04-01T09:05:10.64+01:00'
    Resource:
      description: Contains details of a runtime resource.
      type: object
      properties:
        id:
          type: string
          description: The ID of the resource.
          format: uuid
        name:
          type: string
          description: The name of the resource.
        poolId:
          type: string
          description: The ID of the pool to which the resource belongs.
          format: uuid
        poolName:
          type: string
          description: The name of the pool to which the resource belongs.
        groupId:
          type: string
          description: The ID of the group to which the resource or its pool belongs.
          format: uuid
        groupName:
          type: string
          description: The name of the group to which the resource or its pool belongs.
        attributes:
          type: array
          description: The attributes of the resource.
          items:
            $ref: '#/components/schemas/ResourceAttribute'
        activeSessionCount:
          type: integer
          description: The number of active sessions on the resource.
        warningSessionCount:
          type: integer
          description: The number of warning sessions on the resource.
        pendingSessionCount:
          type: integer
          description: The number of pending sessions on the resource.
        databaseStatus:
          type: string
          enum:
          - Unknown
          - Ready
          - Offline
          - Pending
          description: The reported status of the resource.
        displayStatus:
          type: string
          enum:
          - Working
          - Idle
          - Warning
          - Offline
          - Missing
          - LoggedOut
          - Private
          - Details
          - BPD
          - Hybrid
          description: The calculated state of the resource.
        resourceType:
          type: string
          enum:
          - Desktop
          - Enterprise
          - RemoteDigitalWorker
          description: The calculated type of the resource
      example:
        id: 01234567-89ab-cdef-0123-456789abcdef
        name: Example
        poolId: 99e23d41-e8ec-4ffe-89c9-93814d70d551
        poolName: Pool name
        groupId: fedcba98-7654-3210-fedc-ba9876543210
        groupName: Example group
        attributes:
        - None
        activeSessionCount: 5
        warningSessionCount: 1
        pendingSessionCount: 2
        databaseStatus: Ready
        displayStatus: Working
        resourceType: Desktop
    ResourceAttribute:
      description: The attributes of the resource.
      type: string
      enum:
      - None
      - Retired
      - Local
      - LoginAgent
      - Private
      - DefaultInstance
      - Desktop
      - RemoteDigitalWorker
      - Pool
    UpdateResource:
      description: Contains details to update a runtime resource's attributes.
      type: object
      properties:
        attributes:
          description: The attributes to assign to the resource.
          type: array
          items:
            $ref: '#/components/schemas/ResourceAttribute'
      example:
        attributes:
        - Retired
        - None
    ResourceItemsPage:
      description: Contains details of a page of runtime resources.
      type: object
      properties:
        pagingToken:
          type: string
          nullable: true
          description: The token to be used in the next request to return the next collection of items.
        items:
          type: array
          description: A collection of resources.
          items:
            $ref: '#/components/schemas/Resource'
      example:
        pagingToken: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
        items:
        - id: 01234567-89ab-cdef-0123-456789abcdef
          name: Example
          poolId: 99e23d41-e8ec-4ffe-89c9-93814d70d551
          poolName: Pool name
          groupId: fedcba98-7654-3210-fedc-ba9876543210
          groupName: Example group
          attributes:
          - None
          activeSessionCount: 5
          warningSessionCount: 1
          pendingSessionCount: 2
          databaseStatus: Ready
          displayStatus: Working
          resourceType: Desktop
    CreateEnvironmentVariableModel:
      description: Contains details for creating a new environment variable.
      type: object
      properties:
        name:
          type: string
          description: The name of the environment variable to create.
          minLength: 1
          maxLength: 64
        description:
          type: string
          description: The description of the environment variable.
        dataType:
          type: string
          description: Valid types for environment variables - Date (date), DateTime (date-time), Flag (boolean), Number (integer),
            Password (string), Text (string), Time (date), TimeSpan (time), Image (base64), Binary (base64), RadioButtons
            (object radioButtons).
        value:
          description: The value of the environment variable of a valid type that the user provides to save to the DB.
          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.
          - type: string
            format: date
            description: Used for Date, DateTime 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/RadioButtons'
            description: Used for the RadioButtons data type.
      example:
        name: Test environment variable
        description: Any text
        value: Any text
        dataType: Text
    RadioButtons:
      description: Contains details for creating a new collection of radio buttons.
      type: array
      items:
        $ref: '#/components/schemas/RadioButton'
    RadioButton:
      type: object
      description: Contains details for creating a new radio button.
      properties:
        name:
          type: string
          description: The name of the radio button.
        selected:
          type: boolean
          description: Returns True if the radio button is selected.
      example:
        name: button1
        selected: true
    FullStringFilter:
      description: Used to filter strings. Check for strings that start with, contain, equal, are greater than, are less than,
        or are between the given value(s).
      type: object
      anyOf:
      - $ref: '#/components/schemas/StringFilter'
      - $ref: '#/components/schemas/RangeOrEqualFilter'
      example:
        ctn: null
        strtw: null
        gte: null
        lte: null
        eq: null
    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
    BasicNumericFilter:
      description: Used to filter numbers. Check for numbers that start with, equal, are greater than, are less than, or are
        between the given values(s).
      type: object
      oneOf:
      - $ref: '#/components/schemas/RangeOrEqualFilter'
      - $ref: '#/components/schemas/StartsWithStringFilter'
      example:
        strtw: null
        eq: null
        lte: null
        gte: null
    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
    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
    StringFilter:
      description: Used to filter strings. Check for strings that start with, and/or contain the given value(s).
      type: object
      anyOf:
      - $ref: '#/components/schemas/ContainsStringFilter'
      - $ref: '#/components/schemas/StartsWithStringFilter'
      example:
        ctn: null
        strtw: null
    ContainsStringFilter:
      description: Used to filter strings. Check for strings that contain the given value.
      type: object
      properties:
        ctn:
          type: string
          description: The value that the field should contain.
          nullable: true
      example:
        ctn: null
    StartsWithStringFilter:
      description: Used to filter strings. Check for strings that start with the given value.
      type: object
      properties:
        strtw:
          type: string
          description: The value that the field should start with.
          nullable: true
      example:
        strtw: 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
          description: The value that the field should be greater than or equal to.
          nullable: true
      example:
        gte: null
    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
          description: The value that the field should be less than or equal to.
          nullable: true
      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
          description: The value that the field should be equal to.
          nullable: true
      example:
        eq: null
    PatchRequest:
      description: A request containing a JSON Patch document. See PatchDocument for details.
      type: array
      items:
        $ref: '#/components/schemas/PatchDocument'
    PatchDocument:
      description: A JSONPatch document as defined by RFC 6902. See http://jsonpatch.com/
      required:
      - op
      - path
      properties:
        op:
          type: string
          description: The operation to be performed.
          enum:
          - add
          - remove
          - replace
          - move
          - copy
        path:
          type: string
          description: A JSON-Pointer.
        value:
          type: object
          description: The value to be used within the operations..
        from:
          type: string
          description: A string containing a JSON Pointer value.
    Error:
      description: A general error occurred. See errorMessage for details.
      type: object
      properties:
        errorMessage:
          description: A message describing the problem encountered.
          type: string
    ErrorMessage:
      description: A message describing the problem encountered.
      type: string
    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.
    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.
    Identifier:
      description: A GUID resource ID.
      type: object
      properties:
        id:
          type: string
          description: The ID of the newly created resource.
          format: uuid
    Identifiers:
      description: A collection of GUID resource IDs.
      type: object
      properties:
        ids:
          description: A collection of resource IDs.
          type: array
          items:
            type: string
            description: The IDs of the newly created items.
            format: uuid
    PagingToken:
      type: string
      description: The token to be used in the next request to return the next collection of items.
      example: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
    Reference:
      description: Contains details of referenced item.
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The ID of the process/object.
        name:
          type: string
          description: The name of the process/object.
          minLength: 1
        description:
          type: string
          description: The description of process/object.
        type:
          type: string
          enum:
          - Process
          - Object
          - Unset
          description: The type of process/object
    ProcessType:
      description: The process type of environment variable reference.
      type: string
      enum:
      - Process
      - Object
    Calendar:
      description: A model of calendar.
      type: object
      properties:
        id:
          type: integer
          description: The ID of the calendar.
        name:
          type: string
          description: The name of the calendar.
        workingWeek:
          type: array
          description: An array of days in the working work.
          items:
            type: string
        region:
          $ref: '#/components/schemas/Region'
      example:
        id: 1
        name: Working Week / No Holidays
        workingWeek:
        - Monday
        - Tuesday
        region:
          regionId: 1
          disabledPublicHolidaysIds:
          - 1
          - 2
    Region:
      description: A model of region.
      type: object
      properties:
        regionId:
          type: integer
          description: The ID of the region.
        disabledPublicHolidaysIds:
          type: array
          description: An array of IDs of the disabled public holidays.
          items:
            type: integer
            description: The ID of disabled public holidays.
      example:
        regionId: 1
        disabledPublicHolidaysIds:
        - 1
        - 2
    HolidayRegion:
      description: A model of holiday region.
      type: object
      properties:
        id:
          type: integer
          description: The ID of the holiday region.
        name:
          type: string
          description: The name of the region.
      example:
        id: 1
        name: England and Wales
    HolidayByRegionId:
      description: A model of holiday by region id.
      type: object
      properties:
        publicHolidayId:
          type: integer
          description: The ID of the holiday by region id.
        name:
          type: string
          description: The name of the public holiday.
        nextDate:
          type: string
          description: The next date of the public holiday.
      example:
        publicHolidayId: 33
        name: Coming of Age Day
        nextDate: 10/01/2023
    CreateCalendarModel:
      description: Contains details for creating a new calendar.
      type: object
      properties:
        name:
          type: string
          description: The name of the calendar to create.
          minLength: 1
          maxLength: 128
        workingWeek:
          type: array
          description: An array of working week. Each day can be added only 1 time.
          items:
            type: string
            enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
        region:
          type: object
          description: A region of the calendar.
          properties:
            regionId:
              type: integer
              description: The Id of the region.
            disabledPublicHolidaysIds:
              type: array
              description: An array of disabled public holidays Ids. Each holidays can be added only 1 time.
              items:
                type: integer
          nullable: true
    CloneCalendarModel:
      description: Contains details for cloning a calendar with a new name.
      type: object
      properties:
        name:
          type: string
          description: The name of the calendar to create.
          minLength: 1
          maxLength: 128
    OtherHolydaysModel:
      description: Contains details for other holidays.
      type: object
      properties:
        holidays:
          type: array
          description: An array of other holidays.
          items:
            type: string
            format: date
    CreateCalendarResponseModel:
      description: Contains the ID of a calendar.
      type: object
      properties:
        id:
          type: integer
          description: The ID of the calendar.
    ResourcePool:
      description: A model of resource pool.
      type: object
      properties:
        id:
          type: string
          description: The ID of the resource pool.
          format: uuid
        name:
          type: string
          description: The name of the pool.
        members:
          type: integer
          description: The number of resources in the pool.
        databaseStatus:
          type: string
          enum:
          - Unknown
          - Ready
          - Offline
          - Pending
          description: The reported status of the resource pool.
      example:
        id: 1
        name: Test Pool
        members: 3
        databaseStatus: Ready
    ResourceUtilization:
      description: A model of resource utilization per hour.
      type: object
      properties:
        resourceId:
          type: string
          description: The ID of the resource.
          format: uuid
        digitalWorkerName:
          type: string
          description: The name of the resource.
        utilizationDate:
          type: string
          description: The date of the resource utilization.
          format: date-time
          example: '2020-10-02T12:34:56+02:00'
        usages:
          type: array
          description: An array of 24 items representing each hour of a day. Each item contains the number of minutes of that
            hour that the resource was working.
          items:
            type: integer
            description: The number of minutes that the resource was working in this hour.
    ResourcesSummaryUtilization:
      description: A model of average resource utilization per day.
      type: object
      properties:
        usagehour:
          type: string
          description: The date of the resource utilization.
          format: date-time
          example: '2020-10-02T12:34:56+02:00'
        usage:
          type: integer
          description: The average resource utilization per hour in minutes.
    WorkQueueComposition:
      description: A summary of work queue items.
      type: object
      properties:
        id:
          type: string
          description: The ID of the work queue.
          format: uuid
        name:
          type: string
          description: The name of work queue.
        completed:
          type: integer
          description: A count of completed items in work queue.
        pending:
          type: integer
          description: A count of pending items in work queue.
        deferred:
          type: integer
          description: A count of deferred items in work queue.
        locked:
          type: integer
          description: A count of locked items in work queue.
        exceptioned:
          type: integer
          description: A count of exceptioned items in work queue.
    LicensesEntitlement:
      description: A summary of an aggregated licenses entitlement data.
      type: object
      properties:
        activeLicenseTypes:
          description: An array of types of an active licenses.
          type: array
          items:
            type: string
            enum:
            - Enterprise
            - NHS
            - Evaluation
            - Education
            - Desktop
        enterpriseEntitlement:
          type: object
          $ref: '#/components/schemas/BaseEntitlement'
          description: A summary of an aggregated enterprise licenses entitlement data.
        desktopEntitlement:
          type: object
          $ref: '#/components/schemas/BaseEntitlement'
          description: A summary of an aggregated desktop licenses entitlement data.
    BaseEntitlement:
      description: An aggregated licenses entitlement data.
      type: object
      properties:
        publishedprocesseslimit:
          type: integer
          description: Number of processes that can be published.
        concurrentsessionslimit:
          type: integer
          description: Number of concurrent sessions which can be ran.
        runtimeresourceslimit:
          type: integer
          description: Number of resources which can be registered at any one time.
        processalertmachineslimit:
          type: integer
          description: Number of machines which Process Alerts can be used.
    LicenseUsageDetailsModel:
      description: A summary of active licenses limits and usages
      type: object
      properties:
        publishedProcessesLimit:
          type: integer
          nullable: true
          description: The number of processes that active licenses permit to be published or null if unlimited.
          example: null
        publishedProcessesUsed:
          type: integer
          description: The number of published processes (excluding retired processes) currently in use.
          example: 5
        concurrentSessionsLimit:
          type: integer
          nullable: true
          description: The number of concurrent sessions that active licenses permit or null if unlimited.
          example: 50
        concurrentSessionsUsed:
          type: integer
          description: The number of current pending, running or stopping sessions.
          example: 7
        runtimeResourcesLimit:
          type: integer
          nullable: true
          description: The number of machines that active licenses permit or null if unlimited.
          example: 150
        runtimeResourcesUsed:
          type: integer
          description: The number of machines currently in use.
          example: 72
        processAlertMachinesLimit:
          type: integer
          nullable: true
          description: The number of machines on which this set of licenses permits process alerts or null if unlimited.
          example: 50
        processAlertMachinesUsed:
          type: integer
          description: The number of machines with alerts currently in use.
          example: 17
  examples:
    EnvironmentVariableRadioButtonsExample:
      summary: RadioButtons
      value:
        pagingToken: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
        items:
        - name: name of the radiobuttons variable
          description: description of the radiobuttons variable
          dataType: radiobuttons
          value:
          - name: rb1
            selected: true
          - name: rb2
            selected: false
    EnvironmentVariableTextExample:
      summary: Text
      value:
        pagingToken: U3VwZXIgc2VjcmV0IGRhdGEuIFNoaGho
        items:
        - name: name of the text variable
          description: description of the text variable
          dataType: text
          value: text value
    PatchAddToArrayExample:
      summary: Add values to a collection.
      value:
      - op: add
        path: /someArrayProperty
        value:
        - item1
        - item2
    PatchAddToObjectExample:
      summary: Add new property values to an object.
      value:
      - op: add
        path: /property
        value: propertyValue
    PatchCopyExample:
      summary: Copy a value from one property to another.
      value:
      - op: copy
        from: /sourceProperty
        path: /destinationProperty
    PatchMoveExample:
      summary: Move a value from one property to another.
      value:
      - op: move
        from: /sourceProperty
        path: /destinationProperty
    PatchReplaceExample:
      summary: Replace the value in a property.
      value:
      - op: replace
        path: /property
        value: propertyValue
    PatchRemoveExample:
      summary: Remove a property value.
      value:
      - op: remove
        path: /propertyToDeleteValueFrom
    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).
    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).
    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).
    TimeEqualsExample:
      value:
        eq: '12:34:56'
      summary: Search for a value equal to 12:34:56.
    TimeRangeExample:
      value:
        gte: 01:23:45
        lte: '12:34:56'
      summary: Search for a value between 01:23:45 and 12:34:56 (inclusive)
    TimeLessThanExample:
      value:
        lte: '12:34:56'
      summary: Search for a value less than or equal to 12:34:56
    IntegerStartsWithExample:
      value:
        strtw: 123
      summary: Search for a value starting with 123
    IntegerEqualsExample:
      value:
        eq: 123
      summary: Search for a value equal to 123.
    IntegerRangeExample:
      value:
        gte: 123
        lte: 321
      summary: Search for a value between 123 and 321 inclusive.
    IntegerLessThanExample:
      value:
        lte: 123
      summary: Search for a value less than or equal to 123.
    IntegerGreaterThanExample:
      value:
        gte: 123
      summary: Search for a value greater than or equal to 123.
    StringEqualsExample:
      value:
        eq: Example
      summary: Search for a value equal to "Example".
    StringContainsExample:
      value:
        ctn: amp
      summary: Search a value containing "amp"
    StringStartsWithExample:
      value:
        strtw: Exa
      summary: Search a value starting with "Exa".
    StringRangeExample:
      value:
        gte: Ex
        lte: F
      summary: Search for a value alphanumerically between "Ex" and "F".
    StringGreaterThanExample:
      value:
        gte: Example
      summary: Search for a value alphanumerically after or equal to "Example".