Get 3D views for asset

GET 
/api/inspect/v1/file/3d

Fetch the list of 3D views in an asset.

Request

Query Parameters

assetID stringrequired

Asset ID for which 3D views are to be fetched.

Responses

200

200 response

application/json

Schema

Schema

data

object[]

The list of 3D views.

Array [

url uri

URL to the 3D view

archived boolean

Whether the 3D view is archived

status int32

Possible values: [1, 2, 3, 4, 5]

Status of the 3D view. 1 = Not Processed, 2 = Being Processed, 3 = Processed, 4 = Failed To Process, 5 = Queued To Process

tds2ModelJSONURL uri

URL to the tds2 model JSON file of the 3D view

thumbnailURL uri

URL to the thumbnail of the 3D view

type string

Possible values: [tds2, scn, glb]

Type of the 3D view. tds2 is the in-house 3D format. scn is the 3D scan format. glb is the glTF binary format.

createdBy int64

ID of the user who created the 3D view

updatedAt int64

Timestamp when the 3D view was last updated in milliseconds

version int64

Version of the 3D view

id uuid

Unique identifier (ID) for the 3D view

miniMapZipURL uri

URL to the mini map zip file of the 3D view

source string

Possible values: [ifc, obj, lidar]

Source of the 3D view. ifc is the Industry Foundation Classes format. obj is the Wavefront OBJ format. lidar is the LiDAR format.

tds2ModelBinURL uri

URL to the tds2 model binary file of the 3D view

tdsModelURL uri

URL to the tds model of the 3D view

createdAt int64

Timestamp when the 3D view was created in milliseconds

name string

Name of the 3D view

orderNo int64

Order number of the 3D view

size int64

Size of the 3D view in bytes

updatedBy int64

ID of the user who last updated the 3D view

]

Example (from schema)

{
  "data": [
    {
      "url": "https://example.com/3dfiles/begonia.glb",
      "archived": false,
      "status": 3,
      "tds2ModelJSONURL": "https://example.com/3dfiles/begonia.tds2.json",
      "thumbnailURL": "https://example.com/3dfiles/begonia_thumbnail.jpg",
      "type": "glb",
      "createdBy": 1413,
      "updatedAt": 1652933097739,
      "version": 1,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "miniMapZipURL": "https://example.com/3dfiles/begonia_minimap.zip",
      "source": "ifc",
      "tds2ModelBinURL": "https://example.com/3dfiles/begonia.tds2",
      "tdsModelURL": "https://example.com/3dfiles/begonia.tds",
      "createdAt": 1652933097739,
      "name": "Begonia",
      "orderNo": 1,
      "size": 517859,
      "updatedBy": 1413
    }
  ]
}

400

400 response

application/json

Schema

Schema

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

Example (from schema)

{
  "error": "Forbidden",
  "errorDescription": "permission denied"
}

401

401 response

application/json

Schema

Schema

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

Example (from schema)

{
  "error": "Forbidden",
  "errorDescription": "permission denied"
}

403

403 response

application/json

Schema

Schema

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

Example (from schema)

{
  "error": "Forbidden",
  "errorDescription": "permission denied"
}

404

404 response

application/json

Schema

Schema

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

Example (from schema)

{
  "error": "Forbidden",
  "errorDescription": "permission denied"
}

500

500 response

application/json

Schema

Schema

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

Example (from schema)

{
  "error": "Forbidden",
  "errorDescription": "permission denied"
}

Loading...