Aggregated comment summary + snippets for one or more projects (TM-73716)
GET /task/v1/comments/summary
Operation id: getCommentsSummary
Description
Returns summary counts (total, unread, with_attachments) and a paginated threads[] snippet list across one or more projects. Sorted newest-first. Requires ROS_UNIT_DOMAIN line-of-sight authorization.
Tags: MyWorkComments
Parameters
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
has_attachments | boolean | No | When true, only comments with at least one attachment are returned. |
mentions_user | string | No | Only include comments whose plain text contains @<value>. |
msg_status | string | No | CSV status filter: N=Unread, R=Read. |
no_records | integer | No | Page size. 0 = all remaining rows. |
project_ids | string | Yes | Comma-separated project feed keys (positive integers, max 50). E222 if invalid; E224 if > 50 unique ids. |
selected_dates | string | No | Date window yyyyMMdd,yyyyMMdd. Defaults to last 90 days when absent. |
since_timestamp | integer (int64) | No | Epoch-ms lower bound for comment creation time. 0 or absent = no lower bound. E223 if non-numeric or negative. |
skip_records | integer | No | Pagination offset. |
Security
- AuthTokenHeader (apiKey)
- Session authentication token validated server-side against the user session store.
Responses
200 — Success — {status: OK, summary: {total_count, unread_count, with_attachments_count}, threads[], has_more, skip_records, returned_count}
Content type: application/json
400 — E222 — project_ids malformed/invalid tokens or non-positive integers | E223 — since_timestamp invalid | E224 — project_ids > 50 unique ids | E134 — msg_status invalid
Content type: application/json
401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)
Content type: application/json
422 — E222 — project_ids absent or blank (missing mandatory parameter)
Content type: application/json
500 — Unexpected server-side error
Content type: application/json
Response models
200 — Success — {status: OK, summary: {total_count, unread_count, with_attachments_count}, threads[], has_more, skip_records, returned_count}
Content type: application/json
Schema
JSON object (structure varies by endpoint).
{
"type": "object",
"description": "JSON object (structure varies by endpoint)."
}
Example:
{
"status": "OK",
"summary": {
"total_count": 12,
"unread_count": 4,
"with_attachments_count": 2
},
"threads": [
{
"feed_key": 1001,
"cluster_id": "SYSADMIN_1773851291103",
"msg_id": 5001,
"author_id": "JSMITH",
"author_store": "STORE_01",
"created_at": 1774373200310,
"message_status": "N",
"has_attachments": false,
"snippet": "Please review the attached checklist before the deadline…"
}
],
"has_more": true,
"skip_records": 0,
"returned_count": 10
}
400 — E222 — project_ids malformed/invalid tokens or non-positive integers | E223 — since_timestamp invalid | E224 — project_ids > 50 unique ids | E134 — msg_status invalid
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-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
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-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"
}
422 — E222 — project_ids absent or blank (missing mandatory parameter)
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-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"
}
}
}
500 — Unexpected server-side error
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-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"
}