Contents

BaseAuditResponse

Common response envelope fields shared by all change history response objects.

Declaration

object BaseAuditResponse

Properties

NameTypeDescription
paginationPagination

Pagination state for the response. See Pagination. Read-only.

errorErrorMessage

Error information populated when the request fails. See ErrorMessage. Null on success. Read-only.

Discussion

The BaseAuditResponse defines the common envelope structure for all change history API responses. Both AuditSummaryResponse and ChangeDetailsResponse extend this base with a result array containing the endpoint-specific payload.

Check error before processing result. When error is non-null, result may be empty or absent.

Example

{
  "pagination": {
    "offset": 0,
    "pageSize": 20,
    "totalCount": 1
  }
}

See Also