Sign in

v1

latestOpenAPI 3.1.02026-07-26365.9 KB
Objects

Download an Object and All its Children

Download an object and all of its children recursively. The response format depends on the Accept header.

get/objects/{projectId}/{objectId}

Path parameters

projectIdstring required

The ID of the project

objectIdstring required

A unique identifier for a Speckle object

Example:9b2cdb21da092dbd3558a4bc55b2cf7e

The ID of the root object to download

Headers

Accept'application/json' | 'text/plain'

Response format: 'application/json' returns a JSON array, 'text/plain' returns tab-separated values (object_id\tobject_content)

Response

The requested object and its children. Format depends on Accept header.

idstring
speckle_typestring
totalChildrenCountinteger
numbersnumber[]

Example response

[
  {
    "id": "9b2cdb21da092dbd3558a4bc55b2cf7e",
    "speckle_type": "Base",
    "totalChildrenCount": 0,
    "numbers": [
      0.04667752874618203,
      0.16370857295385177,
      0.1008153029515465
    ]
  }
]