{
  "opencollection": "1.0.0",
  "info": {
    "name": "Conductor OSS REST API",
    "version": "3.x"
  },
  "items": [
    {
      "info": {
        "name": "Metadata",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List workflow definitions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{baseUrl}/api/metadata/workflow"
          },
          "docs": "Returns all registered 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 specific workflow definition by name."
        },
        {
          "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 by name and version."
        },
        {
          "info": {
            "name": "List task definitions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{baseUrl}/api/metadata/taskdefs"
          },
          "docs": "Returns all registered 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 by name."
        },
        {
          "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 by name."
        }
      ]
    },
    {
      "info": {
        "name": "Workflow",
        "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 the execution details of a specific workflow."
        },
        {
          "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 execution."
        },
        {
          "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 execution."
        },
        {
          "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 execution."
        },
        {
          "info": {
            "name": "Restart a workflow",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{baseUrl}/api/workflow/:workflowId/restart",
            "params": [
              {
                "name": "workflowId",
                "value": "",
                "type": "path"
              },
              {
                "name": "useLatestDefinitions",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Restarts a completed or terminated workflow from the beginning."
        },
        {
          "info": {
            "name": "Retry a workflow",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{baseUrl}/api/workflow/:workflowId/retry",
            "params": [
              {
                "name": "workflowId",
                "value": "",
                "type": "path"
              },
              {
                "name": "resumeSubworkflowTasks",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retries a failed workflow from the last failed task."
        },
        {
          "info": {
            "name": "Rerun a workflow",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{baseUrl}/api/workflow/:workflowId/rerun",
            "params": [
              {
                "name": "workflowId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reruns a completed workflow from a specific task."
        },
        {
          "info": {
            "name": "Skip a task",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{baseUrl}/api/workflow/:workflowId/skiptask/:taskReferenceName",
            "params": [
              {
                "name": "workflowId",
                "value": "",
                "type": "path"
              },
              {
                "name": "taskReferenceName",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Skips a specific task in a running 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 for workflow executions based on query parameters."
        }
      ]
    },
    {
      "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"
              },
              {
                "name": "domain",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Polls for a task of a given type for a worker."
        },
        {
          "info": {
            "name": "Batch poll for tasks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{baseUrl}/api/tasks/poll/batch/:taskType",
            "params": [
              {
                "name": "taskType",
                "value": "",
                "type": "path"
              },
              {
                "name": "workerid",
                "value": "",
                "type": "query"
              },
              {
                "name": "count",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Polls for multiple tasks of a given type."
        },
        {
          "info": {
            "name": "Update task status",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{baseUrl}/api/tasks",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the status of a task with results."
        },
        {
          "info": {
            "name": "Get task details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{baseUrl}/api/tasks/:taskId",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns details of a specific task."
        },
        {
          "info": {
            "name": "Get task queue sizes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{baseUrl}/api/tasks/queue/sizes",
            "params": [
              {
                "name": "taskType",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns the sizes of task queues."
        }
      ]
    },
    {
      "info": {
        "name": "Events",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List event handlers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{baseUrl}/api/event"
          },
          "docs": "Returns all registered event handlers."
        },
        {
          "info": {
            "name": "Create event handler",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{baseUrl}/api/event",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Registers a new event handler."
        }
      ]
    }
  ],
  "bundled": true
}