Claim or unclaim a feed

POST /task/v1/actions/{feed-key}/claim

Operation id: claimFeed

Description

Claims or unclaims the feed for a transaction. flag=C (case-insensitive) = claim; any other value = unclaim. Returns an updated feed snapshot on success.

Tags: MyWorkFeedActions

Parameters

Path parameters

Security

• AuthTokenHeader (apiKey)
  • Session authentication token validated server-side against the user session store.

Responses

200 — Success — {status: OK, feed_details[]} (updated feed snapshot)

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

Request body

application/x-www-form-urlencoded

Schema

{
  "type": "object",
  "required": [
    "transaction_key"
  ],
  "properties": {
    "flag": {
      "type": "string",
      "description": "C (case-insensitive)=claim; any other value=unclaim"
    },
    "transaction_key": {
      "type": "string",
      "description": "Transaction key (long) for the claim operation (mandatory)"
    }
  }
}

Response models

200 — Success — {status: OK, feed_details[]} (updated feed snapshot)

Content type: application/json

Schema

JSON object (structure varies by endpoint).

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

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