Create Asset | Coperniq API

const url = 'https://api.coperniq.io/v1/assets';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"accountId":1,"siteId":1,"type":"BATTERY_SYSTEM","manufacturer":"string","model":"string","serialNumber":"string"}'
};
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"
}

Create a new asset. Requires accountId, siteId, type, manufacturer, model, and serialNumber.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

accountIdintegerRequired

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

siteIdintegerRequired

typeenumRequired

Asset type enum.

manufacturerstringRequired

modelstringRequired

serialNumberstringRequired

statusenumOptional

Asset lifecycle status.

sizedoubleOptional

labelIdslist of integersOptional

Label IDs to attach to the asset.

installDatestringOptionalformat: "date"

manufacturingDatestringOptionalformat: "date"

expectedLifetimedoubleOptional

Expected lifetime in years

descriptionstringOptional

coverImageFileIdintegerOptional

nameplateImageFileIdintegerOptional

Response

Asset created successfully

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

400

Bad Request Error

401

Unauthorized Error