{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping Workflow executions API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Workflow executions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Run a workflow",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/:workflowExternalId/versions/:version/run",
            "params": [
              {
                "name": "workflowExternalId",
                "value": "",
                "type": "path"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nStart an execution of a specific version of a workflow."
        },
        {
          "info": {
            "name": "Filter workflow executions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/executions/list",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nList workflow executions matching a given filter."
        },
        {
          "info": {
            "name": "Retrieve workflow execution details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/executions/:executionId",
            "params": [
              {
                "name": "executionId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nRetrieve detailed information about a specific workflow execution."
        },
        {
          "info": {
            "name": "Cancel a workflow execution",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/executions/:executionId/cancel",
            "params": [
              {
                "name": "executionId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nStops the specified execution from starting new workflow tasks and sets the workflow execution status to `TERMINATED`. Already running tasks will be marked as CANCELED. Note that the actions taken by the canceled tasks won't be stopped, and these need to be canceled separately if desired. For example, to cancel a running transformation, use the [/transformations/cancel](#/Transformations/postApiV1ProjectsProjectTransformationsCance"
        },
        {
          "info": {
            "name": "Retry workflow execution",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/executions/:executionId/retry",
            "params": [
              {
                "name": "executionId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nThis endpoint restarts a previously failed, timed out, or terminated workflow execution by retrying tasks that did not complete successfully. It aims to resume execution activity from the point(s) of failure.\n\nBehavior of the retry operation:\n- Targeted Task Retry: Only retries tasks that have stopped in a terminal state such as `CANCELED`, `FAILED`, `FAILED_WITH_TERMINAL_ERROR`, and `TIMED_OUT`. Optional tasks are not retried.\n- S"
        }
      ]
    }
  ],
  "bundled": true
}