Update a job record
Parameter | Mandatory | Description | Examples | More Info |
---|---|---|---|---|
API | Yes | The API area | jobs.json | |
General | Yes | Parameters described in overview | user=user&password=user&version=3.7 | v3.7 Overview |
Action | Yes | The action to perform | action=update | |
Add new lookup | No | Flag to add any custom field values to lookup list | LookupValuesAddToLists=True | |
Input | Yes | JSON string | See below |
JSON Input | Mandatory | Description | Examples |
---|---|---|---|
Identifier | Yes | Job ID or UUID | "jobNumber":"1/00008772" |
Update data | Yes | Data to update | "jobDescription":"Softwareupdate2" |
The valid codes for "jobStatus" are 1 (quote), 2 (live), 3 (in-house), 4 (on hold) and 5 (special).
To promote a job, use the "jobSalesStatusReason" field. To get the valid codes see the Sales Status page.
Example request:
http://<SERVER>/jsonAPI/jobs.json?user=user&password=user&version=3.7&LookupValuesAddToLists=True&action=update&input={
"data": [
{
"jobNumber": "1/00008772",
"jobDescription": "Softwareupdate2",
"jobComments": "Lotsofprogresshasbeenmade.-Aheadofschedule",
"jobJobtypeCode": "1/PCD",
"jobHandlerUserID": "286",
"jobCustomField218": "MyNewText"
}
]
}
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"data": [
{
"jobNumber": "1/00008772",
"jobUuid": "19C1C231B8DE43B5BD2BC80F8A23E699",
"jobTimeStampModified": 1519379557,
"jobRecommendedVersionNumber": 109
}
]
}
Note:
To discover which fields are editable make a call to the "Job details" endpoint and specify '&style=modelstructure' see Meta-data
example of fields that can be updated using this endpoint:
Note: this is subject to the business rules set up on the system. For instance you can not alter the due date of a job if the system is set up to be phase dates driven.
jobExchangeRate
jobClientCode
jobComments
jobCurQuotedPrice
jobDateIn
jobDateDue
jobDescription
jobStatus
jobOrderNumber
jobQuotedPrice
jobReferenceJob
jobTaxCode
jobOppCurrentStatus
jobOppLeadRating
jobOppSource
jobOppWeighting
jobStageNotes
jobHandlerUserID
jobHandlerTeam
jobCampaignNo
jobContactInternalRef
jobCurrencyCode
jobJobtypeCode
jobProjectCode
jobStagePriority
jobWorkflowCode