createJobV1

Deprecated

This endpoint will stop working on 1 August 2027. Migrate to POST /v1/jobs in the new API; the migration guide has the recommended order of work and the important model differences.

Legacy expected a wrapped form-encoded body (jobs=<json-array>) with multiple jobs per call. The new endpoint creates a single job from a flat JSON object; contact and worklog info are no longer bundled in the same call (contacts/sites must exist first). If no teamId is supplied the new API picks a default team based on the workType.

Open POST /v1/jobs in the new API →

View legacy reference

/rest/workflow/job/createJob

POST

Add a Job (including WorkLog, Job and Activity).

acceptable request representations:

• application/json (NOTE: expects request parameter named "jobs" to contain this, i.e. jobs=<data>)

{
    "jobs" : [
        {
            "clientRef" : "abc123",
            "siteRef" : "abc123",
            "reportedDate" : "12/09/2011", 
            "contactMode" : "2",
            "contactRef" : "2342",
            "contactSal" : "Mr",
            "contactForename" : "Barry",
            "contactSurname" : "Walters",
            "contactC1" : "08767 883788",
            "contactC1Type" : "1",
            "contactC2" : "08767 883788",
            "contactC2Type" : "1",
            "contactC3" : "08767 883788",
            "contactC3Type" : "1",
            "contactC4" : "08767 883788",
            "contactC4Type" : "1",
            "workLogTypeID" : "1",
            "workTypeID" : "7",
            "priorityID" : "3",             
            "description" : "fix photocopier",    
            "causeID" : "5",                 
            "raisedBy" : "colin",
            "serviceID" : "21",
            "workflowID" : "3",
            "supplierID" : "4",
            "resourceID" : "76",
            "eventNotes" : "a note",
            "targetDate" : "30/09/2011",
            "postcodeUse" : "0",
            "preferredContact" : "2",
            "activities": [
                {
                    "libraryActivityCode" : "5647",
                    "activityRef" : "act123",                    
                    "description" : "optional desc",
                    "quantity" : "3"
                }
            ]
        }
    ]

}

NOTE for more information relating to the allowable values, business rules and data format for each field in the format specification see file format spec.

available response representations:

• 200 - application/json

{
  "result" : "success or fail",
  "result_msg" : "error message"
}

See the Workflow API matrix for the full list of endpoints in this category.