Policy Transactions Schedules API
| Action | Endpoint |
|---|---|
| Get Transaction Schedules | GET/policy/{tenantLocator}/transactions/{locator}/schedules |
| Get a Transaction Schedule and Items | GET/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator} |
| Get a Transaction Schedule Item | GET/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}/{scheduleItemLocator} |
| Download Quote Schedule Items | GET/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}/csv |
| Download Transaction Schedule Items | GET/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}/csv |
| Upload Transaction Schedule Items for Deserialization | POST/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}/deserialize |
| Upload a CSV of Transaction Schedule Items | POST/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator} |
| Add Items to Transaction Schedule | PUT/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator} |
| Update a Transaction Schedule Item | PATCH/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator} |
| Delete an Item from Transaction Schedule | DELETE/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator} |
Fetch
Get Transaction Schedules
Get Transaction Schedules
getTransactionSchedulesGET
/policy/{tenantLocator}/transactions/{locator}/schedulesParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Response:
map<string, ElementScheduleResponse>Security Group:
transactionsPermissions:
read,schedule-readElementScheduleResponse
Required properties
| Property | Type | Description |
|---|---|---|
staticElementLocator | ulid | |
complexData | boolean | |
elementType | string | |
maxValidationErrors | integer | |
scheduleItemType | string |
Get a Transaction Schedule and Items
Get a Transaction Schedule and Items
getTransactionScheduleGET
/policy/{tenantLocator}/transactions/{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:
transactionsPermissions:
read,schedule-readScheduleItemsResponse
Required properties
| Property | Type | Description |
|---|---|---|
lastSeenLocator | ulid | |
items | ScheduleItem[] |
ScheduleItem
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
staticElementLocator | ulid | |
type | string | |
data | map<string, object> | |
createdAt | datetime | |
createdBy | uuid |
Get a Transaction Schedule Item
Get a Transaction Schedule Item
getTransactionScheduleItemGET
/policy/{tenantLocator}/transactions/{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:
transactionsPermissions:
read,schedule-readScheduleItem
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
staticElementLocator | ulid | |
type | string | |
data | map<string, object> | |
createdAt | datetime | |
createdBy | uuid |
Download Quote Schedule Items
Download Quote Schedule Items
downloadScheduleItemsCsvGET
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}/csvParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes | |
staticElementLocator | path | ulid | Yes |
Response:
StreamingResponseBody<string>Security Group:
quotesPermissions:
read,schedule-readDownload Transaction Schedule Items
Download Transaction Schedule Items
downloadTransactionScheduleItemsCsvGET
/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}/csvParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes | |
staticElementLocator | path | ulid | Yes |
Response:
StreamingResponseBody<string>Security Group:
transactionsPermissions:
read,schedule-readUpdate
Upload Transaction Schedule Items for Deserialization
Upload Transaction Schedule Items for Deserialization
uploadDeserializedTransactionSchedulePOST
/policy/{tenantLocator}/transactions/{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 |
Request:
fileResponse:
DeserializationResponseSecurity Group:
transactionsPermissions:
write,schedule-addDeserializationResponse
Required properties
| Property | Type | Description |
|---|---|---|
jobLocator | ulid |
Upload a CSV of Transaction Schedule Items
Upload a CSV of Transaction Schedule Items
uploadTransactionSchedulePOST
/policy/{tenantLocator}/transactions/{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 Transaction Schedule
Add Items to Transaction Schedule
addTransactionSchedulePUT
/policy/{tenantLocator}/transactions/{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:
transactionsPermissions:
write,schedule-addAddScheduleItemRequest
Required properties
| Property | Type | Description |
|---|---|---|
data | map<string, object> |
API requests to add items to a schedule are limited to 500 items
Update a Transaction Schedule Item
Update a Transaction Schedule Item
updateTransactionSchedulePATCH
/policy/{tenantLocator}/transactions/{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:
transactionsPermissions:
write,schedule-updatePatchScheduleItemRequest
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
removeData | map<string, object> | |
setData | map<string, object> |
Delete an Item from Transaction Schedule
Delete an Item from Transaction Schedule
deleteTransactionScheduleDELETE
/policy/{tenantLocator}/transactions/{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:
transactionsPermissions:
write,schedule-deleteDelete individual items from a schedule by specifying their locator within the string array of the request.