client.scripts.post_sql_runs

A method of the Scripts endpoint.

post_sql_runs(id: int) → Response

Start a run

API URL: POST /scripts/sql/{id}/runs

import civis
client = civis.APIClient()
response = client.scripts.post_sql_runs(...)

Parameters:

idint

The ID of the SQL job.

Returns:

civis.Response

• idint

  The ID of the run.

• sql_idint

  The ID of the SQL job.

• statestr

  The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.

• is_cancel_requestedbool

  True if run cancel requested, else false.

• created_atstr (time)

  The time the run was created.

• started_atstr (time)

  The time the run started at.

• finished_atstr (time)

  The time the run completed.

• errorstr

  The error, if any, returned by the run.

• outputList[civis.Response]

  A list of the outputs of this script.

  • output_namestr

    The name of the output file.

  • file_idint

    The unique ID of the output file.

  • pathstr

    The temporary link to download this output file, valid for 36 hours.

• output_cached_onstr (time)

  The time that the output was originally exported, if a cache entry was used by the run.