id-of-ticket-comments-list

dci id-of-ticket-comments-list ticketId

Returns all comments on a support request. For customers, only public comments are returned. For DoiT employees, both public and private comments are returned. All comments are returned in a single response (no pagination).

Responses

200 (application/json)

OK - List of comments returned.

{
  "type": "object",
  "description": "Response containing all comments on a support ticket.",
  "properties": {
    "comments": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A comment on a support ticket.",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Comment ID.",
            "format": "int64"
          },
          "body": {
            "type": "string",
            "description": "The text content of the comment."
          },
          "author": {
            "type": "string",
            "description": "Email address of the comment author."
          },
          "created": {
            "type": "integer",
            "description": "The time when this comment was created, in milliseconds since the epoch.",
            "format": "int64"
          },
          "attachments": {
            "type": "array",
            "description": "File attachments on the comment.",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "format": "int64"
                },
                "file_name": {
                  "type": "string"
                },
                "content_url": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: id-of-ticket-comments-list, idofticketcommentslist