Get history entry

Returns metadata on an event in the system.

Function

React Native

getHistoryEntry(historyId: HistoryListItem["id"]): Promise<HistoryListItem>;

iOS

func getHistoryEntry(historyId: String) throws -> HistoryListItemBindingDto

Android

fun `getHistoryEntry`(`historyId`: String): HistoryListItemBindingDto

Parameters

• historyId - From the get history list function.

Return value

React Native

export interface HistoryListItem {
  id: string;
  createdDate: string;
  action: HistoryActionEnum;
  entityId?: string;
  entityType: HistoryEntityTypeEnum;
  organisationId: string;
  metadata?: HistoryMetadata | null;
}

iOS

public struct HistoryListItemBindingDto {
    public var createdDate: String
    public var id: String
    public var action: HistoryActionBindingEnum
    public var entityId: String?
    public var entityType: HistoryEntityTypeBindingEnum
    public var metadata: HistoryMetadataBinding?
    public var organisationId: String
}

Android

data class HistoryListItemBindingDto (
    var `createdDate`: String,
    var `id`: String,
    var `action`: HistoryActionBindingEnum,
    var `entityId`: String?,
    var `entityType`: HistoryEntityTypeBindingEnum,
    var `metadata`: HistoryMetadataBinding?,
    var `organisationId`: String
)