The Get all phases API enables users to find phases in their Rocketlane instances using advanced filtering options. This API is intended to provide a flexible and fast means of getting phase related data based on various parameters.
Developers can integrate phase search functionality into their applications and platforms by using this API. You can fine-tune your searches and retrieve the phase related data you need for integration into your applications or platforms by using the available parameters.
The includeFields param can be used to customize the response. You can fine-tune your searches and retrieve specific phase related data you need for integration into your applications or platforms by using filters.
You can use any combination of these parameters to execute searches based on your specifications. In addition to filters, sortBy and sortOrder can be used to sort the phases. The response body is paginated, and you can control the pagination using the limit and pageToken parameters.
Pagination
The Get all phases 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 a pageToken.
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 phases API allows users to build elaborate search queries to return specific subsets of phases 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.
The Get all phases API offers custom field filtering in addition to the regular filtering options. You can apply filters for these fields: startDate, projectID, dueDate, startDateActual, dueDateActual, phaseName.
Please refer to the below table for more information on how to construct the filtering criteria for phase related fields.
| Operation | Definition | Example |
|---|---|---|
| field.gt | You can use this parameter to indicate a field's value, and the responses will only include those particular resources whose field value is greater than the specified field value. | startDate.gt=2023-09-31 |
| field.eq | You can use this parameter to indicate a field's value, and the responses will only include those particular resources whose field value matches the specified field value. | projectId.eq |
| field.lt | You can use this parameter to indicate a field's value, and the responses will only include those particular resources whose field value is less than the specified field value. | startDateActual.lt |
| field.ge | You can use this parameter to indicate a field's value, and the responses will only include those particular resources whose field value is greater than or equal to the specified field value. | startDateActual.ge |
| field.le | You can use this parameter to indicate a field's value, and the responses will only include those particular resources whose field value is less than or equal to the specified field value. | dueDateActual.le |
| field.cn | You can use this param to specify some text and the responses will include those particular resources that contain the given text in their field value. | phaseName.cn |
| field.nc | You can use this param to specify some text and the responses will include those particular resources that DO NOT contain the given text in their field value. | phaseName.nc |
Criteria Match
In addition to standard filtering and custom field filtering, the Get all phases 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.