Delete

Delete a job record

Delete

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areajobs.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API Authentication&version=3.8v3.8 Overview
ActionYesThe action to performaction=delete
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
IdentifierYesJob ID or UUID"jobNumber":"1/00008772"

Delete will fail if job is used on one or more activity records.

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/jobs.json?&version=6&action=delete&input={
  "data": [
    {
      "jobNumber": "1/00008772"
    }
  ]
}

Example request (legacy username/password):

http://<SERVER>/jsonapi/jobs.json?&version=6&action=delete&input={
  "data": [
    {
      "jobNumber": "1/00008772"
    }
  ]
}&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "data": [
    {
      "jobNumber": "1/00008772",
      "jobUuid": "19C1C231B8DE43B5BD2BC80F8A23E699"
    }
  ]
}