Jump to

• Request
• Response

Get hazard locations.

get

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

This operation retrieves locations for a hazard.

Request

Path Parameters

• hazardId: string
  Hazard identifier
• 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

Hazard locations were successfully retrieved.

Body ()

Root Schema : HazardLocations

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/HazardLocation"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object HazardLocation

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

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 : HazardLocation

Type: object

Show Source

• links(optional): array links
• locationId(optional): string
  Read Only: true

  Identifier of the location within the hazard

  Example: 51
• status(optional): string
  Read Only: true

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

  Status of the hazard location

  Example: OPEN

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the hazard location",
            "readOnly":true,
            "example":"OPEN",
            "enum":[
                "OPEN",
                "RESOLVED"
            ]
        },
        "locationId":{
            "type":"string",
            "description":"Identifier of the location within the hazard",
            "readOnly":true,
            "example":"51"
        },
        "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 : 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