Sign in
issue

Create a comment

Creates a comment and returns associated issue in JSON format.

post/issue/{issueId}/comment

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/issue/{issueId}/comment
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Path parameters

issueIdnumber required
Example:1

Request body

messagestring required

Response

Issue returned with new comment

idnumber
issueTypenumber

Example response

{
  "id": 1,
  "issueType": 1,
  "media": {
    "requests": [
      {
        "id": 123,
        "createdAt": "2020-09-12T10:00:27.000Z",
        "updatedAt": "2020-09-12T10:00:27.000Z",
        "requestedBy": {
          "id": 1,
          "email": "hey@itsme.com",
          "userType": 1,
          "createdAt": "2020-09-02T05:02:23.000Z",
          "updatedAt": "2020-09-02T05:02:23.000Z",
          "requestCount": 5
        },
        "modifiedBy": {
          "id": 1,
          "email": "hey@itsme.com",
          "userType": 1,
          "createdAt": "2020-09-02T05:02:23.000Z",
          "updatedAt": "2020-09-02T05:02:23.000Z",
          "requestCount": 5
        }
      }
    ],
    "createdAt": "2020-09-12T10:00:27.000Z",
    "updatedAt": "2020-09-12T10:00:27.000Z"
  },
  "createdBy": {
    "id": 1,
    "email": "hey@itsme.com",
    "userType": 1,
    "createdAt": "2020-09-02T05:02:23.000Z",
    "updatedAt": "2020-09-02T05:02:23.000Z",
    "requestCount": 5
  },
  "modifiedBy": {
    "id": 1,
    "email": "hey@itsme.com",
    "userType": 1,
    "createdAt": "2020-09-02T05:02:23.000Z",
    "updatedAt": "2020-09-02T05:02:23.000Z",
    "requestCount": 5
  },
  "comments": [
    {
      "id": 1,
      "user": {
        "id": 1,
        "email": "hey@itsme.com",
        "userType": 1,
        "createdAt": "2020-09-02T05:02:23.000Z",
        "updatedAt": "2020-09-02T05:02:23.000Z",
        "requestCount": 5
      },
      "message": "A comment"
    }
  ]
}

Changes

No recorded changes to this operation across all 21 revisions of this API.