createJobs

Create a job

Create a new job by defining the basic properties of a job. A job is a unit of work performed by one or more people. For example, updating parcel data, creating a new work plan for a residential subdivision, and creating a map of a specific scale each qualifies as a job. Each individual job is an instance of the job template, which serves as the blueprint for a job. You can choose to assign the first step in a job to the user creating the job by setting the job's default assignment to JobCreator($job). During job creation, the job's default assignment takes precedence over the job template's default assignment. Values for extended properties configured on the job template can be updated during job creation. If no properties are provided while creating a job, the job is created with the default values in the job template. The first step runs automatically at job creation if it is configured to run automatically and assigned to the job creator. The jobCreate privilege is required.

Note: Bulk job creation must not exceed 10,000 jobs per request. For jobs configured to run automatically, only the first 25 jobs will run automatically per request.

A job will not be created in the following cases:

• Invalid or no job template is provided
• Job template is not in Active state
• A value other than User, Group or Unassigned is provided for assignedType
• If the due date is before the provided start date
• An invalid number of jobs is provided

Job Parameters:

Location Parameters:

ExtendedProperties Parameters:

RelatedProperties Parameters:

Entries Parameters:

Properties Parameters:

Body parameter

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
  "numberOfJobs": 1,
  "jobName": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "priority": "string",
  "description": "string",
  "ownedBy": "string",
  "assignedType": "Unassigned",
  "assignedTo": "string",
  "percentComplete": 0,
  "jobStatus": "string",
  "notes": "string",
  "parentJob": "string",
  "location": {
    "geometryType": "Multipoint",
    "geometry": "string"
  },
  "extendedProperties": [
    {
      "identifier": "string",
      "value": "string",
      "dataType": "string",
      "uniqueId": "string"
    }
  ],
  "relatedProperties": [
    {
      "tableName": "string",
      "entries": [
        {
          "properties": [
            {
              "propertyName": "string",
              "value": "string"
            }
          ]
        }
      ]
    }
  ]
}

Query parameters

Path parameters

Examples

Request

1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobTemplates/{jobTemplateId}/job \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

1
2
3
4
5
6
7
{
  "jobIds": [
    "string"
  ],
  "message": "string",
  "autoExecuted": true
}