Get Asset

GET 
/api/v1/assets/:asset

Get an Asset by its ID.

Request

Path Parameters

asset integerrequired

Possible values: > 0

ID of the Asset

Responses

200

Success

application/json

Schema

Schema

id integerrequired
ID of the Asset
Possible values: > 0
Example: 1000
name stringrequired
Name of the Asset
Example: Asset 1
createdAt date-timerequired
Creation Date of the Asset
Example: 2025-03-12T18:12:44.465Z
updatedAt date-timerequired
Update Date of the Asset
Example: 2025-03-12T18:12:44.465Z
type stringrequired
Type of the Asset
Example: Vessel
description stringnullablerequired
Description of the Asset
Example: Description

workspace

object

required

id integerrequired

ID of the Workspace

Possible values: > 0

Example: 1000

name stringrequired

Name of the Workspace

Example: Workspace 1

Example (from schema)

{
  "id": 1000,
  "name": "Asset 1",
  "createdAt": "2025-03-12T18:12:44.465Z",
  "updatedAt": "2025-03-12T18:12:44.465Z",
  "type": "Vessel",
  "description": "Description",
  "workspace": {
    "id": 1000,
    "name": "Workspace 1"
  }
}

400

Validation Error

application/json

Schema

Schema

status stringrequired

Possible values: [Validation Error]

errors

object[]

required

Array [

error stringrequired

location stringrequired

Possible values: [body, query, path, headers]

]

Example (from schema)

{
  "status": "Validation Error",
  "errors": [
    {
      "error": "string",
      "location": "body"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

status stringrequired

Possible values: [Unauthorized]

Example (from schema)

{
  "status": "Unauthorized"
}

404

Asset not found

application/json

Schema

Schema

status stringrequired

Possible values: [Asset not found]

Example (from schema)

{
  "status": "Asset not found"
}

Loading...