Platform | Data Report
Service to manage entities of type 'OfflineReport'.
Overview
| URL | api/{tenantKey}/{orgKey}/reporting/offlineReports |
| Methods Supported | GET, DELETE |
All Operations
This service includes the following operations:
- GET:
- DELETE:
All Resources
This service uses the following resources:
GET OfflineReports
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See OfflineReportResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET OfflineReports (paged)
Returns a page of the list of all the entity records available.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See OfflineReportResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET OfflineReport by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See OfflineReportResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET OfflineReport by key
Returns the entity record that matches the specified key.
The following elements are required:
| number | (int) Number. |
Response:
| When successful, the response body contains the entity record. See OfflineReportResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET Print OfflineReport by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
GET Print OfflineReport by key
Prints the specified entity record.
The following elements are required:
| number | (int) Number. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET Original Print OfflineReportOriginal by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
GET Original Print OfflineReport by key
Prints the specified entity record.
The following elements are required:
| number | (int) Number. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET Get Data
Custom operation 'GetData'.
The following elements are required:
| id | (string) Id. |
| parameters | (string) A key and value collection. This will replace parameters in the DataSourceUri. |
Response:
| When successful, the response body contains a string. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE OfflineReport by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE OfflineReport by key
Deletes the entity record that matches the specified key.
The following elements are required:
| number | (int) Number. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
OfflineReportResource
The following elements are required:
| number | (int) Number. |
The following elements are optional:
| description | (string) Description. |
| origin | (string) Origin. |
| generatedOn | (DateTimeOffset) Generated On. |
| expiresOn | (DateTimeOffset) Expires On. |
| data | (string) Data. |
| dataSourceUri | (string) Data Source Uri. |
| isUntrustedSourceUri | (bool) Is Untrusted Source Uri. |
| template | (string) Template. |
| templateSourceUri | (string) Template Source Uri. |
| isUntrustedTemplateUri | (bool) Is Untrusted Template Uri. |