Workflow and history#
Move items through their workflow, read their versions, and edit a published item in a working copy.
Each transition changes the review_state of an item.
Working copies need the plone.app.iterate add-on, which the examples on this page install first.
Each example uses the client from How to read these pages.
client.workflow#
Workflow state and transitions (@workflow).
client.workflow.get#
Current state, history and available transitions of an item.
See get().
Calls GET /news/release-party/@workflow (plone.restapi documentation).
client.workflow.get("/news/release-party")
plone-client workflow /news/release-party -f state,transitions
{
"state": {
"id": "private",
"title": "Private"
},
"transitions": [
"publish",
"submit"
]
}
GET /Plone/++api++/news/release-party/@workflow HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/news/release-party/@workflow -H 'accept: application/json' -u admin:admin
{
"state": {
"id": "private",
"title": "Private"
},
"transitions": [
{
"@id": "http://localhost:8080/Plone/news/release-party/@workflow/publish",
"title": "Publish"
},
{
"@id": "http://localhost:8080/Plone/news/release-party/@workflow/submit",
"title": "Submit for publication"
}
]
}
This shows only state, transitions. This shows only @id, title of each entry.
client.workflow.transition#
Run a workflow transition.
See transition().
Calls POST /news/release-party/@workflow/publish (plone.restapi documentation).
client.workflow.transition(
"/news/release-party",
"publish",
comment="Ready for readers.",
)
plone-client workflow /news/release-party publish
{
"action": "publish",
"actor": "admin",
"comments": "",
"review_state": "published",
"time": "2026-11-01T02:47:40+00:00",
"title": "Published"
}
POST /Plone/++api++/news/release-party/@workflow/publish HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"comment": "Ready for readers."
}
curl -i -X POST http://localhost:8080/Plone/++api++/news/release-party/@workflow/publish -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"comment":"Ready for readers."}'
{
"action": "publish",
"comments": "Ready for readers.",
"review_state": "published",
"title": "Published"
}
This shows only action, comments, review_state, title.
client.history#
Versions and workflow history of an item (@history).
client.history.list#
History entries of an item, newest first.
See list().
Calls GET /about/@history (plone.restapi documentation).
client.history.list("/about")
plone-client history /about -f action,type
[
{
"action": "publish",
"type": "workflow"
},
{
"action": "Edited",
"type": "versioning"
},
{
"action": "Create",
"type": "workflow"
}
]
GET /Plone/++api++/about/@history HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/about/@history -H 'accept: application/json' -u admin:admin
[
{
"action": "publish",
"transition_title": "Publish",
"type": "workflow"
},
{
"action": "Edited",
"transition_title": "Edited",
"type": "versioning"
},
{
"action": "Create",
"transition_title": "Create",
"type": "workflow"
}
]
This shows only action, type, transition_title of each entry.
client.history.get#
An older version of an item.
See get().
Calls GET /news/old-announcement/@history/0 (plone.restapi documentation).
client.history.get("/news/old-announcement", 0)
GET /Plone/++api++/news/old-announcement/@history/0 HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/news/old-announcement/@history/0 -H 'accept: application/json' -u admin:admin
{
"@id": "http://localhost:8080/Plone/news/old-announcement",
"title": "Old announcement",
"version": "0"
}
This shows only @id, title, version.
client.history.revert#
Revert an item to an older version.
See revert().
Calls PATCH /news/old-announcement/@history (plone.restapi documentation).
client.history.revert("/news/old-announcement", 0)
PATCH /Plone/++api++/news/old-announcement/@history HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"version": 0
}
curl -i -X PATCH http://localhost:8080/Plone/++api++/news/old-announcement/@history -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"version":0}'
{
"message": "Old announcement has been reverted to revision 0."
}
client.working_copy#
Working copies of published items (@workingcopy).
client.working_copy.create#
Check out an item into a working copy.
See create().
Calls POST /about/@workingcopy (plone.restapi documentation).
client.working_copy.create("/about")
POST /Plone/++api++/about/@workingcopy HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X POST http://localhost:8080/Plone/++api++/about/@workingcopy -H 'accept: application/json' -u admin:admin
{
"@id": "http://localhost:8080/Plone/working_copy_of_about"
}
client.working_copy.get#
Working copy of an item, or the baseline of a working copy.
See get().
Calls GET /about/@workingcopy (plone.restapi documentation).
client.working_copy.get("/about")
GET /Plone/++api++/about/@workingcopy HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/about/@workingcopy -H 'accept: application/json' -u admin:admin
{
"working_copy": {
"@id": "http://localhost:8080/Plone/working_copy_of_about",
"created": "2026-11-01T02:47:40+00:00",
"creator_name": "admin",
"creator_url": "http://localhost:8080/Plone/author/admin",
"title": "About"
}
}
This shows only working_copy.
client.working_copy.check_in#
Apply a working copy to its baseline and remove it.
See check_in().
Calls PATCH /about/@workingcopy (plone.restapi documentation).
client.working_copy.check_in("/about")
PATCH /Plone/++api++/about/@workingcopy HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X PATCH http://localhost:8080/Plone/++api++/about/@workingcopy -H 'accept: application/json' -u admin:admin
The site answers 204, and the method returns None.
client.working_copy.delete#
Remove a working copy without applying it.
See delete().
Calls DELETE /about/@workingcopy (plone.restapi documentation).
client.working_copy.delete("/about")
DELETE /Plone/++api++/about/@workingcopy HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X DELETE http://localhost:8080/Plone/++api++/about/@workingcopy -H 'accept: application/json' -u admin:admin
The site answers 204, and the method returns None.