Retrieve a 3D directory file

Required capabilities: threedAcl:READ

Retrieve the contents of a 3D file, for a blobId which is of a directory type. This applies to the output types ‘gltf-directory’, ‘reveal-directory’, ‘ept-pointcloud’, ‘tiles-directory’, ‘model-from-points’.

The ‘subPath’ elements, i.e. directory and/or file names, within each directory output type is subject to change and depends on each output type.

• The ‘gltf-directory’ output is used by Reveal v3+ for visualizing CAD files and contains a ‘scene.json’ file, which describes what other files are available within the blobId.
• The ‘reveal-directory’ output is used by Reveal v1-2 for visualizing CAD files and contains a ‘scene.json’ file, which describes what other files are available within the blobId.
• The ‘ept-pointcloud’ output is used by Reveal for visualizing point clouds, and contains a ‘ept.json’ file. The ‘ept.json’ file contains general information for the point cloud data. The file named ‘ept-hierarchy/0-0-0-0.json’ for the same blobId lists all the output point files which can be retrieved from a ‘ept-data’ folder for the same blobId, e.g. ‘ept-data/0-0-0-0.bin’. The ‘.bin’ files are in a custom point cloud format following the schema in the ‘ept.json’ file. Additionally, a ‘filterOptions.json’ file contains a description of which options were used when processing the point cloud.

Experimental outputs, normally not enabled: The ‘tiles-directory’ output contains files for classification of the point cloud data. Retrieve the ‘tiles.json’ file from this output for a overview of the files within this output. The ‘model-from-points’ output is used for storing a mesh based output file of some parts of the point cloud. This is stored as a ‘model.ciff’ file, in the Cognite internal file format.

This endpoint supports tag-based caching.

This endpoint is only compatible with 3D file IDs from the 3D API, and not compatible with file IDs from the Files API.