Quotes Schedules API
| Action | Endpoint |
|---|---|
| Fetch Quote Schedules | GET/policy/{tenantLocator}/quotes/{locator}/schedules |
| Fetch a Quote Schedule and Items | GET/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator} |
| Fetch a Quote Schedule Item | GET/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}/{scheduleItemLocator} |
| Upload Quote Schedule Items for Deserialization | POST/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}/deserialize |
| Upload a CSV of Quote Schedule Items | POST/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator} |
| Add Items to Quote Schedule | PUT/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator} |
| Update a Quote Schedule Item | PATCH/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator} |
| Delete an Item From Quote Schedule | DELETE/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator} |
Fetch
Fetch Quote Schedules
Fetch Quote Schedules
fetchSchedulesGET
/policy/{tenantLocator}/quotes/{locator}/schedulesParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Response:
map<string, ElementScheduleResponse>Security Group:
quotesPermissions:
read,schedule-readElementScheduleResponse
Required properties
| Property | Type | Description |
|---|---|---|
staticElementLocator | ulid | |
complexData | boolean | |
elementType | string | |
maxValidationErrors | integer | |
scheduleItemType | string |
Fetch a Quote Schedule and Items
Fetch a Quote Schedule and Items
fetchScheduleItemsGET
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes | |
staticElementLocator | path | ulid | Yes | |
lastSeenLocator | query | ulid? | No |
Response:
ScheduleItemsResponseSecurity Group:
quotesPermissions:
read,schedule-readScheduleItemsResponse
Required properties
| Property | Type | Description |
|---|---|---|
lastSeenLocator | ulid | |
items | ScheduleItem[] |
Fetch a Quote Schedule Item
Fetch a Quote Schedule Item
fetchScheduleItemGET
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}/{scheduleItemLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes | |
staticElementLocator | path | ulid | Yes | |
scheduleItemLocator | path | ulid | Yes |
Response:
ScheduleItemSecurity Group:
quotesPermissions:
read,schedule-readScheduleItem
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
staticElementLocator | ulid | |
type | string | |
data | map<string, object> | |
createdAt | datetime | |
createdBy | uuid |
Update
Upload Quote Schedule Items for Deserialization
Upload Quote Schedule Items for Deserialization
uploadDeserializedScheduleItemsPOST
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}/deserializeParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes | |
staticElementLocator | path | ulid | Yes | |
params | query | map<string, string> | Yes |
DeserializationResponse
Required properties
| Property | Type | Description |
|---|---|---|
jobLocator | ulid |
Upload a CSV of Quote Schedule Items
Upload a CSV of Quote Schedule Items
uploadScheduleItemsPOST
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes | |
staticElementLocator | path | ulid | Yes |
CSV for bulk upload of schedule items only supports flat item data structures, meaning no nested objects in the schedule definition.
Add Items to Quote Schedule
Add Items to Quote Schedule
addScheduleItemsPUT
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes | |
staticElementLocator | path | ulid | Yes |
Request:
AddScheduleItemRequest[]Response:
ValidationResultSecurity Group:
quotesPermissions:
write,schedule-addAddScheduleItemRequest
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
Update a Quote Schedule Item
Update a Quote Schedule Item
updateScheduleItemsPATCH
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes | |
staticElementLocator | path | ulid | Yes |
Request:
PatchScheduleItemRequest[]Response:
ValidationResultSecurity Group:
quotesPermissions:
write,schedule-updatePatchScheduleItemRequest
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
removeData | map<string, object> | |
setData | map<string, object> |
Delete an Item From Quote Schedule
Delete an Item From Quote Schedule
deleteScheduleItemsDELETE
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes | |
staticElementLocator | path | ulid | Yes |
Request:
ulid[]Response:
voidSecurity Group:
quotesPermissions:
write,schedule-deleteDelete individual items from a schedule by specifying their locator within the string array of the request.