Skip to content

content-types.md

Latest commit

 

History

History
153 lines (108 loc) · 4.02 KB

content-types.md

File metadata and controls

153 lines (108 loc) · 4.02 KB
myst
html_meta
description property=og:description property=og:title keywords
A list of all standard Plone content types with sample requests and responses.
A list of all standard Plone content with sample requests and responses.
Plone Content Types
Plone, plone.restapi, REST, API, Plone, Content, Types

Content Types

How to get all standard Plone content representations. The syntax is given in various tools. Click on "curl", "http-request" or "python-requests" to see an example for those tools.

For folderish types, collections or search results, the results will be **batched** if the size of the resultset exceeds the batch size.
See {doc}`../usage/batching` for more details on how to work with batched results.

Plone Portal Root

..  http:example:: curl httpie python-requests
    :request: ../../../src/plone/restapi/tests/http-examples/siteroot.req

:language: http

Plone Folder

..  http:example:: curl httpie python-requests
    :request: ../../../src/plone/restapi/tests/http-examples/folder.req

:language: http

Plone Document

..  http:example:: curl httpie python-requests
    :request: ../../../src/plone/restapi/tests/http-examples/document.req

:language: http

News Item

Here we show `uuid1` as an example uid for all image scales because this documentation is autogenerated by the tests.
When running in a real application, these `uuid1` values will be exchanged by proper uuid4 values.

..  http:example:: curl httpie python-requests
    :request: ../../../src/plone/restapi/tests/http-examples/newsitem.req

:language: http

Event

..  http:example:: curl httpie python-requests
    :request: ../../../src/plone/restapi/tests/http-examples/event.req

:language: http

Image

Here we show `uuid1` as an example uid for all image scales because this documentation is autogenerated by the tests.
When running in a real application, these `uuid1` values will be exchanged by proper uuid4 values.

The list of scales depends on the allowed image sizes configured in the Image Handling control panel.
Also, scales with a width larger than the original are not included.

..  http:example:: curl httpie python-requests
    :request: ../../../src/plone/restapi/tests/http-examples/image.req

:language: http

File

..  http:example:: curl httpie python-requests
    :request: ../../../src/plone/restapi/tests/http-examples/file.req

:language: http

Link

..  http:example:: curl httpie python-requests
    :request: ../../../src/plone/restapi/tests/http-examples/link.req

:language: http

Collection

..  http:example:: curl httpie python-requests
    :request: ../../../src/plone/restapi/tests/http-examples/collection.req

:language: http

You can also get all the data for each of the items in a collection by appending the ?fullobjects parameter to the query:

..  http:example:: curl httpie python-requests
    :request: ../../../src/plone/restapi/tests/http-examples/collection_fullobjects.req

:language: http