Workday Business Processes 04/24/2023 API

openapi: 3.2.0
info:
  title: Changelog for businessProcess 04/24/2023 API
  description: The public APIs to access event actions and details
  version: v1
servers:
- url: https://<tenantHostname>/businessProcess/v1
tags:
- name: 04/24/2023
  description: Changes for v2023.16
paths:
  2023.16/eventSteps/{ID}/questionnaire:
    post:
      tags:
      - 04/24/2023
      summary: Added new operation
      description: 'Post an action for a Complete Questionnaire step in a business process.

        Specify these required fields in the request body if the intended action is Submit or Save for Later: {stepAction, questionnaireResponse}.

        You can send Save for Later multiple times, but {questionnaireResponse} values will replace the existing questionnaire answers.

        If the intended action is Skip, exclude {questionnaireResponse} from the request body.


        Valid values for stepAction are:

        { "id": "133d5c88baa64136aab041c1d2e9ed53" } for Submit,

        { "id": "d9e41a8c446c11de98360015c5e6daf6" } for Save for Later,

        { "id": "d9e4231a446c11de98360015c5e6daf6" } for Skip.


        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 /eventSteps/{ID}/questionnaire'
      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/completeQuestionnaireEventStep_3544fcea2784100018ee4286aeca0000'
              exampleSetFlag: false
            exampleSetFlag: false
        required: true
      responses:
        '201':
          description: Resource created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/completeQuestionnaireEventStep_3544fcea2784100018ee4286aeca0000'
                exampleSetFlag: false
              exampleSetFlag: false
        '400':
          description: 'Invalid request. (https://community.workday.com/rest/error-messages)

            Error Code | Validation Message

            --- | ---

            A212 | This event step isn''t awaiting your action

            A1584 | Specify a questionnaire response.

            A1585 | Specify a complete questionnaire.

            A1649 | You can’t skip this step if you provide a questionnaire response.

            A1650 | Specify Submit, Save for Later or Skip. This step type doesn''t support other actions.

            A1651 | This step is required.

            - | All answered questions must be questions from the associated questionnaire.

            - | All answers you submit must match the expected format for that question type.

            - | This questionnaire has already been skipped. You can’t submit it again.

            - | This questionnaire is now closed. You can no longer submit new responses or change your existing responses.

            - | This questionnaire was submitted already. You can’t submit it again.

            - | This questionnaire was submitted already. You can’t submit it again.

            - | You cannot submit answers to branching questions without answers for parent questions.

            - | You have selected an invalid answer choice.

            - | You have submitted more multiple choice answers than is allowed for a question.

            - | You have submitted more than one answer for a single select multiple choice question.

            - | You must answer all required questions.'
          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-try-enabled: 'false'
        x-codegen-request-body-name: completeQuestionnaireEventStep
      operationId: post202316EventStepsByIDQuestionnaire
      x-operation-id-source: derived
