...
Visibility | Access |
|---|
public (default) | Accessible by all users. Anyone can discover and consume these Reports. |
|---|
protected | Accessible only to a limited set of users based on a criteria defined by the access path attribute. Default can be user with REPORT_VIEWER role belonging to the same channel or tenant. |
|---|
private | Similar to “protected” - accessible only by the creator of the report. |
|---|
...
URL: /report/datasets/get/:reportId?from=<>&to=<>&since=<>
| Expand |
|---|
| title | API to get materialized data from the dataset |
|---|
|
Proposed response structure - to get meta + datasets.
Success Scenario - Status Code 200 | Code Block |
|---|
| {
"id": "api.report.read",
"ver": "string",
"ts": "timestamp",
"params": {
"resmsgid": "string",
"msgid": "string",
"status": "success",
"err": "string",
"errmsg": "string"
},
"responseCode": "OK",
"result": {
"metadata": {... similar to above API},
"datasets": [
{
"dataset_id": "dataset_id_1"
"isParameterized": true,
"parameters": ["$state"],
"data": {
"rj": {
"signedUrl": "url"
},
"tn": {
"signedUrl": "url"
},
"...otherParameters": {
"signedUrl": "url"
}
}
},
{
"dataset_id": "dataset_id_2"
"isParameterized": false,
"parameters": null,
"data": {
"default": {
"signedUrl": "url"
}
}
}
]
}
} |
Explanation -
Error Response
Unauthorized Access - Status Code 401
| Code Block |
|---|
| {
"id": "api.report.read",
"ver": "v1",
"ts": "timestamp",
"params": {
"resmsgid": null,
"msgid": "string",
"err": "UNAUTHORIZED_USER",
"status": "UNAUTHORIZED_USER",
"errmsg": "You are not authorized."
},
"responseCode": "UNAUTHORIZED",
"result": {}
} |
Internal Server Error - Status Code - 500
| Code Block |
|---|
| {
"id": "api.report.read",
"ver": "v1",
"ts": "timestamp",
"params": {
"resmsgid": null,
"msgid": "string",
"err": "string",
"status": "SERVER_ERROR",
"errmsg": "string"
},
"responseCode": "SERVER_ERROR",
"result": {}
} |
Invalid Report Id - Status Code 404
| Code Block |
|---|
| {
"id": "api.report.read",
"ver": "1.0.0",
"params": {
"resmsgid": "string",
"msgid": null,
"status": "failed",
"err": null,
"errmsg": "no report found"
},
"responseCode": "string",
"result": {}
} |
|
...
Search Report API
This API is associated with Searching Reports on the Sunbird Platform.
...