Services

Services#

Every service that plone-client implements, with an example in Python, on the command line, and in HTTP, and the answer of a real site.

How to read these pages#

Every example on these pages ran against a real site, and each answer is what that site returned. The same idea drives the documentation of plone.restapi, whose tests write its examples.

The site is the Compose site described in Run a Plone site for testing, and the examples run in order. Each one uses a client like this.

from plone_client import PloneClient

client = PloneClient(
    "http://localhost:8080/Plone",
    username="admin",
    password="admin",
    frontend_url="http://localhost:3000",
)

Each method has up to three tabs, which stay in step when you switch one of them.

Python

The call, with the answer below the tabs. A sentence under the answer says what it leaves out, to keep it short.

Command line

The plone-client command for the same job, when there is one, with its output.

HTTP

Every request the client sent, and the same request as a curl command.

An example that could not run says why, and shows the request that the client would send.

📄 Content

client.content: read, create, update, delete, copy, move, order, and lock items.

Content
🔎 Search

client.search and client.querystring: find items in the catalog.

Search
🔁 Workflow and history

client.workflow, client.history, and client.working_copy.

Workflow and history
📎 Files

client.files: upload, replace, and download files and images.

Files
🧭 Navigation

client.navigation: menus, breadcrumbs, and actions.

Navigation
🔗 Comments, aliases, relations, and translations

client.comments, client.aliases, client.relations, and client.translations.

Comments, aliases, relations, and translations
👥 Users, groups, and sharing

client.users, client.groups, and client.sharing.

Users, groups, and sharing
🧩 Types and vocabularies

client.types, client.block_types, and client.vocabularies.

Types and vocabularies
🛠️ Site settings

client.registry, client.controlpanels, client.addons, client.content_rules, and client.system.

Site settings