Update a Job Reference

This web service allows the update of a jobs reference. The service will reject any update that would result in a duplicate job reference

Query String Parameters

Name	Type	Description	Required
Action	String	JobUpdateReference	Required
JobId	Int	The unique identifier of the job, which can be retrieved using any of the methods listed under add something here.	Required
JobRef	String	The reference of the job that is input as free text.	Required
TargetJobRef	String	New Job Reference to apply to the job - must be unique.	Required
ReturnType	Int	Alters the details returned from a successful call 0– Returns JobID (Default) 1– Returns JobId + JobReference 2- Returns JobId + JobGroupID (if job is in a job group) 3- Returns JobId + JobReference + JobGroupID (if job is in a job group)	Optional

note

Either the Job Id or Reference can be supplied. If both parameters are provided, the Job Id will take precedence.

Response Codes

Code	Message	Information
0	jobResponse
2	Existing job has target job reference : No Update
2	JobId or jobRef parameter expected : No Update
2	Invalid JobdId parameter : No Update
2	Unable to locate Source Job : No Update
2	Cannot Update JobRef when JobStatus >= Started : No Update
2	e.Message
2	targetjobref parameter expected : No Update

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=jobupdatereference

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "AssetCheckId": "12345"
    }
  ]
}