Zebra Workcloud APIs
OpenAPI downloadsDeveloper Portal

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 / invalid X-reflexis-csrf-token-X401E202User session is invalid
Missing or invalid feed_key (≤ 0)400E105Please provide valid feed_key.
Feed record not found200E404Feed not found
Feed description is null or empty500E404No data found
Feed description type is not "FILE"500E404No data found
Feed description is invalid JSON500E404No data found
File content retrieval returns empty/null500E404No data found
Unexpected server-side error500E500Unexpected server error.

Error Codes Reference

CodeDescription
E105Invalid or missing feed_key
E202User session is invalid
E404No data found / Feed not found
E500Unexpected server error

Tags: MyWorkFeeds

Parameters

Path parameters

NameTypeRequiredDescription
feed_keyintegerYesUnique numeric feed identifier

Security

  • 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 — 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, 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. E202, E105, E404)
responsestringYesHuman-readable error message
{
  "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"
    }
  }
}

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

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E202, E105, E404)
responsestringYesHuman-readable error message
{
  "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

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E202, E105, E404)
responsestringYesHuman-readable error message
{
  "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"
}