Get assets for company

GET 
/api/inspect/v1/asset

Fetch the list of assets for the given company that the user has access to.

Request

Query Parameters

companyID stringrequired

Company ID for which assets are to be fetched.

Responses

200

200 response

application/json

Schema

Schema

data

object[]

The list of assets.

Array [

createdBy int64

ID of the user who created the asset

geolocation

object

Geolocation of the asset

type string

The type of geometry used, typically indicating the format of the map coordinates.

geometry

object

The geometry of the entity on the Map.

type string

The type of geometry used, typically indicating the format of the map coordinates.

coordinates double[]

Possible values: >= 2, <= 2

The latitude and longitude coordinates of the entity on the Map.

properties

object

The properties of the entity on the Map.

address string

The address of the entity on the Map.

name string

The name of the entity on the Map.

name string

Name of the asset

archived boolean

Whether the asset is archived

demo boolean

Whether the asset is a demo asset

rating double

Rating of the asset

thumbnailURL uri

URL to the thumbnail of the asset

type int32

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

Type of the asset. 1 = Bridge, 2 = Building, 3 = Road, 4 = Tunnel, 5 = Others

updatedBy int64

ID of the user who last updated the asset

companyID uuid

ID of the company to which the asset belongs

favorite boolean

Whether the asset is a favorite asset

updatedAt int64

Timestamp when the asset was last updated in milliseconds

createdAt int64

Timestamp when the asset was created in milliseconds

id uuid

Unique identifier (ID) for the asset

]

Example (from schema)

{
  "data": [
    {
      "createdBy": 1413,
      "geolocation": {
        "geometry": {
          "coordinates": [
            1.29941,
            103.787567
          ],
          "type": "Point"
        },
        "properties": {
          "address": "1 Fusionopolis Way, Connexis South Tower, Singapore 138632",
          "name": "Screening Eagle Singapore"
        },
        "type": "Feature"
      },
      "name": "Begonia",
      "archived": false,
      "demo": false,
      "rating": 4.5,
      "thumbnailURL": "https://example.com/thumbnail.jpg",
      "type": 1,
      "updatedBy": 1413,
      "companyID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "favorite": false,
      "updatedAt": 1652933097739,
      "createdAt": 1652933097739,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

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