Feed HTML file-backed description content

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

Operation id: getFeedContent

Description

Retrieves the HTML description content for a feed. Only feeds with description type "FILE" return content. The contents field contains raw HTML with dynamic token replacements applied by the service layer.

Processing steps:

  1. Validates feed_key > 0
  2. Retrieves feed record
  3. Parses feedDescription JSON: {"type":"FILE","fileKey":"...","entity":"filename.html"}
  4. If type ≠ "FILE" or parsing fails → E404
  5. Fetches file content via FeedProcessService.getFeedDescription()
  6. Applies token replacements (see below)
  7. Returns content in {status: OK, contents: "..."} wrapper

Token replacements applied to content:

TokenReplaced with
$$authToken$$Authentication token
$Session_userId$User ID from session
$Session_userName$User name from session
$Session_unitId$Unit ID from session
$Param_taskId$Feed's cluster child ID
$Param_status$Feed's status
$Param_initiativeId$Feed's cluster ID
$Session_parentUnitId$Feed's parent unit ID

Path Parameters

ParameterTypeRequiredDescription
feed_keyIntegerYesUnique numeric feed identifier (→ E105 if ≤ 0)

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 or invalid feed_key (non-numeric or ≤ 0)400E105feed_key is mandatory
Feed record not found200401The given feed_key is not found
Feed description is null or empty200E404No data found
Feed description type is not "FILE"200E404No data found
Feed description is invalid JSON200E404No data found
File content retrieval returns empty/null200E404No data found
Unexpected server-side error500E500Unexpected server error.

Error Codes Reference

CodeDescription
E105Invalid or missing feed_key
E112X-reflexis-csrf-token-X header is mandatory
E204Invalid or expired token
401Feed record not found for feed_key
E404No data found (empty/unsupported content)
E500Unexpected server error

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, contents: "<html>..."}

Content type: application/json

400 — E105 — invalid or missing feed_key

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, contents: "<html>..."}

Content type: application/json

Schema

JSON object (structure varies by endpoint).

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

Example:

{
  "status": "OK",
  "contents": "<p>Task instructions go here...</p>"
}

400 — E105 — invalid or missing feed_key

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