Retrieve, modify, add, or delete reports, filters, and/or parameters.
Report Component Types
| Type | Element |
|---|---|
| 1 | Free Form Text |
| 2 | Table |
| 3 | Pie/Half-Pie Chart |
| 4 | Heat Map |
| 5 | Bar/Column Chart |
| 6 | N/A (Unsupported elements) |
| 7 | Repeatable Forms |
| 8 | Page Break |
Table Column Types
| Type | Element |
|---|---|
| 1 | Field |
| 2 | Relationship |
| 3 | Formula |
| 4 | Role |
| 5 | Property |
| 6 | Attachment Field |
| 7 | Workflow State |
GET /object/report
Retrieve all reports within the org.
Curl Request
curl -X GET --header 'Accept: application/json' --header 'Authorization: bearer YOUR_API_KEY' 'https://YOUR_ENVIRONMENT.resolver.com/object/report'
Success Response
200 OK
Example Response Body
{
"data": [
{
"id": 9017,
"name": "Risks & Controls By Location",
"description": "",
"nameKey": "app:report:name:820c6f98-b82d-496f-9df2-2e2da44a866f",
"descriptionKey": "app:report:description:231e091c-296b-43bf-a2d9-91a5eca5913b",
"objectTypeId": 4211,
"created": "2019-12-09T19:06:56.042Z",
"modified": "2019-12-09T19:14:58.577Z",
"org": 46,
"externalRefId": "8e197f22-774f-459f-b9a1-a087055c1fb7",
"nextReportComponentOrdinal": 0,
"type": 1,
"showArchiveData": false,
"nestloop": "org"
}GET /object/{reportId}/filter
Retrieve a report's filters.
Curl Request
curl -X GET --header 'Accept: application/json' --header 'Authorization: bearer YOU_API_KEY' 'https://YOUR_ENVIRONMENT.resolver.com/object/report/2203/filter'
Parameters
| Name | Parameter Type | Data Type | Description | Required |
|---|---|---|---|---|
| reportId | path | double | The internal ID of the report you want to retrieve filters from. | Yes |
Success Response
200 OK
Example Response Body
[
{
"id": 2159,
"reportId": 2203,
"type": 1,
"elementId": 12739,
"objectTypeId": 4207,
"subtype": 2,
"created": "2017-12-13T22:02:47.788Z",
"modified": null,
"org": 46,
"externalRefId": "1cc5eeee-8f0d-4030-8823-8052d23fdc3e",
"columnFilter": false,
"required": false
},
{
"id": 2165,
"reportId": 2203,
"type": 1,
"elementId": 12805,
"objectTypeId": 4197,
"subtype": 3,
"created": "2017-12-13T22:02:47.788Z",
"modified": null,
"org": 46,
"externalRefId": "23933d1b-f991-43ce-8a76-59a41f1b3a93",
"columnFilter": false,
"required": false
}
]GET /object/report/{reportId}/reportComponents
Retrieve a list of components (tables, pie charts, etc.) on a report.
Curl Request
curl -X GET --header 'Accept: application/json' --header 'Authorization: bearer YOUR_API_KEY' 'https://YOUR_ENVIRONMENT.resolver.com/object/report/2203/reportComponents'
Parameters
| Name | Parameter Type | Data Type | Description | Required |
|---|---|---|---|---|
| reportId | path | double | The internal ID of the report you want to retrieve components from. | Yes |
Success Response
200 OK
Example Response
{
"data": [
{
"id": 6177,
"reportId": 2262,
"reportDataDefinitionId": null,
"componentDataDefinitionId": null,
"displayProperties": {},
"showTotals": false,
"allData": true,
"libraryData": true,
"content": "The report outlines all requirements that are not applicable to the organization. If a requirement becomes applicable, click on the requirement below and click **Reassess Applicability** to submit the requirement for review by the Compliance Team. ",
"contentKey": "app:reportComponent:content:b9eab3e2-1d6a-4d56-82cb-cb4297c18208",
"xAxisLabel": null,
"xAxisLabelKey": null,
"yAxisLabel": null,
"yAxisLabelKey": null,
"groupByType": null,
"groupByRelationshipId": null,
"groupByObjectTypeId": null,
"type": 1,
"subtype": 1,
"ordinal": 0,
"created": "2018-11-22T16:06:42.749Z",
"modified": "2018-11-22T16:07:52.337Z",
"org": 46,
"externalRefId": "351e1f17-a258-4f80-86ad-e231b59d4b87",
"showColoredCellsAsOvals": false,
"dataProperties": {
"forms": {},
"columns": [],
"parameters": [],
"subtype": 1,
"componentDataDefinitionId": null,
"reportDataDefinitionId": null,
"showTotals": false,
"content": "The report outlines all requirements that are not applicable to the organization. If a requirement becomes applicable, click on the requirement below and click **Reassess Applicability** to submit the requirement for review by the Compliance Team. ",
"contentKey": "app:reportComponent:content:b9eab3e2-1d6a-4d56-82cb-cb4297c18208",
"xAxisLabel": null,
"xAxisLabelKey": null,
"yAxisLabel": null,
"yAxisLabelKey": null,
"groupById": null,
"groupByType": null,
"showColoredCellsAsOvals": false
}
},
{
"id": 6258,
"reportId": 2262,
"reportDataDefinitionId": 7420,
"componentDataDefinitionId": 7355,
"displayProperties": {},
"showTotals": false,
"allData": false,
"libraryData": true,
"content": "",
"contentKey": null,
"xAxisLabel": null,
"xAxisLabelKey": null,
"yAxisLabel": null,
"yAxisLabelKey": null,
"groupByType": null,
"groupByRelationshipId": null,
"groupByObjectTypeId": null,
"type": 1,
"subtype": 2,
"ordinal": 1,
"created": "2018-11-22T15:53:01.001Z",
"modified": "2018-11-22T16:08:13.652Z",
"org": 46,
"externalRefId": "7eb77b61-30a7-4fa2-aa3d-817e41fe2f83",
"showColoredCellsAsOvals": false,
"dataProperties": {
"enabledForms": {
"": false
},
"forms": {
"": 7358
},
"columns": [
{
"id": 19180,
"componentId": 6258,
"nodeId": 51077,
"type": 1,
"ordinal": 3,
"subtype": 0,
"identifier": 12549,
"objectTypeId": 4227,
"created": "2018-11-22T16:08:13.652Z",
"modified": null,
"org": 46,
"externalRefId": "249fa322-af5c-40e3-9865-531a1984cd62",
"readOnly": false,
"path": "",
"pathAnchor": 4227
},
],
"parameters": [],
"titles": {},
"subtype": 2,
"componentDataDefinitionId": 7355,
"reportDataDefinitionId": 7420,
"showTotals": false,
"content": "",
"contentKey": null,
"xAxisLabel": null,
"xAxisLabelKey": null,
"yAxisLabel": null,
"yAxisLabelKey": null,
"groupById": null,
"groupByType": null,
"showColoredCellsAsOvals": false
}
}
]
}