create cmls

post

https://<subdomain>.huvrdata.app/api/cmls/

create CML

Required permissions:

IsAuthenticated
WorkspaceRequired
HasRolePermissions::asset_create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

is_active

boolean

Is entity active

deactivated_on

date-time | null

external_id

string | null

app_key

string | null

Application identifier this entity is related to/sourced from.

labels

object

List of Key/Value pairs where keys are 'name' and 'value'

geo_point

array of numbers

Latitude/Longitude for physical location. Z is altitude Meters above sea level (ASL) (Optional).

Geo Point

heading

number | null

Direction the measurement device is pointing from North (Degrees).

pitch

number | null

Angle relative to horizon. + is above, - is below. (Degrees).

local_coordinates

array of numbers

X/Y/Z right hand coordinates system. Origin is assumed to be defined by location_code (Optional).

Geo Point

component

string | null

Component or subsytem on the asset. For example: Blade A on wind turbine.

component_display

string | null

Component or subsytem on the asset. (Field is auto set by system)

location_zone

string | null

Asset relative location zone. For example, solar assets are represented as Block-Row-Section-Pier-Modules: 21-9-4-E-2

location_zone_display

string | null

Asset relative location zone. Field is set by the system.

location_code

string | null

Asset relative location code. For example, solar assets are represented as Block-Row-Section-Pier-Modules: 21-9-4-E-2

location_code_display

string | null

Human readable version of the location code. Field set by the system based on location_code.

access

string | null

Any special requirement (Man Lift, Ladder, or Scaffold) for how a location must be accessed

access_display

string | null

Human readable version of the access code. Field set by the system based on access_code.

name

string

length ≤ 255

description

string | null

Extra description of CML (optional)

type

string

enum

CMLs support pipe, tanks and other.

Allowed:

installed_on

date-time | null

CML installation/service date.

inspection_order

integer | null

-2147483648 to 2147483647

Used to sequence the data collection. Smaller numbers come first. (Optional)

layer

integer | null

Location Layer definition.

asset

integer

required

Monitoring locations for a given asset.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

201