getAuditTrailReport
DocumentBuilderTaskWrapper getAuditTrailReport()
GET /api/2.0/security/audit/events/report
Get audit trail report status
Returns the state of the audit trail report the calling user has started, and is the operation to poll after POST api/2.0/security/audit/events/report. The caller needs the portal-settings right of a DocSpace administrator plus the audit option of the portal's pricing plan, otherwise the call is answered with 402. Jobs are kept per user and per report kind: this operation never shows another administrator's report, nor the login history report, which has its own status at GET api/2.0/security/audit/login/report. The answer is empty when no report of this kind is known for the caller; otherwise percentage grows towards 100, isCompleted turns true when the build has ended, error carries the failure message when it ended badly, and resultFileId, resultFileName and resultFileUrl point at the file saved to the caller's My documents section. The operation is read-only and safe to poll every few seconds; a finished job is dropped as soon as the next report of this kind is started.
Parameters
This endpoint does not need any parameter.
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The state of the caller's audit trail report, or an empty answer when none is known | DocumentBuilderTaskWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 402 | The portal's pricing plan has no audit option, or the login history and audit trail section is not enabled | - | - |
| 403 | The caller does not have the portal-settings right of a DocSpace administrator | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: Not defined
- Accept: application/json