List all notes on a feed

GET /task/v1/feeds/{feed_key}/notes

Operation id: getFeedNotes

Description

Retrieves all notes associated with the specified feed. Returns feed_notes_arr[] — an empty array is a valid OK response (no notes). Service null → E303. Requires FEED_ACCESS line-of-sight authorization.

Path Parameters

Response Fields — feed_notes_arr[*]

Error Scenarios

Error Codes Reference

Tags: MyWorkFeeds

Parameters

Path parameters

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, feed_notes_arr[]}

Content type: application/json

401 — Missing or invalid X-reflexis-csrf-token-X session token

Content type: application/json

500 — Unexpected server-side error

Content type: application/json

Response models

200 — Success — {status: OK, feed_notes_arr[]}

Content type: application/json

Schema

JSON object (structure varies by endpoint).

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

Example:

{
  "status": "OK",
  "feed_notes_arr": [
    {
      "notes_id": 42,
      "feed_key": 101,
      "unit_id": "UNIT_01",
      "cluster_id": "CLUSTER_A",
      "cluster_child_id": "CHILD_B",
      "creator_id": "SYSADMIN",
      "creator_name": "System Administrator",
      "notes_content": "Sample note content",
      "creation_time": "2024-01-15 10:00:00",
      "last_updated_time": "2024-01-15 11:00:00"
    }
  ]
}

401 — Missing or invalid X-reflexis-csrf-token-X session token

Content type: application/json

Schema

{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "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. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E202",
  "response": "User session is invalid"
}

500 — Unexpected server-side error

Content type: application/json

Schema

{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "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. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

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