at.margin.collectionItem Documentation (EN)

main record

Associates an annotation with a collection

Record Key tid Timestamp-based ID

Properties

annotation string at-uri Required

AT URI of the annotation, highlight, or bookmark

collection string at-uri Required

AT URI of the collection

createdAt string datetime Required

An RFC 3339 formatted timestamp.

position integer Optional

Sort order within the collection

minimum: 0

View raw schema

{
  "description": "Associates an annotation with a collection",
  "key": "tid",
  "record": {
    "properties": {
      "annotation": {
        "description": "AT URI of the annotation, highlight, or bookmark",
        "format": "at-uri",
        "type": "string"
      },
      "collection": {
        "description": "AT URI of the collection",
        "format": "at-uri",
        "type": "string"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "position": {
        "description": "Sort order within the collection",
        "minimum": 0,
        "type": "integer"
      }
    },
    "required": [
      "collection",
      "annotation",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}