Inspection Media Overlays

patch

https://<subdomain>.huvrdata.app/api/inspection-media/{id}/overlays/

Add or edit a overlay on a media object. Overlays are used to attach Defects (Findings) to media objects.

Required permissions:

(IsAuthenticated AND HasRolePermissions) OR APIKeyRequired

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

name

string

length ≤ 255

Inspection Media

description

string | null

Description of the file (Optional)

state

string

enum

Media state: CREATED, UPLOADED, PROCESSING, PROCESSED, INSPECTED

Allowed:

file_meta

object

Meta data extracted from the file.

media_type

string

length ≤ 255

Media (MIME) Type as defined by the IANA. For example: image/jpeg

document_category

string

length ≤ 50

Document category, For example: image, video, audio etc.

size

integer

-9223372036854776000 to 9223372036854776000

File size in bytes

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

layer

object

required

layer_id

integer

required

component

string | null

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

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_code

string | null

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

access

string | null

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

local_id

string | null

Local/alternate ID generated by client or used when importing from other applications (Optional).

overlays

array of objects

required

overlays*

project

object

required

cml

object

source_media

object

required

source_media_timestamp

string | null

Timestamp in source video - must be used with source_media

captured_on

date-time | null

Date the media as taken; extracted from file's metadata where available.

priority

integer

-32768 to 32767

Used for hiding items if value is smaller than 0

attached_to

object

List of checklist line items are attached.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

application/yaml

200