Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateValueParams

Parameters for the createValue operation.

Hierarchy

  • CreateValueParams

Index

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.

Optional metadata

metadata: JsonObject

Any metadata related to the entity value.

Optional patterns

patterns: string[]

An array of patterns for the entity value. A value can specify either synonyms or patterns (depending on the value type), but not both. A pattern is a regular expression; for more information about how to specify a pattern, see the documentation.

Optional synonyms

synonyms: string[]

An array of synonyms for the entity value. A value can specify either synonyms or patterns (depending on the value type), but not both. A synonym must conform to the following resrictions:

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

Optional type

type: Type | string

Specifies the type of entity value.

value

value: string

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

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

workspaceId

workspaceId: string

Unique identifier of the workspace.

Generated using TypeDoc