Reserved Item Body Keys

This is for:

Developer System Administrator
In this article

When you push an item, you can include as many metadata key-value pairs as you need in your item body, as long as each key name is unique.

The following key names are reserved in the item body:

  • compressedBinaryData

  • compressedBinaryDataId

  • compressionType

  • data

  • documentId

  • fileExtension

  • orderingId

  • parentId

  • permissions

Don’t use any of the reserved key names as metadata keys. Otherwise, your push operation will likely have unexpected results, or fail due to invalid JSON.

Metadata key names are case-insensitive (for example, mykey, MyKey, myKey, MYKEY, etc. are all considered identical).

This implies that you can never use a reserved keyword as a distinct metadata, even if you somehow alter its case.

Valid metadata keys

{
  "document_id": "http://www.example.com/",
  "my_fileextension": ".html",
  "mymeta": "myvalue"
}

Invalid metadata keys:

{
  "documentid": "http://www.example.com/",
  "FILEEXTENSION": ".html"
}

See also Item Models - DocumentBody.