Get Schedule Timeline
GET {{baseUrl}}/v2/schedules/:identifier/timeline?identifierType=id&expand=<string>,<string>&interval=1&intervalUnit=<string>&date=<dateTime>
Returns schedule timeline with given id or name
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
identifierType | string | Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name' | |
expand | string | Returns more detailed response with expanding it. Possible values are 'base', 'forwarding', and 'override' which is also returned with expandable field of response | |
interval | number | Length of time as integer in intervalUnits to retrieve the timeline. Default value is 1 | |
intervalUnit | string | Unit of the time to retrieve the timeline. Available values are 'days', 'weeks' and 'months'. Default value is 'weeks' | |
date | string | Time to return future date on-call participants. Default date is the moment of the time that request is received |
RESPONSES
status: OK
{"requestId":"labore est do exercitation dolor","took":0,"expandable":["tempor cillum dolor dolore","cul"],"data":{"_parent":{"id":"ut ","name":"eu do anim elit","enabled":false},"startDate":"2016-04-11T10:20:46.150Z","endDate":"2017-03-16T05:49:51.751Z","finalTimeline":{"rotations":[{"id":"esse temp","name":"dolor nostrud ut","order":79746928.9043912,"periods":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"id":"Lorem nostrud","name":"sed aliquip et aliqua dolore","order":-6235593.5261543095,"periods":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}]},"baseTimeline":{"rotations":[{"id":"enim proident","name":"labore","order":-33782148.02677198,"periods":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"id":"dol","name":"veniam laboris ut amet aute","order":-39763746.354619786,"periods":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}]},"overrideTimeline":{"rotations":[{"id":"sed in aliquip","name":"in officia","order":69447637.41847879,"periods":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"id":"sit est do","name":"do tempor incididunt sed","order":-97220899.29431869,"periods":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}]},"forwardingTimeline":{"rotations":[{"id":"no","name":"sint et veniam cupidatat","order":1398220.0704322457,"periods":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"id":"eu in laboris aliquip ea","name":"ad cupidatat","order":48499653.906475425,"periods":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}]}}}