Usage

This part of the documentation explains how to use the Plone REST API.

Table of Contents

• Authentication
  • JSON Web Tokens (JWT)
  • Permissions
• Batching
  • Top-level attributes
  • Batching links
  • Parameters
• Content Manipulation
  • Creating a Resource with POST
  • Reading a Resource with GET
  • Updating a Resource with PATCH
  • Replacing a Resource with PUT
  • Removing a Resource with DELETE
  • Reordering sub resources
• Customizing the API
  • Content serialization
• Expansion
• Explore the API using Postman
  • Configuration
  • Usage
• i18n: internationalization of screen messages
• Serialization
  • Basic Types
  • Dates and Times
  • Decimal Type
  • RichText fields
  • File / Image Fields
  • Relations
  • Next, Previous, and Parent Navigation
• Types Schema
  • TextLine
  • Text
  • Bool
  • Float
  • Decimal
  • Int
  • Choice
  • List
  • Tuple
  • Set
  • List of Choices
  • Object
  • RichText (plone.app.textfield)
  • Date
  • DateTime
  • Email
  • Password
  • URI
• Volto Blocks support
  • Retrieving blocks on a content object
  • Adding blocks to an object
  • Block serializers and deserializers
  • SearchableText indexing for blocks
  • Visit all blocks