This is an initial announcement highlighting upcoming changes to the Capella Public API scheduled to be released on July 12, 2023.
Advanced task search capabilities
We are developing exciting enhancements to the POST /tasks/search and POST /repeat-requests/search public API endpoints to significantly improve the ability for API users to query task data.
Summary of enhancements
- Support for advanced search based on the following attributes:
- Imaging mode
- Last status code
- 'code' property of latest status item in the task statusHistory object
- Last status message
- 'message' property of latest status item in the task statusHistory object
- Last status time
- 'time' property of latest status item in the task statusHistory object
- Organization id
- Repeat request id
- Reseller id
- Submission time
- Tasking request id
- Task status
- Tasking tier
- User id
- Window open
- Window close
- Support for comparison operators in advanced search criteria:
- Starts-with (string)
- Ends-with (string)
- Contains (string)
- In (string list)
- Support for datetime specific search operators:
- Exact datetime
- Interval (closed)
- Between two datetimes
- Interval (open)
- Before or after a datetime
The current Capella Public API is limited to searching based on single values for Organization Id, Reseller Id, and / or User Id and does not include any ability to search by dates, so this represents a compelling improvement to our API capabilities.
Breaking change to POST /repeat-requests/search endpoint
To implement these changes as well as to standardize the API schema across endpoints, we will be making several breaking changes to the POST /repeat-requests/search endpoint specifically.
The current POST /repeat-requests/search endpoint supports the following parameters:
The following changes will be made to the schema for this endpoint:
- The filter parameter will be replaced by a query parameter to be consistent with the POST /tasks/search as well as other endpoints throughout the Capella Public API.
- The skip parameter will be replaced by a page parameter to support pagination in a manner that is consistent with other endpoints throughout the Capella Public API
Additionally, the API endpoint response will change to a paged format. Instead of the JSON response entity being an Array, it will be an Object with keys:
Capella Space understands the impact of breaking API changes and makes every effort to limit their frequency and impact.
Detailed technical specifications for these changes will be documented and posted to our support site during the week of Monday June 26 in advance of the public release scheduled for July 12, 2023.
If you have any questions or concerns, please reach out to firstname.lastname@example.org.