...
The Reporting Service offers a REST-based Application Programming Interface (API) to CRUD (create, read, update, and delete) operations on individual Reporting instances, plus list operations on multiple Reporting instances. These follow the Common model for CollectionSpace REST services.
- Reporting Service RESTful APIs#Reporting CRUD+L services
- Reporting Service RESTful APIs#Reporting Invocation services
- Reporting Service RESTful APIs#Reporting REST payload schemas1565363226
- 1565363226
- 1565363226
Reporting CRUD+L services
...
Lists existing Report records, with summary information for each. Follows standard List model, including support for the query parameter "kw=term" for keyword search (useful to search on the name and description). Also supported filtering by context - see the note on Filtering for context, belowFiltering on report characteristics is also supported. See also the documentation of the Report list schema, below. Example:
| Code Block |
|---|
GET /cspace-services/reports/ HTTP/1.1 |
Filtering
...
Two Three additional search parameters are supported, to filter the list of available reports for a given context. This is designed to support applications that want to present the reports appropriate to a given UI context. The query parameters are:
- To filter by the mode of invocation, the query parameter "mode={single|list|group|nocontext}" specifies the mode that reports must support to be returned in the list results.
- To filter by the doctype of invocation, the query parameter "doctype={doctype}" specifies the name of the document type (a.k.a. record type) that reports must support to be returned in the list results.
- To filter by the filename of the report, the query parameter "filename={filename}" specifies the filename the report must have to be returned in the list results.
Note that reports can support more than one mode and/or docType, and different values for these filters will not produce mutually exclusive results (a given report may be returned in multiple filtered lists).
If multiple filter parameters are supplied, the filters are by default combined using an AND operator, so the results must satisfy all of the specified filters. This can be changed by adding the combine=or parameter to the list request. Setting combine to or causes the supplied filters to be combined using an OR operator, so reports satisfying any of the filters are returned.
Reporting Invocation services
...