Get all Resource allocations

get

https://api.rocketlane.com/api/1.0/resource-allocations

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Get All Resource Allocations API allows you to search and retrieve comprehensive allocation data for various projects. This endpoint is valuable for accessing detailed resource allocation information, suitable for analysis or integration into applications.

You can customize the response using the includeFields parameter. Sorting options, sortBy and sortOrder, allow additional customization, while the paginated response is controlled using pageSize and pageToken parameters.

Pagination

The Get all Resource allocations API accommodates pagination in the response body. The pageSize option can be used to restrict the amount of responses displayed/available in a single request. Additionally, if there are more entries than the ones accessible in the answer, the response(s) may contain the nextPageToken.

Please refer to the pagination section for further information on this.

Filtering

The capacity to execute more sophisticated and nuanced searches on a dataset by combining numerous criteria and conditions is referred to as filtering.

Complex filtering in the context of the Get all Resource allocations API allows users to build elaborate search queries to return specific subsets of resource allocations that satisfy specific requirements. By catering to a wide range of use cases, this enhanced filtering functionality considerably increases the API's utility and versatility.

The API reference includes a comprehensive range of filtering options.

Please refer to the link here for more information on how to construct the filtering criteria.

Criteria Match

The Get all Resource allocations API also supports the use of AND and OR conditions for more advanced filtering options. Users can combine different filters and custom field queries with these logical operators to build complex yet accurate search queries.

In case any issues arise or further assistance is required, please refer to the error handling section or reach out to our support team at [email protected] for a prompt resolution.

Query Params

startDate

string

required

You can use this parameter to define the start date, and the API response will return all resource allocations that start on or after the specified date.

endDate

string

required

You can use this parameter to define an end date, and the API will return allocations that end on or before the specified date.

pageSize

number

≥ 0

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageToken

string

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

includeFields

array of strings

Use this query parameter to opt in for fields to be returned in the response body. Use comma separated values to fetch the respective fields. If left blank, default properties are returned.

includeFields

Allowed:

includeAllFields

boolean

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

sortBy

string

enum

You can use the sortBy param to sort the responses by the given field.

Allowed:

sortOrder

string

enum

The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.

Allowed:

match

string

enum

You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.

Allowed:

memberId.eq

string

You can use this parameter to specify a member id, and the API will return allocations that exactly match the given member id. This allows for precise filtering of allocations based on the specified user.

memberId.oneOf

string

You can use this parameter to specify multiple member ids, separated by commas, and the API will return allocations that match any of the provided member ids.

memberId.noneOf

string

You can use this parameter to specify multiple member ids, separated by commas, and the API will return allocations that exclude any of the provided member ids.

projectId.eq

string

You can use this parameter to specify a project id, and the API will return allocations that exactly match the given project id.

projectId.oneOf

string

You can use this parameter to specify multiple project ids, separated by commas, and the API will return allocations that match any of the provided project ids.

projectId.noneOf

string

You can use this parameter to specify multiple project ids, separated by commas, and the API will return allocations that exclude any of the provided project ids.

placeholderId.eq

string

You can use this parameter to specify a placeholder id, and the API will return allocations that exactly match the given placeholder id.

placeholderId.oneOf

string

You can use this parameter to specify multiple placeholder ids, separated by commas, and the API will return allocations that match any of the provided placeholder ids.

placeholderId.noneOf

string

You can use this parameter to specify multiple placeholder ids, separated by commas, and the API will return allocations that exclude any matching placeholder ids.

Responses

Pagination

Filtering

Criteria Match

200The requested action was successfully executed.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.