POST v1/Webhook?instance={instance}&projectid={projectid}&jobid={jobid}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
instance

string

Required

projectid

string

Required

jobid

string

Required

Body Parameters

None.

Response Information

Resource Description

execJobAsyncResponse
NameDescriptionTypeAdditional information
runID

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

string

None.

started

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

boolean

None.

error

Error message that may have occurred while trying to start the job.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "runID": "sample string 1",
  "started": true,
  "error": "sample string 3"
}

application/xml, text/xml

Sample:
<execJobAsyncResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StarfishAPI.Controllers">
  <error>sample string 3</error>
  <runID>sample string 1</runID>
  <started>true</started>
</execJobAsyncResponse>