Get Asset | Coperniq API

const url = 'https://api.coperniq.io/v1/assets/assetId';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 1,
  "status": "DRAFT",
  "siteId": 1,
  "labels": [
    {
      "id": 1,
      "name": "string",
      "type": "ASSET",
      "color": "string"
    }
  ],
  "isArchived": true,
  "uid": 1,
  "name": "string",
  "type": "BATTERY_SYSTEM",
  "manufacturer": "string",
  "model": "string",
  "serialNumber": "string",
  "accountId": 1,
  "size": 1.1,
  "installDate": "2023-01-15",
  "manufacturingDate": "2023-01-15",
  "expectedLifetime": 1.1,
  "description": "string",
  "coverImageFileId": 1,
  "nameplateImageFileId": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z"
}

Retrieve a specific asset by ID.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

assetIdstringRequired

Response

Asset details

idinteger

Asset identifier.

statusenum

Asset lifecycle status.

Allowed values:

siteIdinteger

labelslist of objects

Labels attached to the asset, ordered by position.

isArchivedboolean

uidinteger or null

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

namestring or null

typeenum or null

Asset type enum.

manufacturerstring or null

modelstring or null

serialNumberstring or null

accountIdinteger or null

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

sizedouble or null

installDatestring or nullformat: "date"

manufacturingDatestring or nullformat: "date"

expectedLifetimedouble or null

Expected lifetime in years

descriptionstring or null

coverImageFileIdinteger or null

nameplateImageFileIdinteger or null

createdAtstringformat: "date-time"

updatedAtstringformat: "date-time"

Errors

401

Unauthorized Error

404

Not Found Error