Interface UpdateValueParams

Whether the new data is to be appended to the existing data in the entity value. If append=false, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data for the entity value includes synonyms and append=false, all existing synonyms for the entity value are discarded and replaced with the new synonyms.

The name of the entity.

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

Any metadata related to the entity value.

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.

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.

Specifies the type of entity value.

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.

The text of the entity value.

Unique identifier of the workspace.