Delete a job record
Delete
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | jobs.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication&version=3.8 | v3.8 Overview |
| Action | Yes | The action to perform | action=delete | |
| Input | Yes | JSON string | See below |
| JSON Input | Mandatory | Description | Examples |
|---|---|---|---|
| Identifier | Yes | Job 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"
}
]
}