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.

GET-only validation: feed_key is validated as a path string before notes are fetched. Rejects blank/empty segments (e.g. /feeds//notes), literal null, non-numeric values, and values ≤ 0. After validation, user feed access is enforced via line-of-sight.

Routing note: URLs that omit feed_key entirely (e.g. /feeds/notes) are handled by GET /task/v1/feeds/{retrieve-type} and also return 400 E105.

Application errorCode 401 (feed not found) is returned with HTTP 400, not HTTP 401.

Path Parameters

ParameterTypeRequiredDescription
feed_keyIntegerYesPositive numeric feed identifier (→ E105 if blank, null, non-numeric, or ≤ 0)

Response Fields — feed_notes_arr[*]

FieldTypeDescription
domain_idIntegerDomain ID
feed_keyIntegerFeed key the note belongs to
notes_idIntegerUnique note identifier
unit_idStringUnit identifier
cluster_idStringCluster identifier
cluster_child_idStringCluster child identifier
creator_idStringUser ID of the note creator
creator_nameStringDisplay name of the note creator
notes_contentStringText content of the note
creation_timeStringFormatted creation timestamp
last_updated_timeStringFormatted last-update timestamp

Error Scenarios

ScenarioHTTPError CodeMessage
Missing X-reflexis-csrf-token-X header400E112X-reflexis-csrf-token-X header is mandatory
Invalid or expired token401E204Invalid or expired token
Missing, blank, or empty feed_key (e.g. /feeds//notes)400E105feed_key is mandatory
Misrouted URL omitting feed_key (e.g. /feeds/notes → retrieve-type handler)400E105feed_key is mandatory
Literal null as feed_key (e.g. /feeds/null/notes)400E105feed_key is mandatory
Non-numeric or non-positive feed_key400E105feed_key is mandatory
Feed not found for the given feed_key400401Feed not found for the given feed key (application code; HTTP status is 400)
User does not have access to the feed (line-of-sight)400E208feed_key is not available for this user.
Service returned null200E303Unable to fetch notes
Unexpected server-side error500E302Internal server error

Error Codes Reference

CodeDescription
E105Invalid, missing, blank, literal null, or non-positive feed_key
E112X-reflexis-csrf-token-X header is mandatory
E204Invalid or expired token
E208feed_key is not available for this user (line-of-sight)
401Feed not found for the given feed key
E302Internal server error
E303Unable to fetch notes

Tags: MyWorkFeeds

Parameters

Path parameters

NameTypeRequiredDescription
feed_keyintegerYesUnique numeric feed identifier

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

400 — E112 — missing auth header / E105 — invalid/missing feed_key / E208 — feed not available / 401 — feed not found (HTTP 400)

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

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"
    }
  ]
}

400 — E112 — missing auth header / E105 — invalid/missing feed_key / E208 — feed not available / 401 — feed not found (HTTP 400)

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"
}