client.scripts.get_custom_runs_inputs

A method of the Scripts endpoint.

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

Get the inputs for a run

API URL: GET /scripts/custom/{id}/runs/{run_id}/inputs

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

Parameters:

idint

The ID of the custom script.

run_idint

The ID of the run.

Returns:

civis.Response

• namestr

  The name of the script.

• parent_idint

  The ID of the parent job that will trigger this script

• argumentscivis.Response

  Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.

• from_template_idint

  The ID of the template script.

• remote_host_idint

  The remote host ID that this script will connect to.

• credential_idint

  The credential that this script will use.

• 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.

• 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 script.

• hiddenbool

  The hidden status of the item.

• target_project_idint

  Target project to which script outputs will be added.

• required_resourcescivis.Response

  • cpuint

    The number of CPU shares to allocate for the container. Each core has 1000 shares.

  • memoryint

    The amount of RAM to allocate for the container (in MB).

  • disk_spacefloat (float)

    The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.

• partition_labelstr

  The partition label used to run this object. Only applicable for jobs using Docker.

• running_as_idint

  The ID of the runner of this script.