Jump to

• Request
• Response

Get all hazard comments

get

/connectedWorker/clientapi/v2/projects/{projectId}/hazards/{hazardId}/comments

This operation retrieves all comments for a specific hazard.

Request

Path Parameters

• hazardId: integer(int64)
  Hazard identifier
• projectId: integer(int64)
  Project identifier

Back to Top

Response

Supported Media Types

• application/json

200 Response

Hazard comments were successfully retrieved

Body ()

Root Schema : HazardComments

Type: object

Show Source

• items: array items
• links(optional): array links

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HazardComment"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object HazardComment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/HazardComment"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : HazardComment

Type: object

Show Source

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

  Time when the comment was added, in ISO-8601 format

  Example: 2018-01-01T11:59:59
• id(optional): integer(int64)
  Read Only: true

  The unique id of the object

  Example: 53
• links(optional): array links
• message: string
  Message of the comment, cannot be blank

  Example: My comment for the hazard

{
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "example":53,
            "description":"The unique id of the object",
            "readOnly":true
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "example":"2018-01-01T11:59:59",
            "description":"Time when the comment was added, in ISO-8601 format",
            "readOnly":true
        },
        "message":{
            "type":"string",
            "example":"My comment for the hazard",
            "description":"Message of the comment, cannot be blank"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

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

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

Back to Top