List Audit Event Resource Types

Beta

GET/v1/core/audit-events/resource-types

This endpoint is idempotent. Learn more

Returns every resource type an audit event can refer to, as plain strings.

This is the accepted vocabulary for the resource_types filter when listing audit events. It is the API's complete resource-type list rather than a list derived from your account's data, so it includes types you may never have recorded events for.

Permissions requiredValues:audit_events:read

The role behind your API key or agent must grant every one of these permissions.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of stringenumValues:accountactorentity

Resources in this page.

Responses

200

Successful response for List Audit Event Resource Types

List Audit Event Resource Types

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listObjectType = await client.core.auditEvents.retrieveResourceTypes();

console.log(listObjectType.data);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listObjectType = await client.core.auditEvents.retrieveResourceTypes();

console.log(listObjectType.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": null,
    "previous_page_url": null,
    "has_next_page": false,
    "has_prev_page": false
  },
  "data": []
}

{
  "object": "list",
  "page_info": {
    "next_page_url": null,
    "previous_page_url": null,
    "has_next_page": false,
    "has_prev_page": false
  },
  "data": []
}

List Audit Event Resource Types

Authorization

Returns

Responses