Policy Transactions Schedules API

Endpoint Index

Action	Endpoint
Get Schedules for a transaction	GET /policy/{tenantLocator}/transactions/{locator}/schedules
Get a Schedule and items	GET /policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}
Add items to schedule	PUT /policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}
Upload a CSV of schedule items	POST /policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}
Delete an item from schedule	DELETE /policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}
Update a schedule item	PATCH /policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}

Fetch

Get Schedules for a transaction

getTransactionSchedules

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:map<string,ElementScheduleResponse>
Security Group:transactions   Permissions:read,schedule-read

ElementScheduleResponse

required
staticElementLocator string
complexData boolean
elementType string
maxValidationErrors int
scheduleItemType string

Get a Schedule and items

getTransactionSchedule

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
staticElementLocator	path	string	required
lastSeenLocator	query	string?	optional

Response:ScheduleItemsResponse
Security Group:transactions   Permissions:read,schedule-read

ScheduleItemsResponse

required
lastSeenLocator string
items ScheduleItem[]

ScheduleItem

required
locator string
staticElementLocator string
data map<string,object>
createdAt datetime
createdBy uuid

Updating

Add items to schedule

addTransactionSchedule

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
staticElementLocator	path	string	required

Request:AddScheduleItemRequest[]
Response:ValidationResult
Security Group:transactions   Permissions:write,schedule-add

AddScheduleItemRequest

required
data map<string,object>

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

Upload a CSV of schedule items

uploadTransactionSchedule

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
staticElementLocator	path	string	required

Request:file
Response:ValidationResult
Security Group:transactions   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

deleteTransactionSchedule

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
staticElementLocator	path	string	required

Request:string[]
Response:void
Security Group:transactions   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

updateTransactionSchedule

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
staticElementLocator	path	string	required

Request:PatchScheduleItemRequest[]
Response:ValidationResult
Security Group:transactions   Permissions:write,schedule-update

PatchScheduleItemRequest

required
locator string
removeData map<string,object>
setData map<string,object>

See Also

• Schedules Feature Guide