{"type":"doc","content":[{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"Table of Contents","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"2"},"maxLevel":{"value":"2"},"outline":{"value":"false"},"style":{"value":"disc"},"type":{"value":"list"},"printable":{"value":"true"}},"macroMetadata":{"macroId":{"value":"61238332-bf9b-4488-b70b-6e3bac86513a"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"c4d3f7d6-82a9-4778-af33-6fd7dc6cffa8"}}]},{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"blockquote","content":[{"type":"paragraph","content":[{"text":"About Reporting Service","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"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. ","type":"text"}]},{"type":"paragraph","content":[{"text":"These follow the ","type":"text"},{"text":"Common model for CollectionSpace REST services","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3577544705"}}]},{"text":".","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Report Contexts","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Reports are defined to support various types or ","type":"text"},{"text":"modes","type":"text","marks":[{"type":"em"}]},{"text":" of context, including a single CSID, a list of CSID values, or a group CSID (that has an associated list of objects). In addition, the context specifies one more more document (a.k.a. \"Record\") types. The primary function of the context allows the application to filter the full list of reports so that the UI will only display reports that make sense in the context of what the user is currently doing. Thus, e.g., if the user is editing an Intake record, the application can query the services for the set of reports that support a singleCSID context with the document type \"Intake.\"","type":"text"}]},{"type":"paragraph","content":[{"text":"Some reports may also support invocation with no context (e.g., a report that queries for all terms in the configured authorities that have status \"Proposed\"). These are defined to support \"NoContext.\"","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reporting CRUD+L services","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Create a Report","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a new Report record. Assigns a unique, service-specified ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":" to that Report record. Follows standard Create model. See the documentation of the Report schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"392197c8-2ede-4cd0-aafd-f0066bec89f7"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"POST /cspace-services/reports HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Read a Report","type":"text"}]},{"type":"paragraph","content":[{"text":"Reads an existing Report record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Read model. See the documentation of the Report schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"3ebea292-a0f1-407f-8704-9ad63cd85d08"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/reports/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update a Report","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates an existing Report record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/DOC/pages/2930129134"}}]},{"text":". Follows standard Update model. See the documentation of the Report schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"0a02808f-a353-42d1-a349-ef847bde4aaa"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/reports/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete a Report","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an existing Report record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/DOC/pages/2930129134"}}]},{"text":". Follows standard Delete model. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"cd2d9d31-bf4b-43ca-a730-a54bec7c6dbc"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DELETE /cspace-services/reports/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"List Report instances","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists existing Report records, with summary information for each. Follows standard List model, including support for the query parameter \"kw=","type":"text"},{"text":"term","type":"text","marks":[{"type":"em"}]},{"text":"\" for keyword search (useful to search on the name and description). Filtering on report characteristics is also supported. See also the documentation of the Report list schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c9ab20d1-4163-4f39-9703-f8678bb23dcb"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/reports/ HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":6},"content":[{"text":"Filtering","type":"text"}]},{"type":"paragraph","content":[{"text":"Three additional search parameters are supported, to filter the list of available reports. This is designed to support applications that want to present the reports appropriate to a given UI context. The query parameters are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To filter by the ","type":"text"},{"text":"mode","type":"text","marks":[{"type":"em"}]},{"text":" of invocation, the query parameter \"mode={","type":"text"},{"text":"single|list|group|nocontext","type":"text","marks":[{"type":"em"}]},{"text":"}\" specifies the ","type":"text"},{"text":"mode","type":"text","marks":[{"type":"em"}]},{"text":" that reports must support to be returned in the list results.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To filter by the ","type":"text"},{"text":"doctype","type":"text","marks":[{"type":"em"}]},{"text":" of invocation, the query parameter \"doctype={","type":"text"},{"text":"doctype","type":"text","marks":[{"type":"em"}]},{"text":"}\" specifies the name of the document type (a.k.a. record type) that reports must support to be returned in the list results.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To filter by the ","type":"text"},{"text":"filename","type":"text","marks":[{"type":"em"}]},{"text":" of the report, the query parameter \"filename={","type":"text"},{"text":"filename","type":"text","marks":[{"type":"em"}]},{"text":"}\" specifies the filename the report must have to be returned in the list results.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"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).","type":"text"}]},{"type":"paragraph","content":[{"text":"If multiple filter parameters are supplied, the filters are by default combined using an AND operator, so the results must satisfy ","type":"text"},{"text":"all","type":"text","marks":[{"type":"em"}]},{"text":" of the specified filters. This can be changed by adding the ","type":"text"},{"text":"combine=or","type":"text","marks":[{"type":"code"}]},{"text":" parameter to the list request. Setting ","type":"text"},{"text":"combine","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"or","type":"text","marks":[{"type":"code"}]},{"text":" causes the supplied filters to be combined using an OR operator, so reports satisfying ","type":"text"},{"text":"any","type":"text","marks":[{"type":"em"}]},{"text":" of the filters are returned.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reporting Invocation services","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Invoke a Report with no context","type":"text"}]},{"type":"paragraph","content":[{"text":"Invokes a Report to produce a new instance of the output. When invoked without context, a simple resource is available:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"d897fc0b-a9b1-4311-b3b8-4e719bbf6ffd"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/reports/{id}/output HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"If the specified report does not support invocation with \"NoContext\", an error will be returned.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Invoke a Report with context","type":"text"}]},{"type":"paragraph","content":[{"text":"Invokes a Report to produce a new instance of the output.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"1b742746-ead6-440c-a6aa-bd378989cfdd"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"POST /cspace-services/reports/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"The invocation payload uses the following simple schema. E.g., to invoke with a single Intake:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b638d8fe-a595-43d2-8bb2-af5775c79c73"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" single","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Intake","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 605e9252-598d-4459-8380","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"To invoke with a list of CollectionObjects:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"83713330-35ef-4bda-8ffd-5c573efc1bbb"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" list","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" CollectionObject","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 605e9252-598d-4459-8380","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 9252605e-1234-2345-3456","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"To invoke with a group of CollectionObjects, use the following. Note that while the Group is a distinct type of record, the docType specifies the type of related documents that the group contains, and that the report is authored for.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"3b63689c-d454-4cae-8c32-e80325fdc90a"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" group","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" CollectionObject","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 605e9252-598d-4459-8380","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"If the specified report does not support invocation with the passed context (either the mode or the docType), an error will be returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"If an error occurs within the report (e.g., if the passed CSID is not of the correct type, or there is an error in the SQL in the report definition), an error will be returned.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reporting REST payload schemas","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Reporting instance schema","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The schemas below are severely abbreviated, and are thus illustrative. For a full list of the fields that may potentially be present in payloads when creating, updating, or reading individual Report records, please see ","type":"text"},{"text":"the most recent Report record schema","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/collectionspace/services/blob/main/services/report/jaxb/src/main/resources/reports-common.xsd"}}]},{"text":".","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Create and Update should use the following schema:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"4a3e899f-e236-4de8-b8a0-37acba762863"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Acquisition Summary","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Just a few fields about a single acquisition","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" application/pdf","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" acq_single.jasper","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" false","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" true","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" false","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" false","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Acquisition","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Intake","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph"}]}]}]},{"type":"paragraph","content":[{"text":"Read will return the following schema (in addition to the standard collectionspace_core and account permission schemas):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ed4a7846-2685-489b-90d0-e3451637ce21"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Acquisition Summary","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Just a few fields about a single acquisition","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" application/pdf","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" acq_single.jasper","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" false","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" true","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" false","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" false","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Intake","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Reporting list schema","type":"text"}]},{"type":"paragraph","content":[{"text":"List (and variants) will return the following schema. This schema includes the ","type":"text"},{"text":"uri","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"csid","type":"text","marks":[{"type":"em"}]},{"text":" fields to help facilitate access to individual records:","type":"text"}]},{"type":"table","attrs":{"layout":"center","width":760.0,"localId":"e2d90015-4d78-471d-afef-fc8deafde772"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" 0","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" 40","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" 1","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" 1","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" csid|uri|updatedAt|name","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" 48fab3cf-dbd1-4b67-b4a7","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" /reports/48fab3cf-dbd1-4b67-b4a7","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" 2011-07-20T21:05:00Z","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" Acquisition Summary","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"rule"}],"version":1}

Browser not supported