Get Asset

GET

https://api.coperniq.io/v1/assets/:asset_id

GET

/v1/assets/:asset_id

1 const url = 'https://api.coperniq.io/v1/assets/asset_id';
2 const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

1 {
2   "id": 1,
3   "status": "DRAFT",
4   "siteId": 1,
5   "labels": [
6     {
7       "id": 1,
8       "name": "string",
9       "type": "ASSET",
10       "color": "string"
11     }
12   ],
13   "isArchived": true,
14   "uid": 1,
15   "name": "string",
16   "type": "BATTERY_SYSTEM",
17   "manufacturer": "string",
18   "model": "string",
19   "serialNumber": "string",
20   "accountId": 1,
21   "size": 1.1,
22   "installDate": "2023-01-15",
23   "manufacturingDate": "2023-01-15",
24   "expectedLifetime": 1.1,
25   "description": "string",
26   "coverImageFileId": 1,
27   "nameplateImageFileId": 1,
28   "createdAt": "2024-01-15T09:30:00Z",
29   "updatedAt": "2024-01-15T09:30:00Z"
30 }

Retrieve a specific asset by ID.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

asset_idstringRequired

Response

Asset details

idinteger

Asset identifier.

statusenum

Asset lifecycle status.

siteIdinteger

labelslist of objects

Labels attached to the asset, ordered by position.

isArchivedboolean

uidinteger or nullOptional

Short human-readable identifier for the asset (nullable for older records).

namestring or nullOptional

typeenum or nullOptional

Asset type enum.

manufacturerstring or nullOptional

modelstring or nullOptional

serialNumberstring or nullOptional

accountIdinteger or nullOptional

ID of the account (project with type ACCOUNT) the asset belongs to.

sizedouble or nullOptional

installDatestring or nullOptionalformat: "date"

manufacturingDatestring or nullOptionalformat: "date"

expectedLifetimedouble or nullOptional

Expected lifetime in years

descriptionstring or nullOptional

coverImageFileIdinteger or nullOptional

nameplateImageFileIdinteger or nullOptional

createdAtstringOptionalformat: "date-time"

updatedAtstringOptionalformat: "date-time"

Errors

401

Unauthorized Error

404

Not Found Error