Get all defects

get https://<subdomain>.huvrdata.app/api/defects/

Returns an array of defects. The data returned is limited to the current user's permissions.
The DefectListSerializer is used to limit the data returned to only the necessary fields.

Required permissions:

IsAuthenticated
WorkspaceRequired

Query Params

ordering

string

Which field to use when ordering the results.

client_id

string

client_id

state

string

state

asset

string

asset

severity

string

severity

type

string

type

project

string

project

cml

string

cml

profile

string

profile

layer

string

layer

priority

string

priority

repair_by

string

repair_by

next_inspection_date

string

next_inspection_date

string

id__in

string

id__in

severity__in

string

severity__in

severity_display

string

severity_display

type_display

string

type_display

sub_type_display

string

sub_type_display

component

string

component

component_display

string

component_display

location_code

string

location_code

location_code_display

string

location_code_display

location_zone

string

location_zone

location_zone_display

string

location_zone_display

asset_type__in

string

asset_type__in

asset__in

string

asset__in

project_type__in

string

project_type__in

layer__in

string

layer__in

profile__in

string

profile__in

string

asset__asset_path_cache__path

string

assetasset_path_cachepath

descendants

string

descendants

created_on

string

created_on

project_selected_findings

string

project_selected_findings

related_to

string

related_to

latest

string

latest

resolved_on

string

resolved_on

project__name

string

project__name

geometry_exists

string

geometry_exists

created_by

string

created_by

labels

string

labels

state_note

string

state_note

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

Response

Response body

object

count

integer

required

uri | null

results

array of objects

required

results*

object

integer

asset

object

required

overlays

array of objects

required

overlays*

object

integer

defect

integer

required

media

object

required

geometry

array of numbers

Polygon in pixel space for the location of the defect overlay.

Geo Point

geometry_extra

string | null

Additional data about the geometry. Used for conversions not displayed.

note

string | null

Comment about the overlay/annotation.

created_by

object

required

created_on

date-time

updated_on

date-time

display_url

uri

length between 1 and 255

project_name

string | null

required

created_by

object

required

state_note

string

length ≥ 1

created_on

date-time

updated_on

date-time

labels

object

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

Has additional fields

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

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

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

PENDING OPEN MONITOR REPAIR REPAIRED CLOSED

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.

profile

integer

required

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.

newer_defect

integer | null

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

Language

Credentials

Header

Request


xxxxxxxxxx
1
GET %3Csubdomain%3E.huvrdata.app/api/defects/ HTTP/1.1
2
Accept: application/json
3
Authorization: Token <short-lived-access-token>
4
Host: 
5
6

Choose an example:

application/json

application/yaml

200