client.imports.get_files_runs_inputs

A method of the Imports endpoint.

get_files_runs_inputs(id: int, run_id: int) → Response

Get the inputs for a run

API URL: GET /imports/files/{id}/runs/{run_id}/inputs

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

The ID of the Import.

run_idint

The ID of the run.

Returns:
civis.Response
  • namestr

    The name of the import.

  • sourcecivis.Response

    • remote_host_id : int

    • credential_id : int

    • additional_credentialsList[int]

      Array that holds additional credentials used for DB Syncs. The first element is an SSL private key credential id, and the second element is the corresponding public key credential id.

    • name : str

  • destinationcivis.Response

    • remote_host_id : int

    • credential_id : int

    • additional_credentialsList[int]

      Array that holds additional credentials used for DB Syncs. The first element is an SSL private key credential id, and the second element is the corresponding public key credential id.

    • name : str

  • sync_typestr

    The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport.

  • parent_idint

    Parent id to trigger this import from

  • is_outbound : bool

  • schedulecivis.Response
    • scheduledbool

      If the item is scheduled.

    • scheduled_daysList[int]

      Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

    • scheduled_hoursList[int]

      Hours of the day it is scheduled on.

    • scheduled_minutesList[int]

      Minutes of the day it is scheduled on.

    • scheduled_runs_per_hourint

      Deprecated in favor of scheduled minutes.

    • scheduled_days_of_monthList[int]

      Days of the month it is scheduled on, mutually exclusive with scheduledDays.

  • next_run_atstr (time)

    The time of the next scheduled run.

  • notificationscivis.Response
    • urlsList[str]

      URLs to receive a POST request at job completion

    • success_email_subjectstr

      Custom subject line for success e-mail.

    • success_email_bodystr

      Custom body text for success e-mail, written in Markdown.

    • success_email_addressesList[str]

      Addresses to notify by e-mail when the job completes successfully.

    • success_email_from_namestr

      Name from which success emails are sent; defaults to “Civis.”

    • success_email_reply_tostr

      Address for replies to success emails; defaults to the author of the job.

    • failure_email_addressesList[str]

      Addresses to notify by e-mail when the job fails.

    • stall_warning_minutesint

      Stall warning emails will be sent after this amount of minutes.

    • success_onbool

      If success email notifications are on. Defaults to user’s preferences.

    • failure_onbool

      If failure email notifications are on. Defaults to user’s preferences.

  • time_zonestr

    The time zone of this import.

  • hiddenbool

    The hidden status of the item.