Orkes Conductor REST API — Workflow Execution

naftiko: 1.0.0-alpha2
info:
  label: Orkes Conductor REST API — Workflow Execution
  description: 'Orkes Conductor REST API — Workflow Execution. 8 operations. Lead operation: Start a workflow. Self-contained
    Naftiko capability covering one Orkes business surface.'
  tags:
  - Orkes
  - Workflow Execution
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORKES_API_KEY: ORKES_API_KEY
capability:
  consumes:
  - type: http
    namespace: conductor-workflow-execution
    baseUri: ''
    description: Orkes Conductor REST API — Workflow Execution business capability. Self-contained, no shared references.
    resources:
    - name: workflow
      path: /workflow
      operations:
      - name: startworkflow
        method: POST
        description: Start a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: workflow-search
      path: /workflow/search
      operations:
      - name: searchworkflows
        method: GET
        description: Search workflows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: start
          in: query
          type: integer
        - name: size
          in: query
          type: integer
        - name: sort
          in: query
          type: string
        - name: freeText
          in: query
          type: string
        - name: query
          in: query
          type: string
    - name: workflow-workflowId
      path: /workflow/{workflowId}
      operations:
      - name: getworkflowexecution
        method: GET
        description: Get workflow execution
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          required: true
        - name: includeTasks
          in: query
          type: boolean
      - name: terminateworkflow
        method: DELETE
        description: Terminate a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          required: true
        - name: reason
          in: query
          type: string
    - name: workflow-workflowId-pause
      path: /workflow/{workflowId}/pause
      operations:
      - name: pauseworkflow
        method: PUT
        description: Pause a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          required: true
    - name: workflow-workflowId-restart
      path: /workflow/{workflowId}/restart
      operations:
      - name: restartworkflow
        method: POST
        description: Restart a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          required: true
    - name: workflow-workflowId-resume
      path: /workflow/{workflowId}/resume
      operations:
      - name: resumeworkflow
        method: PUT
        description: Resume a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          required: true
    - name: workflow-workflowId-retry
      path: /workflow/{workflowId}/retry
      operations:
      - name: retryworkflow
        method: POST
        description: Retry a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.ORKES_API_KEY}}'
  exposes:
  - type: rest
    namespace: conductor-workflow-execution-rest
    port: 8080
    description: REST adapter for Orkes Conductor REST API — Workflow Execution. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/workflow
      name: workflow
      description: REST surface for workflow.
      operations:
      - method: POST
        name: startworkflow
        description: Start a workflow
        call: conductor-workflow-execution.startworkflow
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflow/search
      name: workflow-search
      description: REST surface for workflow-search.
      operations:
      - method: GET
        name: searchworkflows
        description: Search workflows
        call: conductor-workflow-execution.searchworkflows
        with:
          start: rest.start
          size: rest.size
          sort: rest.sort
          freeText: rest.freeText
          query: rest.query
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflow/{workflowid}
      name: workflow-workflowid
      description: REST surface for workflow-workflowId.
      operations:
      - method: GET
        name: getworkflowexecution
        description: Get workflow execution
        call: conductor-workflow-execution.getworkflowexecution
        with:
          workflowId: rest.workflowId
          includeTasks: rest.includeTasks
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: terminateworkflow
        description: Terminate a workflow
        call: conductor-workflow-execution.terminateworkflow
        with:
          workflowId: rest.workflowId
          reason: rest.reason
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflow/{workflowid}/pause
      name: workflow-workflowid-pause
      description: REST surface for workflow-workflowId-pause.
      operations:
      - method: PUT
        name: pauseworkflow
        description: Pause a workflow
        call: conductor-workflow-execution.pauseworkflow
        with:
          workflowId: rest.workflowId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflow/{workflowid}/restart
      name: workflow-workflowid-restart
      description: REST surface for workflow-workflowId-restart.
      operations:
      - method: POST
        name: restartworkflow
        description: Restart a workflow
        call: conductor-workflow-execution.restartworkflow
        with:
          workflowId: rest.workflowId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflow/{workflowid}/resume
      name: workflow-workflowid-resume
      description: REST surface for workflow-workflowId-resume.
      operations:
      - method: PUT
        name: resumeworkflow
        description: Resume a workflow
        call: conductor-workflow-execution.resumeworkflow
        with:
          workflowId: rest.workflowId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflow/{workflowid}/retry
      name: workflow-workflowid-retry
      description: REST surface for workflow-workflowId-retry.
      operations:
      - method: POST
        name: retryworkflow
        description: Retry a workflow
        call: conductor-workflow-execution.retryworkflow
        with:
          workflowId: rest.workflowId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: conductor-workflow-execution-mcp
    port: 9090
    transport: http
    description: MCP adapter for Orkes Conductor REST API — Workflow Execution. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: start-workflow
      description: Start a workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: conductor-workflow-execution.startworkflow
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: search-workflows
      description: Search workflows
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: conductor-workflow-execution.searchworkflows
      with:
        start: tools.start
        size: tools.size
        sort: tools.sort
        freeText: tools.freeText
        query: tools.query
      outputParameters:
      - type: object
        mapping: $.
    - name: get-workflow-execution
      description: Get workflow execution
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: conductor-workflow-execution.getworkflowexecution
      with:
        workflowId: tools.workflowId
        includeTasks: tools.includeTasks
      outputParameters:
      - type: object
        mapping: $.
    - name: terminate-workflow
      description: Terminate a workflow
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: conductor-workflow-execution.terminateworkflow
      with:
        workflowId: tools.workflowId
        reason: tools.reason
      outputParameters:
      - type: object
        mapping: $.
    - name: pause-workflow
      description: Pause a workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: conductor-workflow-execution.pauseworkflow
      with:
        workflowId: tools.workflowId
      outputParameters:
      - type: object
        mapping: $.
    - name: restart-workflow
      description: Restart a workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: conductor-workflow-execution.restartworkflow
      with:
        workflowId: tools.workflowId
      outputParameters:
      - type: object
        mapping: $.
    - name: resume-workflow
      description: Resume a workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: conductor-workflow-execution.resumeworkflow
      with:
        workflowId: tools.workflowId
      outputParameters:
      - type: object
        mapping: $.
    - name: retry-workflow
      description: Retry a workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: conductor-workflow-execution.retryworkflow
      with:
        workflowId: tools.workflowId
      outputParameters:
      - type: object
        mapping: $.