Workday Business Processes Business Process Definitions API

openapi: 3.0.3
info:
  title: Workday Business Process Approvals Business Process Definitions API
  description: The Workday Business Process API provides RESTful access to business process management capabilities including initiating workflows, managing approvals, tracking process instances, retrieving process definitions, and handling inbox items. The API enables organizations to programmatically trigger Workday business processes, monitor their status, and integrate workflow automation with external systems.
  version: v41.1
  contact:
    name: Workday Developer Support
    url: https://community.workday.com/
  x-generated-from: documentation
servers:
- url: https://{tenant}.workday.com/api/businessProcess/v1
  description: Workday tenant REST API endpoint
  variables:
    tenant:
      default: wd2-impl-services1
      description: Your Workday tenant hostname
security:
- oauth2: []
tags:
- name: Business Process Definitions
  description: Retrieve and manage business process type definitions
paths:
  /businessProcessDefinitions:
    get:
      operationId: listBusinessProcessDefinitions
      summary: Workday List Business Process Definitions
      description: Retrieves a collection of business process type definitions available in the Workday tenant.
      tags:
      - Business Process Definitions
      parameters:
      - name: limit
        in: query
        description: Maximum number of records to return
        schema:
          type: integer
          default: 100
        example: 100
      - name: offset
        in: query
        description: Number of records to skip
        schema:
          type: integer
          default: 0
        example: 0
      - name: processType
        in: query
        description: Filter by business process type
        schema:
          type: string
        example: HireEmployee
      responses:
        '200':
          description: A list of business process definitions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessProcessDefinitionsResponse'
              examples:
                ListBusinessProcessDefinitions200Example:
                  summary: Default listBusinessProcessDefinitions 200 response
                  x-microcks-default: true
                  value:
                    total: 45
                    data:
                    - id: BPD-HIRE-001
                      name: Hire Employee
                      type: HireEmployee
                      status: ACTIVE
                      version: 2
                      description: Business process for hiring new employees
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /businessProcessDefinitions/{definitionId}:
    get:
      operationId: getBusinessProcessDefinition
      summary: Workday Get Business Process Definition
      description: Retrieves a specific business process type definition by its identifier.
      tags:
      - Business Process Definitions
      parameters:
      - name: definitionId
        in: path
        required: true
        description: Business process definition identifier
        schema:
          type: string
        example: BPD-HIRE-001
      responses:
        '200':
          description: A business process definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessProcessDefinition'
              examples:
                GetBusinessProcessDefinition200Example:
                  summary: Default getBusinessProcessDefinition 200 response
                  x-microcks-default: true
                  value:
                    id: BPD-HIRE-001
                    name: Hire Employee
                    type: HireEmployee
                    status: ACTIVE
                    version: 2
                    description: Business process for hiring new employees
                    steps:
                    - stepId: STEP-001
                      stepType: APPROVAL
                      assignedGroup: HR Managers
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: URI_PARTS
        dispatcherRules: definitionId
components:
  schemas:
    BusinessProcessDefinitionsResponse:
      title: Business Process Definitions Response
      description: Paginated response containing a list of business process definitions
      type: object
      properties:
        total:
          type: integer
          description: Total number of definitions
        data:
          type: array
          items:
            $ref: '#/components/schemas/BusinessProcessDefinition'
      required:
      - total
      - data
    ErrorResponse:
      title: Error Response
      description: Standard error response
      type: object
      properties:
        error:
          type: string
          description: Error code
        message:
          type: string
          description: Human-readable error message
        details:
          type: array
          items:
            type: string
          description: Additional error details
      required:
      - error
      - message
    BusinessProcessDefinition:
      title: Business Process Definition
      description: A Workday business process type definition with steps and configuration
      type: object
      properties:
        id:
          type: string
          description: Unique definition identifier
        name:
          type: string
          description: Business process name
        type:
          type: string
          description: Business process type identifier
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - DRAFT
          description: Definition status
        version:
          type: integer
          description: Definition version number
        description:
          type: string
          description: Process description
        steps:
          type: array
          items:
            $ref: '#/components/schemas/ProcessStepDefinition'
          description: Process step definitions
      required:
      - id
      - name
      - type
      - status
    ProcessStepDefinition:
      title: Process Step Definition
      description: A step definition within a business process
      type: object
      properties:
        stepId:
          type: string
          description: Step identifier
        stepType:
          type: string
          enum:
          - APPROVAL
          - ACTION
          - NOTIFICATION
          - CONDITION
          - INTEGRATION
          description: Type of process step
        assignedGroup:
          type: string
          description: Group or role assigned to this step
        description:
          type: string
          description: Step description
        order:
          type: integer
          description: Step execution order
      required:
      - stepId
      - stepType
  responses:
    Forbidden:
      description: Insufficient permissions to access the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: FORBIDDEN
            message: You do not have permission to perform this action
    Unauthorized:
      description: Authentication credentials are missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: UNAUTHORIZED
            message: Valid authentication credentials are required
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: NOT_FOUND
            message: The requested resource does not exist
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.workday.com/ccx/oauth2/{tenant}/token
          scopes:
            businessProcess: Access to Workday Business Process API