Orkes

opencollection: 1.0.0
info:
  name: Orkes Conductor REST API
  version: 2.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Workflow Metadata
    type: folder
  items:
  - info:
      name: List workflow definitions
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/metadata/workflow'
    docs: Returns all workflow definitions.
  - info:
      name: Register a workflow definition
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/metadata/workflow'
      body:
        type: json
        data: '{}'
    docs: Registers a new workflow definition.
  - info:
      name: Update workflow definitions
      type: http
    http:
      method: PUT
      url: '{baseUrl}/api/metadata/workflow'
      body:
        type: json
        data: '{}'
    docs: Updates existing workflow definitions.
  - info:
      name: Get workflow definition
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/metadata/workflow/:name'
      params:
      - name: name
        value: ''
        type: path
      - name: version
        value: ''
        type: query
    docs: Returns a workflow definition by name and optional version.
  - info:
      name: Delete a workflow definition
      type: http
    http:
      method: DELETE
      url: '{baseUrl}/api/metadata/workflow/:name'
      params:
      - name: name
        value: ''
        type: path
      - name: version
        value: ''
        type: query
    docs: Deletes a workflow definition.
- info:
    name: Task Metadata
    type: folder
  items:
  - info:
      name: List task definitions
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/metadata/taskdefs'
    docs: Returns all task definitions.
  - info:
      name: Register task definitions
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/metadata/taskdefs'
      body:
        type: json
        data: '{}'
    docs: Registers new task definitions.
  - info:
      name: Get task definition
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/metadata/taskdefs/:taskType'
      params:
      - name: taskType
        value: ''
        type: path
    docs: Returns a specific task definition.
  - info:
      name: Delete a task definition
      type: http
    http:
      method: DELETE
      url: '{baseUrl}/api/metadata/taskdefs/:taskType'
      params:
      - name: taskType
        value: ''
        type: path
    docs: Deletes a task definition.
- info:
    name: Workflow Execution
    type: folder
  items:
  - info:
      name: Start a workflow
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/workflow'
      body:
        type: json
        data: '{}'
    docs: Starts a new workflow execution.
  - info:
      name: Get workflow execution
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/workflow/:workflowId'
      params:
      - name: workflowId
        value: ''
        type: path
      - name: includeTasks
        value: ''
        type: query
    docs: Returns details of a workflow execution.
  - info:
      name: Terminate a workflow
      type: http
    http:
      method: DELETE
      url: '{baseUrl}/api/workflow/:workflowId'
      params:
      - name: workflowId
        value: ''
        type: path
      - name: reason
        value: ''
        type: query
    docs: Terminates a running workflow.
  - info:
      name: Pause a workflow
      type: http
    http:
      method: PUT
      url: '{baseUrl}/api/workflow/:workflowId/pause'
      params:
      - name: workflowId
        value: ''
        type: path
    docs: Pauses a running workflow.
  - info:
      name: Resume a workflow
      type: http
    http:
      method: PUT
      url: '{baseUrl}/api/workflow/:workflowId/resume'
      params:
      - name: workflowId
        value: ''
        type: path
    docs: Resumes a paused workflow.
  - info:
      name: Retry a workflow
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/workflow/:workflowId/retry'
      params:
      - name: workflowId
        value: ''
        type: path
    docs: Retries a failed workflow from the last failed task.
  - info:
      name: Restart a workflow
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/workflow/:workflowId/restart'
      params:
      - name: workflowId
        value: ''
        type: path
    docs: Restarts a completed workflow.
  - info:
      name: Search workflows
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/workflow/search'
      params:
      - name: start
        value: ''
        type: query
      - name: size
        value: ''
        type: query
      - name: sort
        value: ''
        type: query
      - name: freeText
        value: ''
        type: query
      - name: query
        value: ''
        type: query
    docs: Search workflow executions.
- info:
    name: Tasks
    type: folder
  items:
  - info:
      name: Poll for a task
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/tasks/poll/:taskType'
      params:
      - name: taskType
        value: ''
        type: path
      - name: workerid
        value: ''
        type: query
    docs: Polls for a task of a given type.
  - info:
      name: Update task
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/tasks'
      body:
        type: json
        data: '{}'
    docs: Updates a task with results.
- info:
    name: Human Tasks
    type: folder
  items:
  - info:
      name: Search human tasks
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/human/tasks/search'
      params:
      - name: start
        value: ''
        type: query
      - name: size
        value: ''
        type: query
      - name: query
        value: ''
        type: query
    docs: Search for human tasks across workflows.
  - info:
      name: Get a human task
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/human/tasks/:taskId'
      params:
      - name: taskId
        value: ''
        type: path
    docs: Returns details of a specific human task.
  - info:
      name: Claim a human task
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/human/tasks/:taskId/claim/:userId'
      params:
      - name: taskId
        value: ''
        type: path
      - name: userId
        value: ''
        type: path
    docs: Claims a human task for a specific user.
  - info:
      name: Release a human task
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/human/tasks/:taskId/release'
      params:
      - name: taskId
        value: ''
        type: path
    docs: Releases a claimed human task.
  - info:
      name: Complete a human task
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/human/tasks/:taskId/complete'
      params:
      - name: taskId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Completes a human task with output.
- info:
    name: Secrets
    type: folder
  items:
  - info:
      name: Get a secret
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/secrets/:key'
      params:
      - name: key
        value: ''
        type: path
    docs: Returns a secret value (if permitted).
  - info:
      name: Create or update a secret
      type: http
    http:
      method: PUT
      url: '{baseUrl}/api/secrets/:key'
      params:
      - name: key
        value: ''
        type: path
    docs: Creates or updates a secret value.
  - info:
      name: Delete a secret
      type: http
    http:
      method: DELETE
      url: '{baseUrl}/api/secrets/:key'
      params:
      - name: key
        value: ''
        type: path
    docs: Deletes a secret.
  - info:
      name: List secret names
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/secrets'
    docs: Returns a list of all secret names.
- info:
    name: Schedules
    type: folder
  items:
  - info:
      name: List schedules
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/scheduler/schedules'
    docs: Returns all workflow schedules.
  - info:
      name: Create a schedule
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/scheduler/schedules'
      body:
        type: json
        data: '{}'
    docs: Creates a new workflow schedule.
  - info:
      name: Get a schedule
      type: http
    http:
      method: GET
      url: '{baseUrl}/api/scheduler/schedules/:name'
      params:
      - name: name
        value: ''
        type: path
    docs: Returns a specific workflow schedule.
  - info:
      name: Delete a schedule
      type: http
    http:
      method: DELETE
      url: '{baseUrl}/api/scheduler/schedules/:name'
      params:
      - name: name
        value: ''
        type: path
    docs: Deletes a workflow schedule.
  - info:
      name: Pause a schedule
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/scheduler/schedules/:name/pause'
      params:
      - name: name
        value: ''
        type: path
    docs: Pauses a workflow schedule.
  - info:
      name: Resume a schedule
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/scheduler/schedules/:name/resume'
      params:
      - name: name
        value: ''
        type: path
    docs: Resumes a paused workflow schedule.
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Generate access token
      type: http
    http:
      method: POST
      url: '{baseUrl}/api/token'
      body:
        type: json
        data: '{}'
    docs: Generates an access token for API authentication.
bundled: true