Get 2D views for asset

GET 
/api/inspect/v1/file/2d

Fetch the list of 2D views in an asset.

Request

Query Parameters

assetID stringrequired

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

Responses

200

200 response

application/json

Schema

Schema

data

object[]

The list of files.

Array [

assetID uuid

ID of the asset to which the file belongs

category int32

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

Category of the file. 0 = Drawing, 1 = Document, 2 = Photo, 3 = Map, 4 = Model, 5 = Report, 6 = 2D

createdBy int64

ID of the user who created the file

url uri

URL to the file

rasterizedURL uri

URL to the rasterized file

size int64

Size of the file in bytes

updatedBy int64

ID of the user who last updated the file

createdAt int64

Timestamp when the file was created in milliseconds

id uuid

Unique identifier (ID) for the file

thumbnailURL uri

URL to the thumbnail of the file

attributes

object

Attributes of the file

photo boolean

photo360 boolean

rotation double

sketch boolean

source string

Possible values: [Crack = "crack", Sensor = "sensor", System = "system", ScanOverlay = "scan_overlay"]

name string

Name of the file

orderNo int64

Order number of the file

updatedAt int64

Timestamp when the file was last updated in milliseconds

]

Example (from schema)

{
  "data": [
    {
      "assetID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "category": 0,
      "createdBy": 1413,
      "url": "https://example.com/file",
      "rasterizedURL": "https://example.com/rasterized",
      "size": 517859,
      "updatedBy": 1413,
      "createdAt": 1652933097739,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "thumbnailURL": "https://example.com/thumbnail",
      "attributes": {
        "photo360": false,
        "rotation": 90,
        "sketch": true,
        "source": "crack",
        "photo": false
      },
      "name": "Begonia",
      "orderNo": 1,
      "updatedAt": 1652933097739
    }
  ]
}

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...