Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListEntitiesParams

Parameters for the listEntities operation.

Hierarchy

  • ListEntitiesParams

Index

Properties

Optional _export

_export: boolean

Whether to include all element content in the returned data. If export=false, the returned data includes only information about the element itself. If export=true, all content, including subelements, is included.

Optional cursor

cursor: string

A token identifying the page of results to retrieve.

Optional headers

headers: OutgoingHttpHeaders

Optional includeAudit

includeAudit: boolean

Whether to include the audit properties (created and updated timestamps) in the response.

Optional pageLimit

pageLimit: number

The number of records to return in each page of results.

Optional sort

sort: Sort | string

The attribute by which returned entities will be sorted. To reverse the sort order, prefix the value with a minus sign (-).

workspaceId

workspaceId: string

Unique identifier of the workspace.

Generated using TypeDoc