Interface RestObjectGetParams

Request parameters for get.

Hierarchy

  • RestObjectGetParams

Properties

Properties

compact?: boolean

When true (default), returns a values-only representation. When false, includes object IDs and type metadata.

objectId?: string

The unique identifier of the object instance to fetch. If omitted, fetches from the channel object.

path?: string

A dot-separated path to return a subset of the object. Evaluated relative to the channel object or the specified objectId.

Generated using TypeDoc