Executions

Unqueue an execution

post/api/v1/{tenant}/executions/{executionId}/unqueue

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/executions/{executionId}/unqueue
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

executionIdstring required

The execution id

tenantstring required

Query parameters

state'CREATED' | 'SUBMITTED' | 'RUNNING' | 'PAUSED' | 'RESTARTED' | 'KILLING' | 'SUCCESS' | 'WARNING' | 'FAILED' | 'KILLED' | 'CANCELLED' | 'QUEUED' | 'RETRYING' | 'RETRIED' | 'SKIPPED' | 'BREAKPOINT' | 'RESUBMITTED' required

The new state of the execution

Response

unqueueExecution 200 response

idstring required
namespacestring required
flowIdstring required
flowRevisioninteger required
inputsobject
outputsobject
variablesobject
parentIdstring
originalIdstring
deletedboolean required
scheduleDatestring date-time nullable
traceParentstring
kind'NORMAL' | 'TEST' | 'PLAYGROUND'

Example response

{
  "outputs": "{}",
  "variables": "{}",
  "metadata": {
    "attemptNumber": 1,
    "originalCreatedDate": "2000-01-23T04:56:07.000+00:00"
  },
  "inputs": "{}",
  "kind": "",
  "trigger": {
    "variables": {
      "key": ""
    },
    "logFile": "https://openapi-generator.tech",
    "id": "id",
    "type": "type"
  },
  "taskRunList": [
    {
      "outputs": "{}",
      "parentTaskRunId": "parentTaskRunId",
      "executionId": "executionId",
      "forceExecution": true,
      "assets": "",
      "namespace": "namespace",
      "iteration": 6,
      "dynamic": true,
      "id": "id",
      "state": {
        "duration": "duration",
        "current": "CREATED",
        "endDate": "2000-01-23T04:56:07.000+00:00",
        "histories": [
          {
            "date": "2000-01-23T04:56:07.000+00:00",
            "state": null
          },
          {
            "date": "2000-01-23T04:56:07.000+00:00",
            "state": null
          }
        ],
        "startDate": "2000-01-23T04:56:07.000+00:00"
      },
      "flowId": "flowId",
      "value": "value",
      "taskId": "taskId",
      "attempts": [
        {
          "workerId": "workerId",
          "logFile": "https://openapi-generator.tech",
          "state": {
            "duration": "duration",
            "current": "CREATED",
            "endDate": "2000-01-23T04:56:07.000+00:00",
            "histories": [
              {
                "date": "2000-01-23T04:56:07.000+00:00",
                "state": null
              },
              {
                "date": "2000-01-23T04:56:07.000+00:00",
                "state": null
              }
            ],
            "startDate": "2000-01-23T04:56:07.000+00:00"
          }
        },
        {
          "workerId": "workerId",
          "logFile": "https://openapi-generator.tech",
          "state": {
            "duration": "duration",
            "current": "CREATED",
            "endDate": "2000-01-23T04:56:07.000+00:00",
            "histories": [
              {
                "date": "2000-01-23T04:56:07.000+00:00",
                "state": null
              },
              {
                "date": "2000-01-23T04:56:07.000+00:00",
                "state": null
              }
            ],
            "startDate": "2000-01-23T04:56:07.000+00:00"
          }
        }
      ]
    },
    {
      "outputs": "{}",
      "parentTaskRunId": "parentTaskRunId",
      "executionId": "executionId",
      "forceExecution": true,
      "assets": "",
      "namespace": "namespace",
      "iteration": 6,
      "dynamic": true,
      "id": "id",
      "state": {
        "duration": "duration",
        "current": "CREATED",
        "endDate": "2000-01-23T04:56:07.000+00:00",
        "histories": [
          {
            "date": "2000-01-23T04:56:07.000+00:00",
            "state": null
          },
          {
            "date": "2000-01-23T04:56:07.000+00:00",
            "state": null
          }
        ],
        "startDate": "2000-01-23T04:56:07.000+00:00"
      },
      "flowId": "flowId",
      "value": "value",
      "taskId": "taskId",
      "attempts": [
        {
          "workerId": "workerId",
          "logFile": "https://openapi-generator.tech",
          "state": {
            "duration": "duration",
            "current": "CREATED",
            "endDate": "2000-01-23T04:56:07.000+00:00",
            "histories": [
              {
                "date": "2000-01-23T04:56:07.000+00:00",
                "state": null
              },
              {
                "date": "2000-01-23T04:56:07.000+00:00",
                "state": null
              }
            ],
            "startDate": "2000-01-23T04:56:07.000+00:00"
          }
        },
        {
          "workerId": "workerId",
          "logFile": "https://openapi-generator.tech",
          "state": {
            "duration": "duration",
            "current": "CREATED",
            "endDate": "2000-01-23T04:56:07.000+00:00",
            "histories": [
              {
                "date": "2000-01-23T04:56:07.000+00:00",
                "state": null
              },
              {
                "date": "2000-01-23T04:56:07.000+00:00",
                "state": null
              }
            ],
            "startDate": "2000-01-23T04:56:07.000+00:00"
          }
        }
      ]
    }
  ],
  "parentId": "parentId",
  "labels": [
    {
      "value": "value",
      "key": "key"
    },
    {
      "value": "value",
      "key": "key"
    }
  ],
  "fixtures": [
    {
      "outputs": {
        "key": "{}"
      },
      "assets": [
        {
          "metadata": {
            "key": "{}"
          },
          "displayName": "displayName",
          "namespace": "namespace",
          "description": "description",
          "id": "id",
          "type": "type"
        },
        {
          "metadata": {
            "key": "{}"
          },
          "displayName": "displayName",
          "namespace": "namespace",
          "description": "description",
          "id": "id",
          "type": "type"
        }
      ],
      "description": {
        "expression": "expression",
        "value": "value"
      },
      "id": "id",
      "state": null,
      "value": "value"
    },
    {
      "outputs": {
        "key": "{}"
      },
      "assets": [
        {
          "metadata": {
            "key": "{}"
          },
          "displayName": "displayName",
          "namespace": "namespace",
          "description": "description",
          "id": "id",
          "type": "type"
        },
        {
          "metadata": {
            "key": "{}"
          },
          "displayName": "displayName",
          "namespace": "namespace",
          "description": "description",
          "id": "id",
          "type": "type"
        }
      ],
      "description": {
        "expression": "expression",
        "value": "value"
      },
      "id": "id",
      "state": null,
      "value": "value"
    }
  ],
  "traceParent": "traceParent",
  "flowRevision": 0,
  "deleted": true,
  "namespace": "namespace",
  "scheduleDate": "2000-01-23T04:56:07.000+00:00",
  "id": "id",
  "state": {
    "duration": "duration",
    "current": "CREATED",
    "endDate": "2000-01-23T04:56:07.000+00:00",
    "histories": [
      {
        "date": "2000-01-23T04:56:07.000+00:00",
        "state": null
      },
      {
        "date": "2000-01-23T04:56:07.000+00:00",
        "state": null
      }
    ],
    "startDate": "2000-01-23T04:56:07.000+00:00"
  },
  "originalId": "originalId",
  "breakpoints": [
    {
      "id": "id",
      "value": "value"
    },
    {
      "id": "id",
      "value": "value"
    }
  ],
  "flowId": "flowId"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.