partial_update defects

patch

https://<subdomain>.huvrdata.app/api/defects/{id}/

Defect / Finding API endpoint

Required permissions:

(IsAuthenticated AND HasRolePermissions) OR APIKeyRequired

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

integer

labels_update

object

asset_id

integer

Asset (id) to link this Finding to (required)

profile_id

integer

cml_id

integer

modified_by

integer | null

created_on

date-time

state_note

string

length ≥ 1

Note included with the Finding state change (optional)

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.

client_id

string | null

URL safe unique identifier for the checklist provided by the client during creation (optional).

external_id

string | null

External ID for importing data from other systems (Optional).

description

string | null

recommendation

string | null

Recommended action for this finding (optional).

severity

integer

-32768 to 32767

Defect severity. Bigger is worse.

severity_display

string | null

Defect severity. Bigger is worse. (Display value)

type

string | null

The type of damage: Crack, chip, erosion.

type_display

string | null

The type of damage: Crack, chip, erosion. (System generated)

sub_type

string | null

Additional classification of the damage (Optional).

sub_type_display

string | null

Additional classification of the damage (Display).

length

integer | null

0 to 2147483647

Estimated length of damage in millimeters. (Optional).

width

integer | null

0 to 2147483647

Estimated width of damage in millimeters. (Optional).

area

integer | null

0 to 2147483647

Estimated surface area damage in square millimeters. (Optional).

is_locked

boolean

Source project has been published, Finding details cannot not be altered

state

string

enum

Defect states: PENDING, MONITOR, REPAIR, REPAIRED, CLOSED

Allowed:

checklist_line

string | null

Section/line key that sourced the defect. System generated.

captured_on

date-time | null

Date the inspection was completed, not when item was added to database.

priority

string

length ≤ 50

Finding priority, human readable. e.g. A1, HIGH.

repair_by

date | null

Date to repair finding before (optional).

resolved_on

date-time | null

Date and time the finding was resolved (optional).

resolution_duration

string | null

Duration to repair/close the finding (System Provided).

next_inspection_date

date | null

Next inspection date (optional)

layer

integer | null

Location Layer definition.

checklist

integer | null

Checklist source of the defect.

project

integer | null

Defect sourced from this project.

cml

integer | null

Monitoring locations for given finding/defect.

created_by

integer | null

User that created the defect. Set by the system.

newer_defect

integer | null

Linked defect. The link goes to a newer update of the defect.

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