View all entities in a project

Learn about the GetAllEntities endpoint in the DestinationEntity collection.

This API enables you to retrieve information about all entities previously created in your project. You can also filter the results using the pagination parameters.

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

API request

Parameters

Parameter	Description
Destination_Entity_Types_Id	Unique identifier that represents the entity type. This parameter can have the following values: ID Name Description 1 NPC Represents VH entities 2 3DEnvironment Represents environment entities
SkipCount	A pagination parameter that helps you define the number of results to skip (i.e. where to start counting) when returning results.
MaxResultCount	A pagination parameter that helps you limit the number of results returned. It specifies the number of retrieved results.

API response

Sample

{
    "result": {
        "totalCount": 2,
        "items": [
            {
                "id": 12345,
                "name": "NPC_01",
                "description": "Virtual human NPC_01",
                "identifier": "NPC_id_01"
            },
            {
                "id": 56789,
                "name": "NPC_02",
                "description": "Virtual human NPC_02",
                "identifier": "NPC_id_02"
            }
        ]
    },
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}

Attributes

Attribute	Description
id	Unique identifier of the entity.
name	Name of the entity.
description	Explanation of what the entity is.
identifier	A unique identifying label for the entity, for reference.