Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListSynonymsParams

Parameters for the listSynonyms operation.

Hierarchy

  • ListSynonymsParams

Index

Properties

Optional cursor

cursor: string

A token identifying the page of results to retrieve.

entity

entity: string

The name of the entity.

Optional headers

headers: OutgoingHttpHeaders

Optional includeAudit

includeAudit: boolean

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

Optional includeCount

includeCount: boolean

Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is true, the pagination object in the response includes the total property.

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 entity value synonyms will be sorted. To reverse the sort order, prefix the value with a minus sign (-).

value

value: string

The text of the entity value.

workspaceId

workspaceId: string

Unique identifier of the workspace.

Generated using TypeDoc