Connect REST API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Field Service Shifts from Pattern Resource
- Resource
-
/connect/field-service/shift-patterns/shiftPatternId/shifts - Available version
- 51.0
- HTTP methods
- GET, POST
- Request body for GET and POST
- Use GET to preview the shifts created from a pattern. Use POST to create shifts from a
pattern.
- Root XML tag
- <shiftsFromPattern>
- JSON example
-
{ "schedulingStartDate": "2020-11-01" "schedulingEndDate": "2020-12-01" } - Properties
-
Name Type Description Required or Optional Available Version schedulingEndDate String Scheduling end date in YYYY-MM-DD format. Provide schedulingEndDate or schedulingOccurrences. Don’t provide both.
Required if schedulingOccurrences isn’t provided 51.0 schedulingOccurrences Integer Number of scheduling occurrences. Provide schedulingEndDate or schedulingOccurrences. Don’t provide both.
Required if schedulingEndDate isn’t provided 51.0 schedulingStartDate String Scheduling start date in YYYY-MM-DD format. Required 51.0 serviceResourceId String ID of the service resource to assign shifts to. In version 53.0 and later, use serviceResourceIdList.
Optional 51.0–52.0 serviceResourceIdList String[] List of service resource IDs to assign shifts to. Optional 53.0 serviceTerritoryId String ID of the service territory to assign shifts to. Optional 51.0 shiftStatus String Status of the shifts. Default values are: - Confirmed
- Published
- Tentative
Optional 52.0
- Response body for GET and POST
- Shifts from Pattern