v1

latestOpenAPI 3.0.12026-07-13139143370.4 KB
Resources

List Resource Allocations

Use this endpoint to return a list of Resource Allocations for a specified resource. We recommend using allocations if a resource's schedule changes frequently from day to day or week to week. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

get/setup/v1/resources/{id}/allocations

Path parameters

idstring required

id of resource to list allocations for

Query parameters

startDatestring date-time

yyyy-mm-dd, filter allocations on/after startDate

endDatestring date-time

yyyy-mm-dd, filter on/before endDate

offsetinteger

Starting row of page, default 0

limitinteger

Page limit default 20, max 100

Response

resource allocation objects

objectstring nullable
urlstring nullable
hasMoreboolean
countinteger
totalinteger