Workday Business Process API — Process Instances

naftiko: 1.0.0-alpha2
info:
  label: Workday Business Process API — Process Instances
  description: 'Workday Business Process API — Process Instances. 5 operations. Lead operation: Workday List Process Instances.
    Self-contained Naftiko capability covering one Workday Business Processes business surface.'
  tags:
  - Workday Business Processes
  - Process Instances
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WORKDAY_BUSINESS_PROCESSES_API_KEY: WORKDAY_BUSINESS_PROCESSES_API_KEY
capability:
  consumes:
  - type: http
    namespace: workday-business-processes-process-instances
    baseUri: https://{tenant}.workday.com/api/businessProcess/v1
    description: Workday Business Process API — Process Instances business capability. Self-contained, no shared references.
    resources:
    - name: processInstances
      path: /processInstances
      operations:
      - name: listprocessinstances
        method: GET
        description: Workday List Process Instances
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Maximum number of records to return
        - name: offset
          in: query
          type: integer
          description: Number of records to skip
        - name: status
          in: query
          type: string
          description: Filter by process status
        - name: processType
          in: query
          type: string
          description: Filter by business process type
        - name: initiatorId
          in: query
          type: string
          description: Filter by process initiator ID
      - name: initiateprocess
        method: POST
        description: Workday Initiate Process
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: processInstances-instanceId
      path: /processInstances/{instanceId}
      operations:
      - name: getprocessinstance
        method: GET
        description: Workday Get Process Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: instanceId
          in: path
          type: string
          description: Process instance identifier
          required: true
    - name: processInstances-instanceId-cancel
      path: /processInstances/{instanceId}/cancel
      operations:
      - name: cancelprocessinstance
        method: POST
        description: Workday Cancel Process Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: instanceId
          in: path
          type: string
          description: Process instance identifier
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: processInstances-instanceId-steps
      path: /processInstances/{instanceId}/steps
      operations:
      - name: listprocesssteps
        method: GET
        description: Workday List Process Steps
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: instanceId
          in: path
          type: string
          description: Process instance identifier
          required: true
    authentication:
      type: bearer
      token: '{{env.WORKDAY_BUSINESS_PROCESSES_API_KEY}}'
  exposes:
  - type: rest
    namespace: workday-business-processes-process-instances-rest
    port: 8080
    description: REST adapter for Workday Business Process API — Process Instances. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/processinstances
      name: processinstances
      description: REST surface for processInstances.
      operations:
      - method: GET
        name: listprocessinstances
        description: Workday List Process Instances
        call: workday-business-processes-process-instances.listprocessinstances
        with:
          limit: rest.limit
          offset: rest.offset
          status: rest.status
          processType: rest.processType
          initiatorId: rest.initiatorId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: initiateprocess
        description: Workday Initiate Process
        call: workday-business-processes-process-instances.initiateprocess
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/processinstances/{instanceid}
      name: processinstances-instanceid
      description: REST surface for processInstances-instanceId.
      operations:
      - method: GET
        name: getprocessinstance
        description: Workday Get Process Instance
        call: workday-business-processes-process-instances.getprocessinstance
        with:
          instanceId: rest.instanceId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/processinstances/{instanceid}/cancel
      name: processinstances-instanceid-cancel
      description: REST surface for processInstances-instanceId-cancel.
      operations:
      - method: POST
        name: cancelprocessinstance
        description: Workday Cancel Process Instance
        call: workday-business-processes-process-instances.cancelprocessinstance
        with:
          instanceId: rest.instanceId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/processinstances/{instanceid}/steps
      name: processinstances-instanceid-steps
      description: REST surface for processInstances-instanceId-steps.
      operations:
      - method: GET
        name: listprocesssteps
        description: Workday List Process Steps
        call: workday-business-processes-process-instances.listprocesssteps
        with:
          instanceId: rest.instanceId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: workday-business-processes-process-instances-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Business Process API — Process Instances. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: workday-list-process-instances
      description: Workday List Process Instances
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: workday-business-processes-process-instances.listprocessinstances
      with:
        limit: tools.limit
        offset: tools.offset
        status: tools.status
        processType: tools.processType
        initiatorId: tools.initiatorId
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-initiate-process
      description: Workday Initiate Process
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: workday-business-processes-process-instances.initiateprocess
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-get-process-instance
      description: Workday Get Process Instance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: workday-business-processes-process-instances.getprocessinstance
      with:
        instanceId: tools.instanceId
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-cancel-process-instance
      description: Workday Cancel Process Instance
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: workday-business-processes-process-instances.cancelprocessinstance
      with:
        instanceId: tools.instanceId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-list-process-steps
      description: Workday List Process Steps
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: workday-business-processes-process-instances.listprocesssteps
      with:
        instanceId: tools.instanceId
      outputParameters:
      - type: object
        mapping: $.