Create an asset

POST

assets

Create an asset

curl --request POST \
  --url https://api.oncanary.com/v1/assets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "North compressor",
  "asset_type": "equipment"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'North compressor', asset_type: 'equipment'})
};

fetch('https://api.oncanary.com/v1/assets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.oncanary.com/v1/assets"

payload = {
    "name": "North compressor",
    "asset_type": "equipment"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "asset_type": "<string>",
    "asset_types": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "status": "online",
    "criticality": "critical",
    "serial_number": "<string>",
    "manufacturer": "<string>",
    "model": "<string>",
    "year": 123,
    "location_id": "<string>",
    "parent_asset_id": "<string>",
    "sub_asset_count": 1,
    "deleted_at": "2023-11-07T05:31:56Z",
    "image_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "code": "<string>",
    "extraFields": {}
  },
  "meta": {
    "request_id": "<string>",
    "api_version": "<string>"
  }
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

Authorizations

Authorization

string

header

required

Organization API key with an sk_live_ or sk_test_ prefix

Body

application/json

name

string

required

Maximum string length: 255

asset_type

enum<string>

required

Available options:

equipment,

vehicle,

facility

code

string

Editable customer-facing ID, unique across assets, parts and location scan payloads within the organization. Generated when omitted at creation. Changing it invalidates labels using the previous ID; internal record IDs and linked work stay unchanged.

Required string length: 1 - 255

status

enum<string>

default:online

Available options:

online,

offline,

not_monitored

downtime_type

enum<string>

Required when creating an offline asset. Valid only with offline status.

Available options:

planned,

unplanned

criticality

enum<string>

default:normal

Available options:

critical,

important,

normal

description

string

Maximum string length: 1000

image_url

string

Maximum string length: 2000

image_blur

string

location_id

string

serial_number

string

Maximum string length: 255

manufacturer

string

Maximum string length: 255

model

string

Maximum string length: 255

year

integer

Manufacturing year, through the next calendar year

Required range: 1900 <= x <= 2027

extraFields

object

Label-keyed custom-field values. Omitted labels remain unchanged on update.

Show child attributes

Response

Asset created

data

object

required

Show child attributes

meta

object

required

Show child attributes

Create an asset

curl --request POST \
  --url https://api.oncanary.com/v1/assets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "North compressor",
  "asset_type": "equipment"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'North compressor', asset_type: 'equipment'})
};

fetch('https://api.oncanary.com/v1/assets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.oncanary.com/v1/assets"

payload = {
    "name": "North compressor",
    "asset_type": "equipment"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "asset_type": "<string>",
    "asset_types": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "status": "online",
    "criticality": "critical",
    "serial_number": "<string>",
    "manufacturer": "<string>",
    "model": "<string>",
    "year": 123,
    "location_id": "<string>",
    "parent_asset_id": "<string>",
    "sub_asset_count": 1,
    "deleted_at": "2023-11-07T05:31:56Z",
    "image_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "code": "<string>",
    "extraFields": {}
  },
  "meta": {
    "request_id": "<string>",
    "api_version": "<string>"
  }
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

API essentials

Work management

Equipment

Inventory

Organization data

Authorizations

Body

Response