Content Types
Contents
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.
Note
For folderish types, collections or search results, the results will be batched if the size of the resultset exceeds the batch size. See Batching for more details on how to work with batched results.
Plone Portal Root#
GET /plone HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0
curl -i -X GET http://nohost/plone -H "Accept: application/json" --user admin:secret
http http://nohost/plone Accept:application/json -a admin:secret
requests.get('http://nohost/plone', headers={'Accept': 'application/json'}, auth=('admin', 'secret'))
HTTP/1.1 200 OK
Content-Type: application/json
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/@workflow"
}
},
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"UID": "55c25ebc220d400393574f37d648727c",
"allow_discussion": false,
"contributors": [],
"creators": [
"admin"
],
"description": "",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"id": "plone",
"is_folderish": true,
"items": [
{
"@id": "http://localhost:55001/plone/front-page",
"@type": "Document",
"description": "Congratulations! You have successfully installed Plone.",
"review_state": "private",
"title": "Welcome to Plone",
"type_title": "Page"
}
],
"items_total": 1,
"language": {
"title": "English",
"token": "en"
},
"lock": {
"locked": false,
"stealable": true
},
"parent": {},
"relatedItems": [],
"review_state": null,
"rights": "",
"subjects": [],
"table_of_contents": null,
"text": null,
"title": "Plone site",
"type_title": "Plone Site"
}
Plone Folder#
GET /plone/folder HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0
curl -i -X GET http://nohost/plone/folder -H "Accept: application/json" --user admin:secret
http http://nohost/plone/folder Accept:application/json -a admin:secret
requests.get('http://nohost/plone/folder', headers={'Accept': 'application/json'}, auth=('admin', 'secret'))
HTTP/1.1 200 OK
Content-Type: application/json
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/folder/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/folder/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/folder/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/folder/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/folder/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/folder/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/folder/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/folder/@workflow"
}
},
"@id": "http://localhost:55001/plone/folder",
"@type": "Folder",
"UID": "SomeUUID000000000000000000000002",
"allow_discussion": false,
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"description": "This is a folder with two documents",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"id": "folder",
"is_folderish": true,
"items": [
{
"@id": "http://localhost:55001/plone/folder/doc1",
"@type": "Document",
"description": "",
"review_state": "private",
"title": "A document within a folder",
"type_title": "Page"
},
{
"@id": "http://localhost:55001/plone/folder/doc2",
"@type": "Document",
"description": "",
"review_state": "private",
"title": "A document within a folder",
"type_title": "Page"
}
],
"items_total": 2,
"language": "",
"layout": "listing_view",
"lock": {},
"modified": "1995-07-31T17:30:00+00:00",
"nextPreviousEnabled": false,
"next_item": {},
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"relatedItems": [],
"review_state": "private",
"rights": "",
"subjects": [],
"title": "My Folder",
"type_title": "Folder",
"version": "current",
"working_copy": null,
"working_copy_of": null
}
Plone Document#
GET /plone/front-page HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0
curl -i -X GET http://nohost/plone/front-page -H "Accept: application/json" --user admin:secret
http http://nohost/plone/front-page Accept:application/json -a admin:secret
requests.get('http://nohost/plone/front-page', headers={'Accept': 'application/json'}, auth=('admin', 'secret'))
HTTP/1.1 200 OK
Content-Type: application/json
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/front-page/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/front-page/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/front-page/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/front-page/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/front-page/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/front-page/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/front-page/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/front-page/@workflow"
}
},
"@id": "http://localhost:55001/plone/front-page",
"@type": "Document",
"UID": "SomeUUID000000000000000000000001",
"allow_discussion": false,
"changeNote": "",
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"description": "Congratulations! You have successfully installed Plone.",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"id": "front-page",
"is_folderish": false,
"language": "",
"layout": "document_view",
"lock": {
"locked": false,
"stealable": true
},
"modified": "1995-07-31T17:30:00+00:00",
"next_item": {},
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"relatedItems": [],
"review_state": "private",
"rights": "",
"subjects": [],
"table_of_contents": null,
"text": {
"content-type": "text/plain",
"data": "<p>If you're seeing this instead of the web site you were expecting, the owner of this web site has just installed Plone. Do not contact the Plone Team or the Plone mailing lists about this.</p>",
"encoding": "utf-8"
},
"title": "Welcome to Plone",
"type_title": "Page",
"version": "current",
"versioning_enabled": true,
"working_copy": null,
"working_copy_of": null
}
News Item#
Note
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.
GET /plone/newsitem HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0
curl -i -X GET http://nohost/plone/newsitem -H "Accept: application/json" --user admin:secret
http http://nohost/plone/newsitem Accept:application/json -a admin:secret
requests.get('http://nohost/plone/newsitem', headers={'Accept': 'application/json'}, auth=('admin', 'secret'))
HTTP/1.1 200 OK
Content-Type: application/json
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/newsitem/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/newsitem/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/newsitem/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/newsitem/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/newsitem/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/newsitem/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/newsitem/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/newsitem/@workflow"
}
},
"@id": "http://localhost:55001/plone/newsitem",
"@type": "News Item",
"UID": "SomeUUID000000000000000000000002",
"allow_discussion": false,
"changeNote": "",
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"description": "This is a news item",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"id": "newsitem",
"image": {
"content-type": "image/png",
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"filename": "image.png",
"height": 56,
"scales": {
"great": {
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"height": 56,
"width": 215
},
"huge": {
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"height": 56,
"width": 215
},
"icon": {
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"height": 8,
"width": 32
},
"large": {
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"height": 56,
"width": 215
},
"larger": {
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"height": 56,
"width": 215
},
"listing": {
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"height": 4,
"width": 16
},
"mini": {
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"height": 52,
"width": 200
},
"preview": {
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"height": 56,
"width": 215
},
"teaser": {
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"height": 56,
"width": 215
},
"thumb": {
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"height": 33,
"width": 128
},
"tile": {
"download": "http://localhost:55001/plone/newsitem/@@images/uuid1.png",
"height": 16,
"width": 64
}
},
"size": 1185,
"width": 215
},
"image_caption": "This is an image caption.",
"is_folderish": false,
"language": "",
"layout": "newsitem_view",
"lock": {
"locked": false,
"stealable": true
},
"modified": "1995-07-31T17:30:00+00:00",
"next_item": {},
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"relatedItems": [],
"review_state": "private",
"rights": "",
"subjects": [],
"text": {
"content-type": "text/plain",
"data": "<p>Lorem ipsum</p>",
"encoding": "utf-8"
},
"title": "My News Item",
"type_title": "News Item",
"version": "current",
"versioning_enabled": true,
"working_copy": null,
"working_copy_of": null
}
Event#
GET /plone/event HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0
curl -i -X GET http://nohost/plone/event -H "Accept: application/json" --user admin:secret
http http://nohost/plone/event Accept:application/json -a admin:secret
requests.get('http://nohost/plone/event', headers={'Accept': 'application/json'}, auth=('admin', 'secret'))
HTTP/1.1 200 OK
Content-Type: application/json
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/event/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/event/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/event/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/event/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/event/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/event/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/event/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/event/@workflow"
}
},
"@id": "http://localhost:55001/plone/event",
"@type": "Event",
"UID": "SomeUUID000000000000000000000002",
"allow_discussion": false,
"attendees": [],
"changeNote": "",
"contact_email": null,
"contact_name": null,
"contact_phone": null,
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"description": "This is an event",
"effective": null,
"end": "2013-01-01T12:00:00+00:00",
"event_url": null,
"exclude_from_nav": false,
"expires": null,
"id": "event",
"is_folderish": false,
"language": "",
"layout": "event_view",
"location": null,
"lock": {
"locked": false,
"stealable": true
},
"modified": "1995-07-31T17:30:00+00:00",
"next_item": {},
"open_end": false,
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"recurrence": null,
"relatedItems": [],
"review_state": "private",
"rights": "",
"start": "2013-01-01T10:00:00+00:00",
"subjects": [],
"sync_uid": null,
"text": null,
"title": "Event",
"type_title": "Event",
"version": "current",
"versioning_enabled": true,
"whole_day": false,
"working_copy": null,
"working_copy_of": null
}
Image#
Note
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.
GET /plone/image HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0
curl -i -X GET http://nohost/plone/image -H "Accept: application/json" --user admin:secret
http http://nohost/plone/image Accept:application/json -a admin:secret
requests.get('http://nohost/plone/image', headers={'Accept': 'application/json'}, auth=('admin', 'secret'))
HTTP/1.1 200 OK
Content-Type: application/json
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/image/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/image/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/image/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/image/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/image/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/image/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/image/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/image/@workflow"
}
},
"@id": "http://localhost:55001/plone/image",
"@type": "Image",
"UID": "SomeUUID000000000000000000000002",
"allow_discussion": false,
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"description": "This is an image",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"id": "image",
"image": {
"content-type": "image/png",
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"filename": "image.png",
"height": 56,
"scales": {
"great": {
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"height": 56,
"width": 215
},
"huge": {
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"height": 56,
"width": 215
},
"icon": {
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"height": 8,
"width": 32
},
"large": {
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"height": 56,
"width": 215
},
"larger": {
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"height": 56,
"width": 215
},
"listing": {
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"height": 4,
"width": 16
},
"mini": {
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"height": 52,
"width": 200
},
"preview": {
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"height": 56,
"width": 215
},
"teaser": {
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"height": 56,
"width": 215
},
"thumb": {
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"height": 33,
"width": 128
},
"tile": {
"download": "http://localhost:55001/plone/image/@@images/uuid1.png",
"height": 16,
"width": 64
}
},
"size": 1185,
"width": 215
},
"is_folderish": false,
"language": "",
"layout": "image_view",
"lock": {},
"modified": "1995-07-31T17:30:00+00:00",
"next_item": {},
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"relatedItems": [],
"review_state": null,
"rights": "",
"subjects": [],
"title": "My Image",
"type_title": "Image",
"version": "current",
"working_copy": null,
"working_copy_of": null
}
File#
GET /plone/file HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0
curl -i -X GET http://nohost/plone/file -H "Accept: application/json" --user admin:secret
http http://nohost/plone/file Accept:application/json -a admin:secret
requests.get('http://nohost/plone/file', headers={'Accept': 'application/json'}, auth=('admin', 'secret'))
HTTP/1.1 200 OK
Content-Type: application/json
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/file/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/file/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/file/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/file/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/file/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/file/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/file/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/file/@workflow"
}
},
"@id": "http://localhost:55001/plone/file",
"@type": "File",
"UID": "SomeUUID000000000000000000000002",
"allow_discussion": false,
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"description": "This is a file",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"file": {
"content-type": "application/pdf",
"download": "http://localhost:55001/plone/file/@@download/file",
"filename": "file.pdf",
"size": 74429
},
"id": "file",
"is_folderish": false,
"language": "",
"layout": "file_view",
"lock": {},
"modified": "1995-07-31T17:30:00+00:00",
"next_item": {},
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"relatedItems": [],
"review_state": null,
"rights": "",
"subjects": [],
"title": "My File",
"type_title": "File",
"version": "current",
"working_copy": null,
"working_copy_of": null
}
Link#
GET /plone/link HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0
curl -i -X GET http://nohost/plone/link -H "Accept: application/json" --user admin:secret
http http://nohost/plone/link Accept:application/json -a admin:secret
requests.get('http://nohost/plone/link', headers={'Accept': 'application/json'}, auth=('admin', 'secret'))
HTTP/1.1 200 OK
Content-Type: application/json
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/link/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/link/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/link/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/link/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/link/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/link/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/link/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/link/@workflow"
}
},
"@id": "http://localhost:55001/plone/link",
"@type": "Link",
"UID": "SomeUUID000000000000000000000002",
"allow_discussion": false,
"changeNote": "",
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"description": "This is a link",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"id": "link",
"is_folderish": false,
"language": "",
"layout": "link_redirect_view",
"lock": {},
"modified": "1995-07-31T17:30:00+00:00",
"next_item": {},
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"remoteUrl": "http://localhost:55001/plone",
"review_state": "private",
"rights": "",
"subjects": [],
"title": "My Link",
"type_title": "Link",
"version": "current",
"versioning_enabled": true,
"working_copy": null,
"working_copy_of": null
}
Collection#
GET /plone/collection HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0
curl -i -X GET http://nohost/plone/collection -H "Accept: application/json" --user admin:secret
http http://nohost/plone/collection Accept:application/json -a admin:secret
requests.get('http://nohost/plone/collection', headers={'Accept': 'application/json'}, auth=('admin', 'secret'))
HTTP/1.1 200 OK
Content-Type: application/json
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/collection/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/collection/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/collection/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/collection/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/collection/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/collection/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/collection/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/collection/@workflow"
}
},
"@id": "http://localhost:55001/plone/collection",
"@type": "Collection",
"UID": "SomeUUID000000000000000000000002",
"allow_discussion": false,
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"customViewFields": [
{
"title": "Title",
"token": "Title"
},
{
"title": "Creator",
"token": "Creator"
},
{
"title": "Type",
"token": "Type"
},
{
"title": "Last modified",
"token": "ModificationDate"
}
],
"description": "This is a collection with two documents",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"id": "collection",
"is_folderish": false,
"item_count": 30,
"items": [
{
"@id": "http://localhost:55001/plone/front-page",
"@type": "Document",
"description": "Congratulations! You have successfully installed Plone.",
"review_state": "private",
"title": "Welcome to Plone",
"type_title": "Page"
},
{
"@id": "http://localhost:55001/plone/doc1",
"@type": "Document",
"description": "",
"review_state": "private",
"title": "Document 1",
"type_title": "Page"
},
{
"@id": "http://localhost:55001/plone/doc2",
"@type": "Document",
"description": "",
"review_state": "private",
"title": "Document 2",
"type_title": "Page"
}
],
"items_total": 3,
"language": "",
"layout": "listing_view",
"limit": 1000,
"lock": {
"locked": false,
"stealable": true
},
"modified": "1995-07-31T17:30:00+00:00",
"next_item": {},
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"query": [
{
"i": "portal_type",
"o": "plone.app.querystring.operation.string.is",
"v": "Document"
}
],
"relatedItems": [],
"review_state": "private",
"rights": "",
"sort_on": null,
"sort_reversed": null,
"subjects": [],
"text": null,
"title": "My Collection",
"type_title": "Collection",
"version": "current",
"working_copy": null,
"working_copy_of": null
}
You can also get all the data for each of the items in a collection by appending the ?fullobjects
parameter to the query:
GET /plone/collection?fullobjects HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0
curl -i -X GET 'http://nohost/plone/collection?fullobjects' -H "Accept: application/json" --user admin:secret
http 'http://nohost/plone/collection?fullobjects' Accept:application/json -a admin:secret
requests.get('http://nohost/plone/collection?fullobjects', headers={'Accept': 'application/json'}, auth=('admin', 'secret'))
HTTP/1.1 200 OK
Content-Type: application/json
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/collection/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/collection/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/collection/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/collection/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/collection/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/collection/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/collection/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/collection/@workflow"
}
},
"@id": "http://localhost:55001/plone/collection",
"@type": "Collection",
"UID": "SomeUUID000000000000000000000002",
"allow_discussion": false,
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"customViewFields": [
{
"title": "Title",
"token": "Title"
},
{
"title": "Creator",
"token": "Creator"
},
{
"title": "Type",
"token": "Type"
},
{
"title": "Last modified",
"token": "ModificationDate"
}
],
"description": "This is a collection with two documents",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"id": "collection",
"is_folderish": false,
"item_count": 30,
"items": [
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/front-page/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/front-page/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/front-page/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/front-page/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/front-page/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/front-page/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/front-page/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/front-page/@workflow"
}
},
"@id": "http://localhost:55001/plone/front-page",
"@type": "Document",
"UID": "SomeUUID000000000000000000000001",
"allow_discussion": false,
"changeNote": "",
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"description": "Congratulations! You have successfully installed Plone.",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"id": "front-page",
"is_folderish": false,
"language": "",
"layout": "document_view",
"lock": {
"locked": false,
"stealable": true
},
"modified": "1995-07-31T17:30:00+00:00",
"next_item": {},
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"relatedItems": [],
"review_state": "private",
"rights": "",
"subjects": [],
"table_of_contents": null,
"text": {
"content-type": "text/plain",
"data": "<p>If you're seeing this instead of the web site you were expecting, the owner of this web site has just installed Plone. Do not contact the Plone Team or the Plone mailing lists about this.</p>",
"encoding": "utf-8"
},
"title": "Welcome to Plone",
"type_title": "Page",
"version": "current",
"versioning_enabled": true,
"working_copy": null,
"working_copy_of": null
},
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/doc1/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/doc1/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/doc1/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/doc1/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/doc1/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/doc1/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/doc1/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/doc1/@workflow"
}
},
"@id": "http://localhost:55001/plone/doc1",
"@type": "Document",
"UID": "SomeUUID000000000000000000000003",
"allow_discussion": false,
"changeNote": "",
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"description": "",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"id": "doc1",
"is_folderish": false,
"language": "",
"layout": "document_view",
"lock": {
"locked": false,
"stealable": true
},
"modified": "1995-07-31T17:30:00+00:00",
"next_item": {},
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"relatedItems": [],
"review_state": "private",
"rights": "",
"subjects": [],
"table_of_contents": null,
"text": null,
"title": "Document 1",
"type_title": "Page",
"version": "current",
"versioning_enabled": true,
"working_copy": null,
"working_copy_of": null
},
{
"@components": {
"actions": {
"@id": "http://localhost:55001/plone/doc2/@actions"
},
"aliases": {
"@id": "http://localhost:55001/plone/doc2/@aliases"
},
"breadcrumbs": {
"@id": "http://localhost:55001/plone/doc2/@breadcrumbs"
},
"contextnavigation": {
"@id": "http://localhost:55001/plone/doc2/@contextnavigation"
},
"navigation": {
"@id": "http://localhost:55001/plone/doc2/@navigation"
},
"navroot": {
"@id": "http://localhost:55001/plone/doc2/@navroot"
},
"types": {
"@id": "http://localhost:55001/plone/doc2/@types"
},
"workflow": {
"@id": "http://localhost:55001/plone/doc2/@workflow"
}
},
"@id": "http://localhost:55001/plone/doc2",
"@type": "Document",
"UID": "SomeUUID000000000000000000000004",
"allow_discussion": false,
"changeNote": "",
"contributors": [],
"created": "1995-07-31T13:45:00+00:00",
"creators": [
"test_user_1_"
],
"description": "",
"effective": null,
"exclude_from_nav": false,
"expires": null,
"id": "doc2",
"is_folderish": false,
"language": "",
"layout": "document_view",
"lock": {
"locked": false,
"stealable": true
},
"modified": "1995-07-31T17:30:00+00:00",
"next_item": {},
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"relatedItems": [],
"review_state": "private",
"rights": "",
"subjects": [],
"table_of_contents": null,
"text": null,
"title": "Document 2",
"type_title": "Page",
"version": "current",
"versioning_enabled": true,
"working_copy": null,
"working_copy_of": null
}
],
"items_total": 3,
"language": "",
"layout": "listing_view",
"limit": 1000,
"lock": {
"locked": false,
"stealable": true
},
"modified": "1995-07-31T17:30:00+00:00",
"next_item": {},
"parent": {
"@id": "http://localhost:55001/plone",
"@type": "Plone Site",
"description": "",
"title": "Plone site",
"type_title": "Plone Site"
},
"previous_item": {},
"query": [
{
"i": "portal_type",
"o": "plone.app.querystring.operation.string.is",
"v": "Document"
}
],
"relatedItems": [],
"review_state": "private",
"rights": "",
"sort_on": null,
"sort_reversed": null,
"subjects": [],
"text": null,
"title": "My Collection",
"type_title": "Collection",
"version": "current",
"working_copy": null,
"working_copy_of": null
}