Share via


EntityGet interface

Methods

delete(RequestParameters)

Delete an entity identified by its GUID.

get(EntityGetParameters)

Get complete definition of an entity given its GUID.

put(EntityPartialUpdateAttributeByGuidParameters)

Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible.

Method Details

delete(RequestParameters)

Delete an entity identified by its GUID.

function delete(options?: RequestParameters): StreamableMethod<EntityDelete200Response | EntityDeleteDefaultResponse>

Parameters

Returns

get(EntityGetParameters)

Get complete definition of an entity given its GUID.

function get(options?: EntityGetParameters): StreamableMethod<EntityGet200Response | EntityGetDefaultResponse>

Parameters

Returns

put(EntityPartialUpdateAttributeByGuidParameters)

Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible.

function put(options: EntityPartialUpdateAttributeByGuidParameters): StreamableMethod<EntityPartialUpdateAttributeByGuid200Response | EntityPartialUpdateAttributeByGuidDefaultResponse>

Parameters

Returns