Job - Solvice Docs

A job to be performed by a resource.

Name	Type	Required	Description
`name`	string	true	Unique description
`duration`	integer	false	Service duration of the job
`location`	Location	false	Job location
`priority`	integer	false	Priority of the job will ensure that it is included in the planning over other lower priority jobs.
`tags`	[Tag]	false	A tag is a string that can be used to link jobs to resources.
`windows`	[TimeWindow]	false	List of start/end date/time combinations.
`durationSquash`	integer	false	When a job is performed at the same location as another job, `durationSquash` ensures that the 2nd job’ service time is reduced to this value. Example: `duration=600` and `durationSquash=30` means that the 2nd job will only take 30 seconds to perform.
`plannedDate`	date	false	Fixed date on which this job is already planned and should hence be taken into account in the planning.
`plannedResource`	string	false	Name of the resource to which this job is already planned and should hence be taken into account in the next planning.
`plannedArrival`	date-time	false	Planned arrival time The second of day at which the job is planned to complete. The difference with the actual arrival time is scaled in the score with plannedWeight.
`hard`	boolean	false	In the case of partial planning, this indicates whether this job should be integrated into the planning or not.
`hardWeight`	integer	false	In the case of partial planning, this indicates the weight of this job.
`padding`	integer	false	Padding time (in seconds) before and after the job.
`allowedResources`	[string]	false	Resources that are allowed to be assigned to this job.
`load`	[int]	false	The load of the job expressed as list of integer values

TimeWindow

A time window is a time period in which a job can be performed.

Name	Type	Required	Description
`from`	date-time	true	Date time start of window
`to`	date-time	true	Date time end of window
`weight`	integer	false	Weight constraint modifier
`hard`	boolean	false	Hard constraint violation of DateWindow

Tag

Name	Type	Required	Description
`name`	string	true	Tag restriction name which can force some Jobs to be scheduled by Resources with the same tag
`hard`	boolean	false	Hard or soft constraint.
`weight`	integer	false	Value of the weight. This will be on the same level as travel time in the case of soft constraint.

Location

Name	Type	Required	Description
`latitude`	number	true	Latitude (WGS84)
`longitude`	number	true	Longitude (WGS84)

A job to be performed by a resource.

{
  "name": "Job-1",
  "duration": 5,
  "location": {
    "latitude": 50.0987624,
    "longitude": 4.93849204,
    "name": "<string>"
  },
  "priority": 100,
  "urgency": 100,
  "tags": [
    {
      "name": "Job-1",
      "hard": true,
      "weight": 5
    }
  ],
  "windows": [
    {
      "from": "2023-01-13T08:00",
      "to": "2023-01-18T12:00",
      "weight": 1,
      "hard": true
    }
  ],
  "durationSquash": 30,
  "plannedDate": "2022-03-10T00:00:00.000Z",
  "plannedResource": "<string>",
  "plannedArrival": "2023-01-13T09:00",
  "hard": true,
  "hardWeight": 1,
  "padding": 300,
  "load": [
    5,
    10
  ],
  "allowedResources": [
    "<string>"
  ],
  "initialResource": "<string>",
  "initialArrival": "2023-01-13T09:00",
  "disallowedResources": [
    "<string>"
  ]
}