logo
logo

Entities client

The SDK provides an Entities client to perform CRUD operations on entities.

Note

The client variable in the following code examples refers to the ContentHubClient instance. When using the JavaScript SDK, the variable name can be chosen freely, but is also called client at instantiation in the docs. The entityId argument uses a 64-bit number as input.

Get entities

The following method gets an entity by id:

var entity: IEntity = await client.entities.getAsync(entityId);

When the entity does not exist or the user does not have permission to read it, the method returns null.

Note

There are many options to load entities by id, by identifier or by definition. For more information about the different options, please refer to the IEntitiesClient in the API reference documentation.

Note

It is possible to pass loading configurations when loading entities. For more information about loading configurations, please refer to the load configurations section.

Create entities

An entity can only be instantiated using the EntityFactory.

In the following snippet, an Asset entity is created (locally).

import { CultureLoadOption } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/culture-load-option";

var entity: IEntity = await client.entityFactory.createAsync("M.Asset", new CultureLoadOption(["en-US"]));

In the following snippet, the locally created Asset entity is sent to Content Hub to be validated and persisted.

var id: number = await client.entities.saveAsync(entity);

The returned id is the id of the newly created entity. To get the latest version of this entity, use the id to get it from Content Hub again.

Update entities

Similar to creating entities, use the 'save' method on the entities client after performing the modification.

var id: number = await client.entities.saveAsync(entity);

The returned id is the same id of the entity. To get the latest version of this entity, use the id to get it from the server again.

Delete entities

Entity deletion can be achieved by using the 'Delete' method of the entities client. The entity id needs to be specified for deletion.

await client.entities.deleteAsync(entityId);

Can we improve this article ? Provide feedback