client.imports.post_files_runs

A method of the Imports endpoint.

post_files_runs(id: int) Response

Start a run

API URL: POST /imports/files/{id}/runs

import civis
client = civis.APIClient()
response = client.imports.post_files_runs(...)
Parameters:
idint

The ID of the Import job.

Returns:
civis.Response
  • idint

    The ID of the run.

  • import_idint

    The ID of the Import 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.