Jump to

• Request
• Response

Get incident comments.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/incidents/{incidentId}/comments

This operation retrieves comments for an incident.

Request

Path Parameters

• incidentId: string
  Incident identifier
• orgId: string
  Organization identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Incident comments were successfully retrieved.

Body ()

Root Schema : IncidentComments

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

Nested Schema : items

Type: array

Show Source

• Array of: object IncidentComment

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

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

Type: object

Show Source

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

  Date and time when comment was created in ISO-8601 format. Automatically assigned on backend during creation of the comment.
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 53
• links(optional): array links
• state(optional): string
  Read Only: true

  Allowed Values: [ "NEW", "OPEN", "WORK_IN_PROGRESS", "RESOLVED", "WITHDRAWN", "SEND_TO_EXTERNAL_PROCESSING" ]

  State of the incident when comment was created. Automatically assigned on backend during creation of the comment.

  Example: OPEN
• text: string
  Text of the comment. Cannot be blank.

  Example: My comment for the incident

{
    "required":[
        "text"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "commentDate":{
            "type":"string",
            "description":"Date and time when comment was created in ISO-8601 format. Automatically assigned on backend during creation of the comment.",
            "format":"date-time",
            "readOnly":true
        },
        "text":{
            "type":"string",
            "description":"Text of the comment. Cannot be blank.",
            "example":"My comment for the incident"
        },
        "state":{
            "type":"string",
            "description":"State of the incident when comment was created. Automatically assigned on backend during creation of the comment.",
            "readOnly":true,
            "example":"OPEN",
            "enum":[
                "NEW",
                "OPEN",
                "WORK_IN_PROGRESS",
                "RESOLVED",
                "WITHDRAWN",
                "SEND_TO_EXTERNAL_PROCESSING"
            ]
        },
        "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