components:
  schemas:
    completeQuestionnaireEventStep_3544fcea2784100018ee4286aeca0000:
      exampleSetFlag: false
      allOf:
      - type: object
        properties:
          stepAction:
            $ref: '#/components/schemas/stepAction_0fe15a3bc2e510000a1ff95a59a30000'
            exampleSetFlag: false
          questionnaireResponse:
            $ref: '#/components/schemas/questionnaireResponse_3544fcea2784100018ee4320719e0000'
            exampleSetFlag: false
          descriptor:
            type: string
            description: The display name of the instance
            example: Lorem ipsum dolor sit ame
            exampleSetFlag: true
            types:
            - string
          id:
            type: string
            description: The id for Event Record
            exampleSetFlag: false
            types:
            - string
        exampleSetFlag: false
        types:
        - object
    questionnaireAnswers_670e7e9e117b10002734f5a0c9fd07c7:
      exampleSetFlag: false
      allOf:
      - $ref: '#/components/schemas/questionnaireAnswerCreate_670e7e9e117b1000276a34afc7b207cb'
        exampleSetFlag: false
      - type: object
        properties:
          id:
            type: string
            description: The id for Questionnaire Answer Representation
            exampleSetFlag: false
            types:
            - string
        exampleSetFlag: false
        types:
        - object
    INSTANCE_MODEL_REFERENCE:
      required:
      - id
      type: object
      properties:
        id:
          pattern: ^(([0-9a-f]{32})|(\S+=\S+))$
          type: string
          description: Workday Id or Reference Id of the instance.
          exampleSetFlag: false
          types:
          - string
        descriptor:
          type: string
          description: The display name of the instance
          readOnly: true
          exampleSetFlag: false
          types:
          - string
        href:
          type: string
          description: A link to the instance
          readOnly: true
          exampleSetFlag: false
          types:
          - string
      exampleSetFlag: false
      types:
      - object
    answerMultipleChoices_670e7e9e117b10002790f474903a07d2:
      exampleSetFlag: false
      allOf:
      - $ref: '#/components/schemas/questionMultipleChoiceAnswerEmptyView_670e7e9e117b100027c36c757fb807d5'
        exampleSetFlag: false
      - type: object
        properties:
          id:
            type: string
            description: The id for Question Multiple Choice Answer Representation
            exampleSetFlag: false
            types:
            - string
        exampleSetFlag: false
        types:
        - object
    questionnaireTargetContext_b73d92d470c7100012164155beb48425:
      description: 'The applicable questionnaire or application for a student. Example: Student Application for Spring 2023. This is a new attribute as of 2021R2, and is currently only supported for Student.'
      exampleSetFlag: false
      allOf:
      - $ref: '#/components/schemas/INSTANCE_MODEL_REFERENCE'
        exampleSetFlag: false
      - type: object
        exampleSetFlag: false
        types:
        - object
    questionnaireAnswerCreate_670e7e9e117b1000276a34afc7b207cb:
      exampleSetFlag: false
      allOf:
      - type: object
        properties:
          questionItem:
            $ref: '#/components/schemas/questionItem_670e7e9e117b10002790f46f3d9c07d1'
            exampleSetFlag: false
          questionnaireAttachments:
            type: array
            description: Questionnaire Attachments for Questionnaire Response.
            extensions:
              x-workday-type: Multi-instance
            exampleSetFlag: false
            items:
              $ref: '#/components/schemas/questionnaireAttachments_69164aa4df9610001e17f32134be5429'
              exampleSetFlag: false
            types:
            - array
          answerNumeric:
            type: integer
            description: The answer in a numeric format.
            format: int32
            example: 99999999999
            extensions:
              x-workday-type: Numeric
            exampleSetFlag: true
            types:
            - integer
          answerMultipleChoices:
            type: array
            description: Question Multiple Choice Answers for question answer
            extensions:
              x-workday-type: Multi-instance
            exampleSetFlag: false
            items:
              $ref: '#/components/schemas/answerMultipleChoices_670e7e9e117b10002790f474903a07d2'
              exampleSetFlag: false
            types:
            - array
          answerDate:
            type: string
            description: The answer in a date format.
            format: date
            extensions:
              x-workday-type: Date
            exampleSetFlag: false
            types:
            - string
          answerText:
            type: string
            description: The text answer for a questionnaire.
            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: The id for Questionnaire Answer Representation
            exampleSetFlag: false
            types:
            - string
        exampleSetFlag: false
        types:
        - object
    questionnaireAttachments_69164aa4df9610001e17f32134be5429:
      exampleSetFlag: false
      allOf:
      - $ref: '#/components/schemas/questionnaireAttachment_cfb1e71e5435100008e52b3f011f0708'
        exampleSetFlag: false
      - type: object
        properties:
          id:
            type: string
            description: The id for Questionnaire Attachment Representation
            exampleSetFlag: false
            types:
            - string
        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
    questionnaireAttachment_cfb1e71e5435100008e52b3f011f0708:
      exampleSetFlag: false
      allOf:
      - type: object
        properties:
          fileLength:
            type: integer
            description: File length of the attachment
            format: int32
            example: 99999999999
            extensions:
              x-workday-type: Numeric
            exampleSetFlag: true
            types:
            - integer
          file:
            type: string
            description: For RaaS Only (Reports used as Web Services).  Returns the raw Base64 data for an attachment or image.
            format: binary
            extensions:
              x-workday-type: File
            exampleSetFlag: false
            types:
            - string
          fileName:
            maxLength: 255
            type: string
            description: File name of the attachment
            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
          contentType:
            $ref: '#/components/schemas/contentType_cfb1e71e5435100008e52b8894ef0709'
            exampleSetFlag: false
          descriptor:
            type: string
            description: The display name of the instance
            example: Lorem ipsum dolor sit ame
            exampleSetFlag: true
            types:
            - string
          id:
            type: string
            description: The id for Questionnaire Attachment Representation
            exampleSetFlag: false
            types:
            - string
        exampleSetFlag: false
        types:
        - object
    questionnaireResponse_3544fcea2784100018ee4320719e0000:
      description: Questionnaire Response
      exampleSetFlag: false
      allOf:
      - $ref: '#/components/schemas/questionnaireResponseSubmit_177812e3e8b51000163a63c22b7a0000'
        exampleSetFlag: false
      - type: object
        exampleSetFlag: false
        types:
        - object
    questionnaireTarget_b73d92d470c7100012164171eac28426:
      description: 'The questionnaire subject. Example: The candidate for admission to a school. This is a new attribute as of 2021R2, and is currently only supported for Student.'
      exampleSetFlag: false
      allOf:
      - $ref: '#/components/schemas/INSTANCE_MODEL_REFERENCE'
        exampleSetFlag: false
      - type: object
        exampleSetFlag: false
        types:
        - object
    contentType_cfb1e71e5435100008e52b8894ef0709:
      description: Content type of the attachment
      exampleSetFlag: false
      allOf:
      - $ref: '#/components/schemas/INSTANCE_MODEL_REFERENCE'
        exampleSetFlag: false
      - type: object
        exampleSetFlag: false
        types:
        - object
    questionMultipleChoiceAnswerEmptyView_670e7e9e117b100027c36c757fb807d5:
      exampleSetFlag: false
      allOf:
      - type: object
        properties:
          descriptor:
            type: string
            description: The display name of the instance
            example: Lorem ipsum dolor sit ame
            exampleSetFlag: true
            types:
            - string
          id:
            type: string
            description: The id for Question Multiple Choice Answer Representation
            exampleSetFlag: false
            types:
            - string
        exampleSetFlag: false
        types:
        - object
    questionItem_670e7e9e117b10002790f46f3d9c07d1:
      description: Question Item for Questionnaire Answer. Question item represents the question in a questionnaire.
      exampleSetFlag: false
      allOf:
      - $ref: '#/components/schemas/INSTANCE_MODEL_REFERENCE'
        exampleSetFlag: false
      - type: object
        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
    questionnaireResponseSubmit_177812e3e8b51000163a63c22b7a0000:
      exampleSetFlag: false
      allOf:
      - type: object
        properties:
          questionnaireAnswers:
            type: array
            description: The set of answers for a questionnaire.
            extensions:
              x-workday-type: Multi-instance
            exampleSetFlag: false
            items:
              $ref: '#/components/schemas/questionnaireAnswers_670e7e9e117b10002734f5a0c9fd07c7'
              exampleSetFlag: false
            types:
            - array
          questionnaireTargetContext:
            $ref: '#/components/schemas/questionnaireTargetContext_b73d92d470c7100012164155beb48425'
            exampleSetFlag: false
          questionnaireTarget:
            $ref: '#/components/schemas/questionnaireTarget_b73d92d470c7100012164171eac28426'
            exampleSetFlag: false
          descriptor:
            type: string
            description: The display name of the instance
            example: Lorem ipsum dolor sit ame
            exampleSetFlag: true
            types:
            - string
          id:
            type: string
            description: The id for Questionnaire Response Representation
            exampleSetFlag: false
            types:
            - string
        exampleSetFlag: false
        types:
        - object
    stepAction_0fe15a3bc2e510000a1ff95a59a30000:
      description: The status of the step
      exampleSetFlag: false
      allOf:
      - $ref: '#/components/schemas/INSTANCE_MODEL_REFERENCE'
        exampleSetFlag: false
      - type: object
        exampleSetFlag: false
        types:
        - object
  securitySchemes:
    OAuth2:
      type: OAUTH2
      flows:
        implicit:
          authorizationUrl: https://<tenantAuthorizationHostname>
          scopes: {}