Create an entity

Learn about the CreateEntities endpoint in the DestinationEntity collection.

Affective Computing (powered by Virtue) supports two types of entities; 3D environments and VHs.

This API enables you to create a new entity of either type.

API request

Parameters

Parameter
Description

destination_Entity_Types_Id

Unique identifier that represents the entity type.

This parameter can have the following values:

tenantId

Unique identifier of the tenant responsible for the project.

project_Domain_Id

Unique identifier of the project's domain.

Note: Whether or not you need to enter the project domain ID depends on your user account;

  • If you are working with a private solution, you might need to enter the project ID instead of the project domain ID.

  • On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID.

This parameter can have the following values:

project_Function_Id

Unique identifier of the project's function based on the project's domain.

Note: Whether or not you need to enter the project function ID depends on your user account;

  • If you are working with a private solution, you might need to enter the project ID instead of the project domain ID.

  • On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID.

This parameter can have the following values:

  • For No domain (when project_Domain_Id is -1)

  • For Security & Safety (when project_Domain_Id is 2)

  • For Human wellbeing (when project_Domain_Id is 3)

  • For Digital user experience (project_Domain_Id is 4)

entityList

An array that contains the following details of the entity:

Last updated

Was this helpful?