Jump to

• Request
• Response

Get hazards.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/hazards

This operation retrieves hazards for a project.

Request

Path Parameters

• orgId: string
  Organization identifier
• projectId: string
  Project identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Hazards were successfully retrieved.

Body ()

Root Schema : Hazards

Type: object

Show Source

• items: array items
• links(optional): array links
  Read Only: true

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Hazard"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Hazard

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Hazard"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Hazard

Type: object

Show Source

• action: string
  Minimum Length: 0

  Maximum Length: 255

  Action that must be taken, cannot be blank, max length is 255 characters

  Example: Evacuate immediately
• created(optional): string(date-time)
  Read Only: true

  Hazard creation time in ISO-8601 format
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 53
• links(optional): array links
• locationIds: array locationIds
  Locations affected by the hazard, cannot be empty
• message(optional): string
  Optional message describing the hazard details

  Example: This is detailed message describing hazard in more detail
• severity: string
  Allowed Values: [ "hazard.severity.low", "hazard.severity.medium", "hazard.severity.high" ]
• severityValue(optional): string
  Read Only: true

  Configurable text interpretation of the severity

  Example: Configured severity value
• status(optional): string
  Read Only: true

  Allowed Values: [ "OPEN", "RESOLVED" ]

  Status of the hazard

  Example: OPEN
• subject: string
  Minimum Length: 0

  Maximum Length: 255

  Subject of the hazard, cannot be blank, max length is 255 characters

  Example: Gas leak

{
    "required":[
        "action",
        "locationIds",
        "severity",
        "subject"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "severity":{
            "type":"string",
            "enum":[
                "hazard.severity.low",
                "hazard.severity.medium",
                "hazard.severity.high"
            ]
        },
        "severityValue":{
            "type":"string",
            "description":"Configurable text interpretation of the severity",
            "readOnly":true,
            "example":"Configured severity value"
        },
        "subject":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Subject of the hazard, cannot be blank, max length is 255 characters",
            "example":"Gas leak"
        },
        "action":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Action that must be taken, cannot be blank, max length is 255 characters",
            "example":"Evacuate immediately"
        },
        "message":{
            "type":"string",
            "description":"Optional message describing the hazard details",
            "example":"This is detailed message describing hazard in more detail"
        },
        "created":{
            "type":"string",
            "description":"Hazard creation time in ISO-8601 format",
            "format":"date-time",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "description":"Status of the hazard",
            "readOnly":true,
            "example":"OPEN",
            "enum":[
                "OPEN",
                "RESOLVED"
            ]
        },
        "locationIds":{
            "type":"array",
            "description":"Locations affected by the hazard, cannot be empty",
            "writeOnly":true,
            "example":[
                51,
                52
            ],
            "items":{
                "type":"string",
                "description":"Locations affected by the hazard, cannot be empty",
                "example":"[51,52]"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : locationIds

Type: array

Locations affected by the hazard, cannot be empty

Show Source

• Array of: string
  Locations affected by the hazard, cannot be empty

  Example: [51,52]

{
    "type":"array",
    "description":"Locations affected by the hazard, cannot be empty",
    "writeOnly":true,
    "example":[
        51,
        52
    ],
    "items":{
        "type":"string",
        "description":"Locations affected by the hazard, cannot be empty",
        "example":"[51,52]"
    }
}

Example:

[
    51,
    52
]

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top