Update inspection media

put

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

Update the inspection media object. This endpoint is used to update the metadata of the media object.

Once a file is uploaded, the file cannot be updated. If the file needs to be updated, a new media object should be created.
The PATCH operation is preferred for updating metadata, only send the fields that have changed.

Required permissions:

(IsAuthenticated AND HasRolePermissions) OR APIKeyRequired

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

filename

string

required

length ≥ 1

created_by

integer

generate_thumbnail

boolean

Defaults to false

If set, will generate a thumbnail from the preview image and replace any existing thumbnail.

thumbnail

string

length ≥ 1

Data URL encoded thumbnail

preview

string

length ≥ 1

Data URL encoded preview

layer_id

integer

required

layer

object

required

alternate_media

object

required

cml_id

integer

required

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.

description

string | null

Description of the file (Optional)

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.

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

name

string

length ≤ 255

Inspection Media

local_id

string | null

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

source_media_timestamp

string | null

Timestamp in source video - must be used with source_media

state

string

enum

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

Allowed:

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

checklist

integer | null

Checklist source of the media.

source_media

integer | null

Checklist source_media points to the original image or video

project

integer | null

The media was uploaded with this project.

cml

integer | null

Monitoring locations for given media.

transfer_job

integer | null

TransferJob that created this media.

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