Reply to an existing comment thread

POST /task/v1/comments/reply

Operation id: replyComment

Description

Replies to an existing comment thread. message_type must be R (case-insensitive); any other value → E126 before reaching the service. Response shape is identical to /add. Requires ROS_UNIT_DOMAIN line-of-sight authorization.

Tags: MyWorkComments

Security

  • ApiKeyHeader (apiKey)
    • APIGEE API key header validated by VerifyAPIKey policy.
  • AuthTokenHeader (apiKey)
    • Session authentication token validated server-side against the user session store.

Responses

200 — Success — {status: OK, comment_data[]} (same shape as /add)

Content type: application/json

400 — E112 — missing CSRF header |

E121 — msg_main_id is mandatory (missing or blank) | E141 — msg_main_id must be a valid integer (non-numeric or out of range) | E122 — comment is mandatory | E126 — invalid message_type (must be R) | E162 — attachment count exceeds configured maximum | E164 — invalid link URL | E125 — invalid attachment type (application-level check; response lists the allowed types) | E600 — file blocked by the kernel security filter before validation (unsafe/unsupported content) | E601 — request rejected by the kernel security filter (generic)

Content type: application/json

401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)

Content type: application/json

500 — Unexpected server-side error

Content type: application/json

Request body

Required: Yes

multipart/form-data

Schema

PropertyTypeRequiredDescription
message_typestringYesMust be R (case-insensitive) — mandatory (E126 if missing or different value)
msg_main_idintegerYesRoot/thread message ID being replied to — mandatory integer (E121 if missing, E141 if non-numeric or out of range)
commentstringYesHTML-formatted reply body (URL-encoded, e.g. %3Cp%3EText%3C%2Fp%3E) — mandatory. plain_text is derived server-side.
cluster_idstringNoCluster context of the thread
feed_keyintegerNoFeed/project key
msg_parent_idintegerNoImmediate parent message ID within the thread
linkstringNoURL to embed in the reply
internalstringNoInternal-only flag: Y=internal, -1=not set
{
  "type": "object",
  "required": [
    "message_type",
    "msg_main_id",
    "comment"
  ],
  "properties": {
    "message_type": {
      "type": "string",
      "description": "Must be R (case-insensitive) — mandatory (E126 if missing or different value)",
      "enum": [
        "R"
      ]
    },
    "msg_main_id": {
      "type": "integer",
      "description": "Root/thread message ID being replied to — mandatory integer (E121 if missing, E141 if non-numeric or out of range)"
    },
    "comment": {
      "type": "string",
      "description": "HTML-formatted reply body (URL-encoded, e.g. %3Cp%3EText%3C%2Fp%3E) — mandatory. plain_text is derived server-side."
    },
    "cluster_id": {
      "type": "string",
      "description": "Cluster context of the thread",
      "default": "-1"
    },
    "feed_key": {
      "type": "integer",
      "description": "Feed/project key",
      "default": 0
    },
    "msg_parent_id": {
      "type": "integer",
      "description": "Immediate parent message ID within the thread",
      "default": 0
    },
    "link": {
      "type": "string",
      "description": "URL to embed in the reply"
    },
    "internal": {
      "type": "string",
      "description": "Internal-only flag: Y=internal, -1=not set",
      "default": "-1"
    }
  }
}

Response models

200 — Success — {status: OK, comment_data[]} (same shape as /add)

Content type: application/json

Schema

JSON object (structure varies by endpoint).

{
  "type": "object",
  "description": "JSON object (structure varies by endpoint)."
}

400 — E112 — missing CSRF header |

E121 — msg_main_id is mandatory (missing or blank) | E141 — msg_main_id must be a valid integer (non-numeric or out of range) | E122 — comment is mandatory | E126 — invalid message_type (must be R) | E162 — attachment count exceeds configured maximum | E164 — invalid link URL | E125 — invalid attachment type (application-level check; response lists the allowed types) | E600 — file blocked by the kernel security filter before validation (unsafe/unsupported content) | E601 — request rejected by the kernel security filter (generic)

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E204",
  "response": "Invalid or expired token"
}

500 — Unexpected server-side error

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E302",
  "response": "Internal server error"
}