/api/definitions
Report definitions are defined primarily by a ReportDefinition object. There are also sub-types of ReportDefinition which all of the report APIs accept:
The following resources are applicable:
/definitions
GET
Returns all report definitions.
Parameters
| name | description | type | default |
|---|---|---|---|
| size | The number of reports to return. | query | 10 |
| offset | Used with size to indicate where to start the result set. | query | 0 |
| summary | True if concise format required, | query | false |
Response Body
| element: | definitions |
| media types: | text/plain application/json |
output = A list of report definitions.
Status Codes
| HTTP Status Code | Description |
|---|---|
| 200 OK | OK; the requested operation was successful |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |
POST
This method creates a new report definition.
Request Body
| element: | json |
| media types: | application/json |
input = content of the report definition, in JSON format, dataType=string
Response Body
| element: | reportDefinition |
| media types: | application/xml application/json |
output = The associated Job ID
Status Codes
| HTTP Status Code | Description |
|---|---|
| 201 Created | the request has been fulfilled and resulted in a new resource being created |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |
/definitions/{mid }
GET
This method returns the report definition associated with the supplied unique ID.
Parameters
| name | description | type | default |
|---|---|---|---|
| mid | Report ID. | path | |
| details | True if specifics about the type of the report are shown, such as AdHoc or Trending details. If false, only details not associated with a report type are shown, such as name, filter or time range. | query | true |
| summary | True if concise format required, | query | false |
Response Body
| element: | reportDefinition |
| media types: | text/plain application/json |
output = A single report definition.
Status Codes
| HTTP Status Code | Description |
|---|---|
| 200 OK | OK; the requested operation was successful |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |
PUT
Updates a report definition.
Parameters
| name | description | type | default |
|---|---|---|---|
| mid | Current report definition ID. | path |
Request Body
| element: | json |
| media types: | application/json |
The new report definition.
Response Body
| element: | reportDefinition |
| media types: | */* application/xml |
output = none
Status Codes
| HTTP Status Code | Description |
|---|---|
| 200 OK | OK; the resource was updated successfully |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |
/definitions/count
GET
Returns the total count of the report definitions.
Response Body
| element: | (custom) |
| media types: | text/plain |
output = The total count of the report definitions.
Status Codes
| HTTP Status Code | Description |
|---|---|
| 200 OK | OK; the requested operation was successful |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |
/definitions/ismyreport/{mid }
GET
Returns true if the report is included in the list of saved reports.
Parameters
| name | description | type | default |
|---|---|---|---|
| mid | The report definition ID. | path |
Response Body
| element: | (custom) |
| media types: | text/plain |
output = True if the report is tagged as a "MyReport."
Status Codes
| HTTP Status Code | Description |
|---|---|
| 200 OK | OK; the requested operation was successful |
| 400 Bad Request | bad or malformed request |
| 404 Not Found | the resource does not exist |
| 406 Not Acceptable | required representation is not supported by the server |
| 500 Internal Server Error | internal server error |
| 503 Service Unavailable | service is unavailable |