UpdateEntityParams | ibm-watson

Parameters for the updateEntity operation.

Hierarchy

UpdateEntityParams

Index

Properties

Optional append

append: boolean

Whether the new data is to be appended to the existing data in the entity. 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 includes values and append=false, all existing values for the entity are discarded and replaced with the new values.

If append=true, existing elements are preserved, and the new elements are added. If any elements in the new data collide with existing elements, the update request fails.

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 newDescription

newDescription: string

The description of the entity. This string cannot contain carriage return, newline, or tab characters.

Optional newEntity

newEntity: string

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

It can contain only Unicode alphanumeric, underscore, and hyphen characters.
It cannot begin with the reserved prefix sys-.

Optional newFuzzyMatch

newFuzzyMatch: boolean

Whether to use fuzzy matching for the entity.

Optional newMetadata

newMetadata: JsonObject

Any metadata related to the entity.

Optional newValues

newValues: CreateValue[]

An array of objects describing the entity values.

workspaceId

workspaceId: string

Unique identifier of the workspace.