at.zrwv.parker.item Documentation (EN)

main record

A privately captured inbox item. Provisional (schemaVersion 1).

Record Key any Any valid record key

Properties

body string Optional

No description available.

maxLength: 100000 bytes

categoryIds array of string Optional

No description available.

collectionIds array of string Optional

No description available.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

id string Required

No description available.

maxLength: 64 bytes

images array of ref #image Optional

No description available.

maxLength: 10 items

intendedDestination string Optional

No description available.

maxLength: 64 bytes

kind string Required

No description available.

Known values: link, article, photo, quote, note

privateNotes string Optional

No description available.

maxLength: 100000 bytes

publicMetadata unknown Optional

No description available.

schemaVersion integer Required

No description available.

minimum: 1

sourceUrl string uri Optional

A valid URI.

status string Required

No description available.

Known values: pending, publishing, published, failed, archived

suggestions unknown Optional

No description available.

tagIds array of string Optional

No description available.

title string Optional

No description available.

maxLength: 3000 bytes

updatedAt string datetime Required

An RFC 3339 formatted timestamp.

userEditedFields array of string Optional

No description available.

View raw schema

{
  "description": "A privately captured inbox item. Provisional (schemaVersion 1).",
  "key": "any",
  "record": {
    "properties": {
      "body": {
        "maxLength": 100000,
        "type": "string"
      },
      "categoryIds": {
        "items": {
          "maxLength": 64,
          "type": "string"
        },
        "type": "array"
      },
      "collectionIds": {
        "items": {
          "maxLength": 64,
          "type": "string"
        },
        "type": "array"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "id": {
        "maxLength": 64,
        "type": "string"
      },
      "images": {
        "items": {
          "ref": "#image",
          "type": "ref"
        },
        "maxLength": 10,
        "type": "array"
      },
      "intendedDestination": {
        "maxLength": 64,
        "type": "string"
      },
      "kind": {
        "knownValues": [
          "link",
          "article",
          "photo",
          "quote",
          "note"
        ],
        "type": "string"
      },
      "privateNotes": {
        "maxLength": 100000,
        "type": "string"
      },
      "publicMetadata": {
        "type": "unknown"
      },
      "schemaVersion": {
        "minimum": 1,
        "type": "integer"
      },
      "sourceUrl": {
        "format": "uri",
        "type": "string"
      },
      "status": {
        "knownValues": [
          "pending",
          "publishing",
          "published",
          "failed",
          "archived"
        ],
        "type": "string"
      },
      "suggestions": {
        "type": "unknown"
      },
      "tagIds": {
        "items": {
          "maxLength": 64,
          "type": "string"
        },
        "type": "array"
      },
      "title": {
        "maxLength": 3000,
        "type": "string"
      },
      "updatedAt": {
        "format": "datetime",
        "type": "string"
      },
      "userEditedFields": {
        "items": {
          "maxLength": 64,
          "type": "string"
        },
        "type": "array"
      }
    },
    "required": [
      "schemaVersion",
      "id",
      "kind",
      "status",
      "createdAt",
      "updatedAt"
    ],
    "type": "object"
  },
  "type": "record"
}

image object

No description available.

Properties

alt string Required

No description available.

maxLength: 10000 bytes

credit string Optional

No description available.

maxLength: 3000 bytes

image blob Required

No description available.

maxSize: 10.0 MB

View raw schema

{
  "properties": {
    "alt": {
      "maxLength": 10000,
      "type": "string"
    },
    "credit": {
      "maxLength": 3000,
      "type": "string"
    },
    "image": {
      "accept": [
        "image/jpeg",
        "image/png",
        "image/webp"
      ],
      "maxSize": 10000000,
      "type": "blob"
    }
  },
  "required": [
    "image",
    "alt"
  ],
  "type": "object"
}