POST v1/ExecuteJob

Executes a Job in synchronous mode. The response will be returned once the job execution completes.

Request Information

URI Parameters

None.

Body Parameters

Required parameters to begin job execution.

execJobRequest
NameDescriptionTypeAdditional information
runID

GUID-formatted ID supplied by the user.

string

Required

Max length: 36

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.

Request Formats

application/json, text/json

Sample:
{
  "runID": "sample string 1",
  "projectID": "sample string 2",
  "jobID": "sample string 3",
  "chainJobs": true,
  "loggingLevel": 5,
  "argument": "sample string 6",
  "beginAtRow": "sample string 7",
  "endAfterRow": "sample string 8",
  "threadCount": "sample string 9"
}

application/xml, text/xml

Sample:
<execJobRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StarfishAPI.Controllers">
  <argument>sample string 6</argument>
  <beginAtRow>sample string 7</beginAtRow>
  <chainJobs>true</chainJobs>
  <endAfterRow>sample string 8</endAfterRow>
  <jobID>sample string 3</jobID>
  <loggingLevel>5</loggingLevel>
  <projectID>sample string 2</projectID>
  <runID>sample string 1</runID>
  <threadCount>sample string 9</threadCount>
</execJobRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

execJobResponse
NameDescriptionTypeAdditional information
runID

GUID-formatted ID which was supplied by the user at the start

string

None.

status

Result status after run. Typically "Complete" or "Failed".

string

None.

log

Resulting log at the specified level.

string

None.

returnValue

Any User-defined string value being returned out from the job. Can be set through scripting (C#: Starfish.ReturnValue = "foo";)

string

None.

totalRows

Total number of Origin rows processed.

integer

None.

inserts

Number of rows inserted in the Destination.

integer

None.

updates

Number of rows updated in the Destination.

integer

None.

deletes

Number of rows deleted in the Destination.

integer

None.

errors

Number of errors that occurred.

integer

None.

skips

Number of rows skipped (for instance by calling GotoNextRow or using SkipIfBlank).

integer

None.

ignores

Number of ignored rows (occurs when an update operation is attempted, but there are no matching records to update)

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "runID": "sample string 1",
  "status": "sample string 2",
  "log": "sample string 3",
  "returnValue": "sample string 4",
  "totalRows": 5,
  "inserts": 6,
  "updates": 7,
  "deletes": 8,
  "errors": 9,
  "skips": 10,
  "ignores": 11
}

application/xml, text/xml

Sample:
<execJobResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StarfishAPI.Controllers">
  <deletes>8</deletes>
  <errors>9</errors>
  <ignores>11</ignores>
  <inserts>6</inserts>
  <log>sample string 3</log>
  <returnValue>sample string 4</returnValue>
  <runID>sample string 1</runID>
  <skips>10</skips>
  <status>sample string 2</status>
  <totalRows>5</totalRows>
  <updates>7</updates>
</execJobResponse>