Toggle menu

unhideEvent()

This feature is available from iCM 10.1.0.102

Description

This function restores a hidden event to its previous position, based upon its timestamp (the numbered position may not be the same if other events in the sequence have been shown/hidden). It works with active and sealed histories.

Unhiding an event also writes a hidden "metadata event" which includes the ID of the event, the type of action (ie "unhide") and the optional reason. Metadata events are returned when history queries are made in audit mode.

For an overview, see Hiding and Replacing Events.

Parameters

FieldTypeRequiredNotes
eventidpositive integerYesThe event id to unhide - from log/replaceEvent's response, or a gethistory event's eventId
idstring (UUID)One of id / labelsThe ID of the history the event belongs to. Mutually exclusive with labela-labele
labela ... labelesimple value"The labels to identify the history
reasonstringNoFree text, stored in the metadata event. Omit entirely for no reason field at all.

Returns

If the operation was successful then the "result" structure will contain the following.

PropertyDescription
historyidThe unique ID of the history
eventidThe ID of the event
eventposThe position of the event in the history
metadataeventidThe ID of the corresponding metadata event

Example

{
  "method": "unhideevent",
  "params": {
    "labela": "HideEventTest",
    "labelb": "1234-1234-1234-1234",
    "eventid": 1042,
    "reason": "restored in error"
  }
}

"result": {
    "historyid": "3f1c9a2e-...-9a6a6a2b6d10",
    "eventid": 1042,
    "eventpos": 2,
    "metadataeventid": 1046
}

Last modified on 5 August 2026