client.workflows.post_executions_resume

A method of the Workflows endpoint.

post_executions_resume(id: int, execution_id: int) Response

Resume a paused workflow execution

API URL: POST /workflows/{id}/executions/{execution_id}/resume

import civis
client = civis.APIClient()
response = client.workflows.post_executions_resume(...)
Parameters:
idint

The ID for the workflow.

execution_idint

The ID for the workflow execution.

Returns:
civis.Response
  • idint

    The ID for this workflow execution.

  • statestr

    The state of this workflow execution.

  • mistral_statestr

    The state of this workflow as reported by mistral. One of running, paused, success, error, or cancelled

  • mistral_state_infostr

    The state info of this workflow as reported by mistral.

  • usercivis.Response
    • idint

      The ID of this user.

    • namestr

      This user’s name.

    • usernamestr

      This user’s username.

    • initialsstr

      This user’s initials.

    • onlinebool

      Whether this user is online.

  • definitionstr

    The definition of the workflow for this execution.

  • inputcivis.Response

    Key-value pairs defined for this execution.

  • included_tasksList[str]

    The subset of workflow tasks selected to execute.

  • tasksList[civis.Response]

    The tasks associated with this execution.

    • namestr

      The name of the task.

    • mistral_statestr

      The state of this task. One of idle, waiting, running, delayed, success, error, or cancelled

    • mistral_state_infostr

      Extra info associated with the state of the task.

    • runsList[civis.Response]

      The runs associated with this task, in descending order by id.

      • idint

        The ID of the run.

      • job_idint

        The ID of the job associated with the run.

      • my_permission_levelstr

        Your permission level on the job. One of “read”, “write”, “manage”, or “nil”.

      • statestr

        The state of the run.

      • created_atstr (time)

        The time that the run was queued.

      • started_atstr (time)

        The time that the run started.

      • finished_atstr (time)

        The time that the run completed.

    • executionsList[civis.Response]

      The executions run by this task, in descending order by id.

      • idint

        The ID of the execution.

      • workflow_idint

        The ID of the workflow associated with the execution.

      • my_permission_levelstr

        Your permission level on the workflow. One of “read”, “write”, “manage”, or “nil”.

      • statestr

        The state of this workflow execution.

      • created_atstr (time)

        The time this execution was created.

      • started_atstr (time)

        The time this execution started.

      • finished_atstr (time)

        The time this execution finished.

  • started_atstr (time)

    The time this execution started.

  • finished_atstr (time)

    The time this execution finished.

  • created_atstr (time)

    The time this execution was created.

  • updated_atstr (time)

    The time this execution was last updated.