Get Report Metadata by ID
GET/report-service/api/v1/report/:reportId
Get the metadata for the given report id
This endpoint is available on the Prisma Cloud Darwin release only.
Request
Path Parameters
Id of the report for which the metadata to retrieved.
Responses
- 200
- 401
- 403
- 404
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
Id of the report.
Status of the report.
Type of the report.
Client identifier.
Payload used for creating the report.
Path variables used for creating the report.
Query params used for creating the report.
Request headers used for creating the report.
Any additional attributes used for creating the report.
Timestamp when report request is created.
Url to download the report once report is generated.
{
"reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"reportType": "string",
"clientType": "string",
"payload": {},
"pathVariables": {},
"queryParams": {},
"requestHeaders": {},
"additionalInformation": {},
"createdOn": 0,
"downloadUrl": "string"
}
Unauthorized - user cannot be authenticated to service the request
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [ERROR
, INFO
, WARNING
]
{
"i18nKey": "string",
"severity": "ERROR",
"subject": "string",
"statusCode": 0
}
Forbidden - user does not have the required role
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [ERROR
, INFO
, WARNING
]
{
"i18nKey": "string",
"severity": "ERROR",
"subject": "string",
"statusCode": 0
}
Not Found - report not found
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [ERROR
, INFO
, WARNING
]
{
"i18nKey": "string",
"severity": "ERROR",
"subject": "string",
"statusCode": 0
}