Quotes Schedules API

Action	Endpoint
Fetch Schedules for a quote	GET/policy/{tenantLocator}/quotes/{locator}/schedules
Fetch a Schedule and items	GET/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}
Upload Quote Schedule Items for Deserialization	POST/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}/deserialize
Add items to schedule	PUT/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}
Upload a CSV of schedule items	POST/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}
Delete an item from schedule	DELETE/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}
Update a schedule item	PATCH/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}

Fetch

Fetch Schedules for a quote

Fetch Schedules for a quotefetchSchedules

GET/policy/{tenantLocator}/quotes/{locator}/schedules

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:map<string, ElementScheduleResponse>

Security Group:quotes

Permissions:

read,schedule-read

ElementScheduleResponse

Required properties

Property	Type	Description
`staticElementLocator`	`ulid`
`complexData`	`boolean`
`elementType`	`string`
`maxValidationErrors`	`integer`
`scheduleItemType`	`string`

Fetch a Schedule and items

Fetch a Schedule and itemsfetchScheduleItems

GET/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`staticElementLocator`	path	`ulid`	Yes
`lastSeenLocator`	query	`ulid?`	No

Response:ScheduleItemsResponse

Security Group:quotes

Permissions:

read,schedule-read

ScheduleItemsResponse

Required properties

Property	Type	Description
`lastSeenLocator`	`ulid`
`items`	`ScheduleItem[]`

Upload Quote Schedule Items for Deserialization

Upload Quote Schedule Items for DeserializationuploadDeserializedScheduleItems

POST/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}/deserialize

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`staticElementLocator`	path	`ulid`	Yes
`params`	query	`map<string, string>`	Yes

Request:file

Response:DeserializationResponse

Security Group:quotes

Permissions:

write,schedule-add

DeserializationResponse

Required properties

Property	Type	Description
`jobLocator`	`ulid`

Updating

Add items to schedule

Add items to scheduleaddScheduleItems

PUT/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`staticElementLocator`	path	`ulid`	Yes

Request:AddScheduleItemRequest[]

Response:ValidationResult

Security Group:quotes

Permissions:

write,schedule-add

AddScheduleItemRequest

Required properties

Property	Type	Description
`data`	`map<string, object>`

ScheduleItem

Required properties

Property	Type	Description
`locator`	`ulid`
`staticElementLocator`	`ulid`
`type`	`string`
`data`	`map<string, object>`
`createdAt`	`datetime`
`createdBy`	`uuid`

API requests to add items to a schedule are limited to 500 items

Upload a CSV of schedule items

Upload a CSV of schedule itemsuploadScheduleItems

POST/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`staticElementLocator`	path	`ulid`	Yes

Request:file

Response:ValidationResult

Security Group:quotes

Permissions:

write,schedule-add

CSV for bulk upload of schedule items only support flat item data structures i.e. no nested objects in the schedule definition.

Delete an item from schedule

Delete an item from scheduledeleteScheduleItems

DELETE/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`staticElementLocator`	path	`ulid`	Yes

Request:ulid[]

Response:void

Security Group:quotes

Permissions:

write,schedule-delete

Delete individual items from a schedule by specifying their locator within the string array of the request.

Update a schedule item

Update a schedule itemupdateScheduleItems

PATCH/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`staticElementLocator`	path	`ulid`	Yes

Request:PatchScheduleItemRequest[]

Response:ValidationResult

Security Group:quotes

Permissions:

write,schedule-update

PatchScheduleItemRequest

Required properties

Property	Type	Description
`locator`	`ulid`
`removeData`	`map<string, object>`
`setData`	`map<string, object>`

Quotes Schedules API

Fetch

Fetch Schedules for a quote

Fetch a Schedule and items

Upload Quote Schedule Items for Deserialization

Updating

Add items to schedule

Upload a CSV of schedule items

Delete an item from schedule

Update a schedule item

See Also

On this page