SAsalesforce
auditEvents

Get auditEvent

Retrieve the specified auditEvent by its id. You may also optionally specify a list of fields to include in the response.

get/auditEvents/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/auditEvents/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The id of the auditEvent to retrieve.

Query parameters

fieldsstring[]

Comma-delimited list of field names to include in the response.

Response

Success, returns the specified auditEvent.

detailsobject

A JSON object with additional event details.

idstring

The auditEvent id.

loggedAtstring

The timestamp when the event was logged.

isErrorboolean

True if this audit event represents an error.

resourceNamestring

The name of the resource associated with this event.

resourceTypestring

The type of the resource associated with this event, e.g. "Collector", "Subject", etc.

createdBystring

Id of the User/Collector who created this auditEvent.

createdAtstring

Timestamp when the record was saved to Refocus. Due to latency and queuing, this value is expected to be greater than the loggedAt timestamp.

Changes

No recorded changes to this operation across all 70 revisions of this API.