Workday Business Processes 09/28/2024 API

openapi: 3.2.0
info:
  title: Changelog for businessProcess 09/28/2024 API
  description: The public APIs to access event actions and details
  version: v1
servers:
- url: https://<tenantHostname>/businessProcess/v1
tags:
- name: 09/28/2024
  description: Changes for v2024.39
paths:
  2024.39/events/{ID}/cancel:
    post:
      tags:
      - 09/28/2024
      summary: Added new operation
      description: 'Cancels the business process event specified by the ID. In the request body, specify these required fields: comment.


        Secured by: Core Navigation, Public Business Processes


        Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Tenant Non-Configurable


        View this Endpoint: POST /events/{ID}/cancel'
      parameters:
      - name: ID
        in: path
        description: The Workday ID of the resource.
        required: true
        explode: false
        schema:
          type: string
          exampleSetFlag: false
          types:
          - string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/businessProcessEventAction_46302b0ce6a810001fcbad0bc1e30000'
              exampleSetFlag: false
            exampleSetFlag: false
        required: true
      responses:
        '201':
          description: Resource created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/businessProcessEventAction_46302b0ce6a810001fcbad0bc1e30000'
                exampleSetFlag: false
              exampleSetFlag: false
        '400':
          description: 'Invalid request. (https://community.workday.com/rest/error-messages)

            Error Code | Validation Message

            --- | ---

            A181 | You need to specify a comment.

            A219 | You can''t cancel this business process because the event isn''t in progress or in error.

            A2198 | You can''t cancel this event because this action isn''t supported on the subprocess.

            A2199 | You can''t cancel this event because this action isn''t supported on the business process.

            A2200 | You can''t cancel this event because this action isn''t currently supported on the business process.

            A2201 | You currently don''t have security access to cancel this event.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
                exampleSetFlag: false
              exampleSetFlag: false
        '401':
          description: Invalid resource or operation. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
                exampleSetFlag: false
              exampleSetFlag: false
        '403':
          description: User has insufficient permissions. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
                exampleSetFlag: false
              exampleSetFlag: false
        '404':
          description: Resource not found. (https://community.workday.com/rest/error-messages)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE'
                exampleSetFlag: false
              exampleSetFlag: false
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERROR_MODEL_REFERENCE'
                exampleSetFlag: false
              exampleSetFlag: false
      extensions:
        x-workday-confidence-level: Production
        x-workday-internal-try-enabled: 'false'
        x-codegen-request-body-name: businessProcessEventAction
      operationId: post202439EventsByIDCancel
      x-operation-id-source: derived
components:
  schemas:
    businessProcessEventAction_46302b0ce6a810001fcbad0bc1e30000:
      exampleSetFlag: false
      allOf:
      - type: object
        properties:
          comment:
            type: string
            description: comment
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            extensions:
              x-workday-type: Text
            exampleSetFlag: true
            types:
            - string
          status:
            type: string
            description: status
            example: Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.
            extensions:
              x-workday-type: Text
            exampleSetFlag: true
            types:
            - string
          descriptor:
            type: string
            description: The display name of the instance
            example: Lorem ipsum dolor sit ame
            exampleSetFlag: true
            types:
            - string
          id:
            type: string
            description: Workday Id or Reference Id of the instance.
            exampleSetFlag: false
            types:
            - string
        exampleSetFlag: false
        types:
        - object
    VALIDATION_ERROR_MODEL_REFERENCE:
      exampleSetFlag: false
      allOf:
      - required:
        - error
        type: object
        properties:
          error:
            type: string
            description: A description of the error
            exampleSetFlag: false
            types:
            - string
          errors:
            type: array
            description: An array of validation errors
            exampleSetFlag: false
            items:
              $ref: '#/components/schemas/ERROR_MODEL_REFERENCE'
              exampleSetFlag: false
            types:
            - array
        exampleSetFlag: false
        types:
        - object
    ERROR_MODEL_REFERENCE:
      required:
      - error
      type: object
      properties:
        error:
          type: string
          description: A description of the error
          exampleSetFlag: false
          types:
          - string
        code:
          type: string
          description: The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change
          exampleSetFlag: false
          types:
          - string
        field:
          type: string
          description: The field related to the error
          exampleSetFlag: false
          types:
          - string
        path:
          type: string
          description: The path of the field related to the error
          exampleSetFlag: false
          types:
          - string
        severity:
          type: string
          description: Severity of the validation (e.g. Critical, Warning).
          exampleSetFlag: false
          types:
          - string
        internalMessage:
          type: string
          description: Internal message providing additional context for the validation (e.g. representation content validation details).
          exampleSetFlag: false
          types:
          - string
      exampleSetFlag: false
      types:
      - object
  securitySchemes:
    OAuth2:
      type: OAUTH2
      flows:
        implicit:
          authorizationUrl: https://<tenantAuthorizationHostname>
          scopes: {}