Update a job record
Job update
updates one or more of the key fields of a job
requires synergist v12.2 and above
Parameter | Description | Example | More info |
---|---|---|---|
API | The API area | jobs.json | |
Action | The action to perform | action=update | |
General | Parameters described in overview | user=user&password=user | |
input | Job number (mandatory), then name/value pairs | "data": [<see example>] | |
Response | Returned data | See below |
See below for all the possible fields that can be updated by this endpoint
Example request:
Request to replace the job description, job comments, job type & handler
http://<SERVER>/jsonAPI/jobs.json?user=user&password=user&version=3.3&action=update&input={
"data": [
{
"jobNumber": "1/00008772",
"jobDescription": "Software update 2",
"jobComments": "Lots of progress has been made. - Ahead of schedule",
"jobJobtypeCode": "1/PCD",
"jobHandlerUserID": "286",
"jobCustomField218": "My New Text"
}
]
}
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