Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateSynonymParams

Parameters for the createSynonym operation.

Hierarchy

  • CreateSynonymParams

Index

Properties

Properties

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.

synonym

synonym: string

The text of the synonym. This string must conform to the following restrictions:

  • It cannot contain carriage return, newline, or tab characters.
  • It cannot consist of only whitespace characters.

value

value: string

The text of the entity value.

workspaceId

workspaceId: string

Unique identifier of the workspace.

Generated using TypeDoc