Jump to

• Request
• Response

Get a hazard comment.

get

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

This operation retrieves the specific comment for a specific hazard.

Request

Path Parameters

• commentId: string
  Hazard comment identifier
• 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 comment was successfully retrieved.

Body ()

Root Schema : HazardComment

Type: object

Show Source

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

  Time when the comment was added, in ISO-8601 format
• id(optional): string
  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

{
    "required":[
        "message"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "created":{
            "type":"string",
            "description":"Time when the comment was added, in ISO-8601 format",
            "format":"date-time",
            "readOnly":true
        },
        "message":{
            "type":"string",
            "description":"Message of the comment, cannot be blank",
            "example":"My comment for the hazard"
        },
        "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