Unified feed details — one call, multiple section projections

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

Operation id: getFeedDetails

Description

Returns complete feed detail data for a single feed shaped by the projection query parameter. The client requests only the sections it needs, avoiding multiple round-trips. Each section is fetched independently — a failure in one section does not abort others. Unrecognised projection names are silently ignored. Omitting projection (or leaving it empty) returns only the basic section.

Response wrapper: All sections appear under feed_details. Feed not found → entire response returns NO_DATA_FOUND (not per-section).


Path Parameters

ParameterTypeRequiredConstraintsDescription
feed_keyIntegerYes≥ 1Unique feed identifier (→ E105 if ≤ 0 or missing)

Projection → Response Key Mapping

projection valueResponse key under feed_detailsTypeNotes
basicfeed_basicObjectCore feed + cluster/CSS/completion data. Always fetched if feed not found → NO_DATA_FOUND
contentsfeed_contentsString (HTML)FILE-type descriptions only; absent if no file-based content
historyfeed_historyArrayAudit trail, most recent first
key_attributesfeed_key_attributesArrayTwo groups: {key_attr[]} and {extra_attr[]}
notesfeed_notesArrayOmitted entirely when no notes (not an empty array)
actionsfeed_actionsArrayAvailable action panels/buttons for current user
surveyfeed_surveyArrayEmpty/omitted for COMPLEX and FORM survey types
commentsfeed_commentsArrayOnly for feeds with a cluster_id (project feeds)

Key presence rules:

StateKey in response
Projection not requestedKey absent
Projection requested, no dataKey present with empty value ([] or "")
Projection requested, data foundKey present with populated value

Exception: feed_notes is absent entirely (not []) when there are no notes.


feed_basic — Supplementary Fields

Standard feed record fields plus:

FieldTypePresent whenDescription
last_fetch_timeLongFeed existsEpoch ms timestamp
allow_completionObjectAlways{complete: Boolean, message: String, panel?: ...}
allow_completion_flagBooleanAlwaystrue if current user can complete the feed
feed_cssObjectDomain CSS configuredCSS tokens: BG_COLOR, FONT_COLOR
task_imageStringFeed has a type imageBase64-encoded task icon
store_status[]ArrayFeed belongs to a projectPer-store status; see sub-fields below
cluster_countIntegerFeed belongs to a projectTask count filtered by message_type/status params

store_status[*] fields: cluster_id, cluster_child_id, message_type, stores[]

stores[*] fields: store_id, status, dept_id, profile_id, assign_user, last_update_time


feed_history — Field Reference

FieldTypeDescription
feed_keyIntegerFeed identifier
action_seqStringAction label (e.g. "Event Viewed", "Reviewed")
user_idStringUser who performed the action
user_nameStringDisplay name
user_levelIntegerPermission level at time of action
creation_timeStringFormatted timestamp
resultStringAction outcome description
action_idStringAction type code (e.g. VIEW_EVENT); may be absent
commentsStringComments attached; empty string if none
attachmentsStringComma-separated attachment IDs; empty string if none
comment_flagString"1" if comments attached, "0" otherwise
form_flagString"1" if form data attached
attach_flagString"1" if attachments present

feed_actions — Field Reference

FieldTypeDescription
panel_idStringPanel identifier
seq_noIntegerDisplay order
display_textStringURL-encoded action label
take_actionStringY=triggers a status update, N=other type
button_idStringButton identifier
panel_categoryStringCategory code
service_dataStringJSON-encoded metadata (buttonName, buttonId pairs)
default_flagString"1"=default action, "0" otherwise
display_imageStringRelative path to action icon

Error Scenarios

ScenarioHTTPError CodeMessage
Missing / invalid X-reflexis-csrf-token-X401E202User session is invalid
feed_key ≤ 0 or missing400E105Please provide valid feedKey.
All requested projections empty200E404No data found
Unknown projection name200Section silently omitted
Individual projection fetch fails200Section omitted; others continue
Unexpected server error500E302Internal server error

Error Codes Reference

CodeDescription
E105Invalid or missing feed_key
E202User session is invalid
E302Internal server error
E404No data found

Tags: MyWorkFeeds

Parameters

Path parameters

NameTypeRequiredDescription
feed_keyintegerYesUnique numeric feed identifier

Query parameters

NameTypeRequiredDescription
btn_statusstringNoSurvey action type for survey projection: C=completion survey (default), F=force-complete survey
message_typestringNoMessage type filter for cluster task count inside basic (no effect for standalone feeds)
projectionstringNoComma-separated sections to include. Valid: basic, contents, history, key_attributes, notes, actions, survey, comments. Omit or leave empty for basic only.
statusstringNoOptional status filter for cluster task count inside basic
view_typestringNoView type affecting feed ownership/action eligibility in basic: MV=My View, TV=Task View

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_details: {feed_basic?, feed_contents?, feed_history?, ...}}

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, feed_details: {feed_basic?, feed_contents?, feed_history?, ...}}

Content type: application/json

Schema

JSON object (structure varies by endpoint).

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

Example:

{
  "status": "OK",
  "feed_details": {
    "feed_basic": {
      "feed_key": 45739193,
      "feed_title": "Weekly Store Check",
      "status": "O",
      "priority": 1
    }
  }
}

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