ItemReadOutputParams

item/readOutput params: byte-ranged fetch of stored full output that the view truncated — the outputRef fetch path and owe. Read-only; works on loaded and unloaded sessions; no lease.

Fields and variants

• itemId
• lengthBytes
• offsetBytes
• outputRef
• sessionId

Source

schema/msp/experimental/msp.schema.json#/types/ItemReadOutputParams

{
  "description": "`item/readOutput` params: byte-ranged fetch of stored full\noutput that the view truncated — the `outputRef` fetch path and\n owe. Read-only; works on loaded and unloaded sessions; no lease.",
  "properties": {
    "itemId": {
      "description": "The item whose stored output is fetched.",
      "type": "string"
    },
    "lengthBytes": {
      "description": "STORED bytes requested; default and max 6 MiB. A value\nabove the max is served at the max.",
      "type": "integer"
    },
    "offsetBytes": {
      "description": "STORED-byte offset to start from; 0 when omitted. STORED bytes are a\nproperty of the output, not of a transport.",
      "type": "integer"
    },
    "outputRef": {
      "description": "The `outputRef.id` from the item (never the `uri`; the uri is\ndisplay/provenance).",
      "type": "string"
    },
    "sessionId": {
      "description": "The session the item belongs to.",
      "type": "string"
    }
  },
  "required": [
    "itemId",
    "outputRef",
    "sessionId"
  ],
  "type": "object"
}