getAuditTrailTypes
AuditTrailTypesWrapper getAuditTrailTypes()
GET /api/2.0/security/audit/types
Get audit trail types
Returns the vocabularies the audit filters are built from: actions lists every action the portal can record, actionTypes the kinds of change they stand for, productTypes the products they belong to, moduleTypes the locations inside those products, and entryTypes the kinds of entity an action can be applied to. The caller needs the portal-settings right of a DocSpace administrator; the audit option of the pricing plan is not required, so the lists can be read on any portal. The operation is read-only, takes no parameters and depends on nothing else. Every value is the name to send in the matching query parameter of GET api/2.0/security/audit/events/filter or GET api/2.0/security/audit/login/filter, so read this operation once and reuse the answer instead of guessing spellings. The response is an untyped object holding those five arrays of names, and it changes only with the portal version. Use GET api/2.0/security/audit/mappers when the relations between products, modules and actions are needed rather than the flat lists.
Parameters
This endpoint does not need any parameter.
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The action, action type, product, module and entry type names accepted by the audit filters | AuditTrailTypesWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 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