API reference (20230101-alpha)
const revisions3D = await client.revisions3D.retrieve(8252999965991682, 4190022127342195){
"id": 1000,
"fileId": 1000,
"published": false,
"status": "Done",
"assetMappingCount": 0,
"createdTime": 0,
"rotation": [
0,
0,
0
],
"scale": [
1,
1,
1
],
"translation": [
0,
0,
0
],
"camera": {
"target": [
123
],
"position": [
123
]
},
"metadata": {},
"thumbnailThreedFileId": 1000,
"thumbnailURL": "https://api.cognitedata.com/api/v1/project/myproject/3d/files/1000"
}Retrieve a 3D revision
Required capabilities:
threedAcl:READ
const revisions3D = await client.revisions3D.retrieve(8252999965991682, 4190022127342195){
"id": 1000,
"fileId": 1000,
"published": false,
"status": "Done",
"assetMappingCount": 0,
"createdTime": 0,
"rotation": [
0,
0,
0
],
"scale": [
1,
1,
1
],
"translation": [
0,
0,
0
],
"camera": {
"target": [
123
],
"position": [
123
]
},
"metadata": {},
"thumbnailThreedFileId": 1000,
"thumbnailURL": "https://api.cognitedata.com/api/v1/project/myproject/3d/files/1000"
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Response
A revision object
The ID of the revision.
1000
The file id.
1000
True if the revision is marked as published.
The status of the revision.
Queued, Processing, Done, Failed "Done"
The number of asset mappings for this revision.
0
The creation time of the resource, in milliseconds since January 1, 1970 at 00:00 UTC.
0
3 elementsGlobal rotation to be applied to the entire model. The rotation is expressed by Euler angles in radians and in XYZ order.
[0, 0, 0]3 elementsGlobal scale to be applied to the entire model. The scale is expressed by units in XYZ order.
[1, 1, 1]3 elementsGlobal translation to be applied to the entire model, to offset the position. The translation is expressed by units in XYZ order.
[0, 0, 0]Initial camera position and target.
Show child attributes
Show child attributes
Custom, application specific metadata. String key -> String value. Limits: Maximum length of key is 32 bytes, value 512 bytes, up to 16 key-value pairs.
Show child attributes
Show child attributes
The threed file ID of a thumbnail for the revision. Use /3d/files/{id} to retrieve the file.
1000
The URL of a thumbnail for the revision.
"https://api.cognitedata.com/api/v1/project/myproject/3d/files/1000"
Was this page helpful?