View all objects

Learn about the GetAllObjects endpoint in the DestinationObject collection.

This API lets you retrieve information about all previously-created objects in an environment. You can also filter the results using pagination parameters.

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

API request

Parameters

Parameter	Description
Destination_Entity_Environment_Id	Unique identifier of the 3D environment to which the object belongs.
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": "object_01_light_switch",
                "description": "An electric switch to turn lights on and off",
                "identifier": "object_id_01_light_switch",
                "destination_Entity_Environment_Id": 30596,
                "creationTime": "2024-11-21T10:55:15.391Z"
            },
            {
                "id": 56789,
                "name": "object_02_east_wall",
                "description": "the east wall",
                "identifier": "object_id_02_east_wall"
                "destination_Entity_Environment_Id": 30596,
                "creationTime": "2024-11-19T07:50:15.391Z"
            }
        ]
    },
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}

Attributes

Attribute	Description
id	Unique identifier of the object.
name	Name of the object.
description	An explanation of what the object is.
identifier	A unique identifying label for the object, for reference.
destination_Entity_Environment_Id	Unique identifier of the 3D environment to which the object belongs.
creationTime	Exact date and time when the object was created.