Name | Description | Type | Additional information |
---|---|---|---|
runID |
GUID-formatted ID supplied by the user. |
string |
Required Max length: 36 |
instance |
Starfish ETL instance you wish to execute against. You must have "Owner" or "Full" permission role to an instance to make an call API against it. Parameter is optional, if not passed execution will be against your primary (Owner) instance. |
string |
Max length: 255 |
projectID |
ID of the project which contains the job you wish to run. |
string |
Required Max length: 36 |
jobID |
ID of the job within the specified project to run. |
string |
Required Max length: 36 |
chainJobs |
Execute all jobs in the chain? Default: false |
boolean |
None. |
loggingLevel |
Defines the verbosity of the log returned. Default: 0 0=None, 1=Low, 2=Medium, 3=High |
integer |
None. |
argument |
Any string value you wish to pass into your job's execution. This is commonly used for filtering which rows to run, such as passing in the ID of a record to process. It is available within your job as the User-Defined variable "Job Argument" (@@VAR:JobArgument@@). |
string |
None. |
beginAtRow |
Tells the job to skip ahead to this row and start processing. Default: 1 |
string |
None. |
endAfterRow |
Job execution will end after processing this row. Default: Process to end of all rows. |
string |
None. |
threadCount |
Number of threads to spawn for processing data into destination. Default: 1 |
string |
None. |