Get History by ID

Retrieves a history record by its ID.

GET /history/{historyId}

Error

A valid request URL is required to generate request examples

200

{
  "action": "<string>",
  "appKey": "<string>",
  "correlationId": "<string>",
  "entityId": "<string>",
  "entityType": "<string>",
  "id": "<string>",
  "initiatingAppId": "<string>",
  "ipAddress": "<string>",
  "objectName": "<string>",
  "siteId": 123,
  "tenantId": 123,
  "timestamp": "2023-11-07T05:31:56Z",
  "userId": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

historyId · string · required

The ID of the history record.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

action · string | null

appKey · string | null

correlationId · string | null

entityId · string | null

entityType · string | null

id · string | null

initiatingAppId · string | null

ipAddress · string | null

objectName · string | null

siteId · integer<int32> | null

tenantId · integer<int32> | null

timestamp · string<date-time>

userId · string | null