Root resources

List of root resources

GET /

Lists the root resources of the eZ Platform installation.

Header parameters

Accept

If set, the list is return in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Root+xml application/vnd.ez.api.Root+json
Possible responses
Code Description
200

Types
Type Description
Root This class represents a root.

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Root media-type="application/vnd.ez.api.Root+xml">
    <content media-type="" href="/api/ezp/v2/content/objects"/>
    <contentByRemoteId media-type="" href="/api/ezp/v2/content/objects{?remoteId}"/>
    <contentTypes media-type="application/vnd.ez.api.ContentTypeInfoList+xml" href="/api/ezp/v2/content/types"/>
    <contentTypeByIdentifier media-type="" href="/api/ezp/v2/content/types{?identifier}"/>
    <contentTypeGroups media-type="application/vnd.ez.api.ContentTypeGroupList+xml" href="/api/ezp/v2/content/typegroups"/>
    <contentTypeGroupByIdentifier media-type="" href="/api/ezp/v2/content/typegroups{?identifier}"/>
    <users media-type="application/vnd.ez.api.UserRefList+xml" href="/api/ezp/v2/user/users"/>
    <roles media-type="application/vnd.ez.api.RoleList+xml" href="/api/ezp/v2/user/roles"/>
    <rootLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2"/>
    <rootUserGroup media-type="application/vnd.ez.api.UserGroup+xml" href="/api/ezp/v2/user/groups/1/5"/>
    <rootMediaFolder media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/43"/>
    <locationByRemoteId media-type="" href="/api/ezp/v2/content/locations{?remoteId}"/>
    <locationByPath media-type="" href="/api/ezp/v2/content/locations{?locationPath}"/>
    <trash media-type="application/vnd.ez.api.Trash+xml" href="/api/ezp/v2/content/trash"/>
    <sections media-type="application/vnd.ez.api.SectionList+xml" href="/api/ezp/v2/content/sections"/>
    <views media-type="application/vnd.ez.api.RefList+xml" href="/api/ezp/v2/views"/>
    <objectStateGroups media-type="application/vnd.ez.api.ObjectStateGroupList+xml" href="/api/ezp/v2/content/objectstategroups"/>
    <objectStates media-type="application/vnd.ez.api.ObjectStateList+xml" href="/api/ezp/v2/content/objectstategroups/{objectStateGroupId}/objectstates"/>
    <globalUrlAliases media-type="application/vnd.ez.api.UrlAliasRefList+xml" href="/api/ezp/v2/content/urlaliases"/>
    <urlWildcards media-type="application/vnd.ez.api.UrlWildcardList+xml" href="/api/ezp/v2/content/urlwildcards"/>
    <createSession media-type="application/vnd.ez.api.UserSession+xml" href="/api/ezp/v2/user/sessions"/>
    <refreshSession media-type="application/vnd.ez.api.UserSession+xml" href="/api/ezp/v2/user/sessions/{sessionId}/refresh"/>
</Root>

                                        

file_copy

                                        {
    "Root": {
        "_media-type": "application/vnd.ez.api.Root+json",
        "content": {
            "_href": "/api/ezp/v2/content/objects",
            "_media-type": ""
        },
        "contentByRemoteId": {
            "_href": "/api/ezp/v2/content/objects{?remoteId}",
            "_media-type": ""
        },
        "contentTypeByIdentifier": {
            "_href": "/api/ezp/v2/content/types{?identifier}",
            "_media-type": ""
        },
        "contentTypeGroupByIdentifier": {
            "_href": "/api/ezp/v2/content/typegroups{?identifier}",
            "_media-type": ""
        },
        "contentTypeGroups": {
            "_href": "/api/ezp/v2/content/typegroups",
            "_media-type": "application/vnd.ez.api.ContentTypeGroupList+json"
        },
        "contentTypes": {
            "_href": "/api/ezp/v2/content/types",
            "_media-type": "application/vnd.ez.api.ContentTypeInfoList+json"
        },
        "createSession": {
            "_href": "/api/ezp/v2/user/sessions",
            "_media-type": "application/vnd.ez.api.UserSession+json"
        },
        "globalUrlAliases": {
            "_href": "/api/ezp/v2/content/urlaliases",
            "_media-type": "application/vnd.ez.api.UrlAliasRefList+json"
        },
        "locationByPath": {
            "_href": "/api/ezp/v2/content/locations{?locationPath}",
            "_media-type": ""
        },
        "locationByRemoteId": {
            "_href": "/api/ezp/v2/content/locations{?remoteId}",
            "_media-type": ""
        },
        "objectStateGroups": {
            "_href": "/api/ezp/v2/content/objectstategroups",
            "_media-type": "application/vnd.ez.api.ObjectStateGroupList+json"
        },
        "objectStates": {
            "_href": "/api/ezp/v2/content/objectstategroups/{objectStateGroupId}/objectstates",
            "_media-type": "application/vnd.ez.api.ObjectStateList+json"
        },
        "roles": {
            "_href": "/api/ezp/v2/user/roles",
            "_media-type": "application/vnd.ez.api.RoleList+json"
        },
        "rootLocation": {
            "_href": "/api/ezp/v2/content/locations/1/2",
            "_media-type": "application/vnd.ez.api.Location+json"
        },
        "rootMediaFolder": {
            "_href": "/api/ezp/v2/content/locations/1/43",
            "_media-type": "application/vnd.ez.api.Location+json"
        },
        "rootUserGroup": {
            "_href": "/api/ezp/v2/user/groups/1/5",
            "_media-type": "application/vnd.ez.api.UserGroup+json"
        },
        "sections": {
            "_href": "/api/ezp/v2/content/sections",
            "_media-type": "application/vnd.ez.api.SectionList+json"
        },
        "trash": {
            "_href": "/api/ezp/v2/content/trash",
            "_media-type": "application/vnd.ez.api.Trash+json"
        },
        "urlWildcards": {
            "_href": "/api/ezp/v2/content/urlwildcards",
            "_media-type": "application/vnd.ez.api.UrlWildcardList+json"
        },
        "users": {
            "_href": "/api/ezp/v2/user/users",
            "_media-type": "application/vnd.ez.api.UserRefList+json"
        },
        "views": {
            "_href": "/api/ezp/v2/views",
            "_media-type": "application/vnd.ez.api.RefList+json"
        },
        "refreshSession": {
            "_media-type": "application\/vnd.ez.api.UserSession+json",
            "_href": "\/api\/ezp\/v2\/user\/sessions\/{sessionId}\/refresh"
        }
    }
}

                                        

Managing bookmarks

/bookmark

List of bookmarks

GET /bookmark

Lists bookmarked Locations for the current user.

Header parameters

Accept

If set, the list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.BookmarkList+xml application/vnd.ez.api.BookmarkList+json
Query parameters
Property Type Value
offset integer The offset of the result set.
limit integer The number of returned bookmarks.
Possible responses
Code Description
200

401

Error - the user is not authorized to list bookmarks.

Types
Type Description
BookmarkList List of bookmarked Locations.

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<BookmarkList media-type="application/vnd.ez.api.BookmarkList+xml">
    <count>3</count>
    <Bookmark media-type="application/vnd.ez.api.Bookmark+xml" _href="/api/ezp/v2/bookmark/62">
        <Location media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2/62">
            <id>62</id>
            <priority>0</priority>
            <hidden>false</hidden>
            <invisible>false</invisible>
            <ParentLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2"/>
            <pathString>/1/2/62/</pathString>
            <depth>2</depth>
            <childCount>0</childCount>
            <remoteId>5f1bb9f8ea33374082372d6970eccc4b</remoteId>
            <Children media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/locations/1/2/62/children"/>
            <Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/61"/>
            <sortField>NAME</sortField>
            <sortOrder>ASC</sortOrder>
            <UrlAliases media-type="application/vnd.ez.api.UrlAliasRefList+xml" href="/api/ezp/v2/content/locations/1/2/62/urlaliases"/>
            <ContentInfo media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61">
                <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61" remoteId="2c90ebb85a849a377a8df1ba775dbba4" id="61">
                    <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2"/>
                    <Name>777</Name>
                    <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/61/versions"/>
                    <CurrentVersion media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/61/currentversion"/>
                    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/1"/>
                    <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/61/locations"/>
                    <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
                    <lastModificationDate>2018-11-09T14:50:16+01:00</lastModificationDate>
                    <publishedDate>2018-11-09T14:50:16+01:00</publishedDate>
                    <mainLanguageCode>eng-GB</mainLanguageCode>
                    <currentVersionNo>1</currentVersionNo>
                    <alwaysAvailable>false</alwaysAvailable>
                    <ObjectStates media-type="application/vnd.ez.api.ContentObjectStates+xml" href="/api/ezp/v2/content/objects/61/objectstates"/>
                </Content>
            </ContentInfo>
        </Location>
    </Bookmark>
    <Bookmark media-type="application/vnd.ez.api.Bookmark+xml" _href="/api/ezp/v2/bookmark/60">
        <Location media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2/60">
            <id>60</id>
            <priority>0</priority>
            <hidden>false</hidden>
            <invisible>false</invisible>
            <ParentLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2"/>
            <pathString>/1/2/60/</pathString>
            <depth>2</depth>
            <childCount>0</childCount>
            <remoteId>bcbb52b6384679f75c80123868ce9374</remoteId>
            <Children media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/locations/1/2/60/children"/>
            <Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/59"/>
            <sortField>NAME</sortField>
            <sortOrder>ASC</sortOrder>
            <UrlAliases media-type="application/vnd.ez.api.UrlAliasRefList+xml" href="/api/ezp/v2/content/locations/1/2/60/urlaliases"/>
            <ContentInfo media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/59">
                <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/59" remoteId="4b63356b7fe92db9c39f64c37baa53d3" id="59">
                    <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2"/>
                    <Name>555</Name>
                    <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/59/versions"/>
                    <CurrentVersion media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/59/currentversion"/>
                    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/1"/>
                    <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/59/locations"/>
                    <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
                    <lastModificationDate>2018-11-09T14:48:58+01:00</lastModificationDate>
                    <publishedDate>2018-11-09T14:48:58+01:00</publishedDate>
                    <mainLanguageCode>eng-GB</mainLanguageCode>
                    <currentVersionNo>1</currentVersionNo>
                    <alwaysAvailable>false</alwaysAvailable>
                    <ObjectStates media-type="application/vnd.ez.api.ContentObjectStates+xml" href="/api/ezp/v2/content/objects/59/objectstates"/>
                </Content>
            </ContentInfo>
        </Location>
    </Bookmark>
    <Bookmark media-type="application/vnd.ez.api.Bookmark+xml" _href="/api/ezp/v2/bookmark/56">
        <Location media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2/56">
            <id>56</id>
            <priority>0</priority>
            <hidden>false</hidden>
            <invisible>false</invisible>
            <ParentLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2"/>
            <pathString>/1/2/56/</pathString>
            <depth>2</depth>
            <childCount>0</childCount>
            <remoteId>4e83abdb00439c7383517126ea656631</remoteId>
            <Children media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/locations/1/2/56/children"/>
            <Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/55"/>
            <sortField>NAME</sortField>
            <sortOrder>ASC</sortOrder>
            <UrlAliases media-type="application/vnd.ez.api.UrlAliasRefList+xml" href="/api/ezp/v2/content/locations/1/2/56/urlaliases"/>
            <ContentInfo media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/55">
                <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/55" remoteId="02c379510a48965f8253af461079b7fe" id="55">
                    <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2"/>
                    <Name>111</Name>
                    <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/55/versions"/>
                    <CurrentVersion media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/55/currentversion"/>
                    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/1"/>
                    <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/55/locations"/>
                    <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
                    <lastModificationDate>2018-11-08T12:03:34+01:00</lastModificationDate>
                    <publishedDate>2018-11-08T12:03:34+01:00</publishedDate>
                    <mainLanguageCode>eng-GB</mainLanguageCode>
                    <currentVersionNo>1</currentVersionNo>
                    <alwaysAvailable>false</alwaysAvailable>
                    <ObjectStates media-type="application/vnd.ez.api.ContentObjectStates+xml" href="/api/ezp/v2/content/objects/55/objectstates"/>
                </Content>
            </ContentInfo>
        </Location>
    </Bookmark>
</BookmarkList>

                                        

file_copy

                                        {
    "BookmarkList": {
        "_media-type": "application/vnd.ez.api.BookmarkList+json",
        "count": 1,
        "items": [
            {
                "_media-type": "application/vnd.ez.api.Bookmark+json",
                "__href": "/api/ezp/v2/bookmark/2",
                "Location": {
                    "_media-type": "application/vnd.ez.api.Location+json",
                    "_href": "/api/ezp/v2/content/locations/1/2",
                    "id": 2,
                    "priority": 0,
                    "hidden": false,
                    "invisible": false,
                    "ParentLocation": {
                        "_media-type": "application/vnd.ez.api.Location+json",
                        "_href": "/api/ezp/v2/content/locations/1"
                    },
                    "pathString": "/1/2/",
                    "depth": 1,
                    "childCount": 4,
                    "remoteId": "f3e90596361e31d496d4026eb624c983",
                    "Children": {
                        "_media-type": "application/vnd.ez.api.LocationList+json",
                        "_href": "/api/ezp/v2/content/locations/1/2/children"
                    },
                    "Content": {
                        "_media-type": "application/vnd.ez.api.Content+json",
                        "_href": "/api/ezp/v2/content/objects/1"
                    },
                    "sortField": "PRIORITY",
                    "sortOrder": "ASC",
                    "UrlAliases": {
                        "_media-type": "application/vnd.ez.api.UrlAliasRefList+json",
                        "_href": "/api/ezp/v2/content/locations/1/2/urlaliases"
                    },
                    "ContentInfo": {
                        "_media-type": "application/vnd.ez.api.ContentInfo+json",
                        "_href": "/api/ezp/v2/content/objects/1",
                        "Content": {
                            "_media-type": "application/vnd.ez.api.ContentInfo+json",
                            "_href": "/api/ezp/v2/content/objects/1",
                            "_remoteId": "9459d3c29e15006e45197295722c7ade",
                            "_id": 1,
                            "ContentType": {
                                "_media-type": "application/vnd.ez.api.ContentType+json",
                                "_href": "/api/ezp/v2/content/types/1"
                            },
                            "Name": "eZ Platform",
                            "Versions": {
                                "_media-type": "application/vnd.ez.api.VersionList+json",
                                "_href": "/api/ezp/v2/content/objects/1/versions"
                            },
                            "CurrentVersion": {
                                "_media-type": "application/vnd.ez.api.Version+json",
                                "_href": "/api/ezp/v2/content/objects/1/currentversion"
                            },
                            "Section": {
                                "_media-type": "application/vnd.ez.api.Section+json",
                                "_href": "/api/ezp/v2/content/sections/1"
                            },
                            "Locations": {
                                "_media-type": "application/vnd.ez.api.LocationList+json",
                                "_href": "/api/ezp/v2/content/objects/1/locations"
                            },
                            "Owner": {
                                "_media-type": "application/vnd.ez.api.User+json",
                                "_href": "/api/ezp/v2/user/users/14"
                            },
                            "lastModificationDate": "2015-11-30T13:10:46+00:00",
                            "publishedDate": "2015-11-30T13:10:46+00:00",
                            "mainLanguageCode": "eng-GB",
                            "currentVersionNo": 9,
                            "alwaysAvailable": true,
                            "ObjectStates": {
                                "_media-type": "application/vnd.ez.api.ContentObjectStates+json",
                                "_href": "/api/ezp/v2/content/objects/1/objectstates"
                            }
                        }
                    }
                }
            }
        ]
    }
}

                                        

/bookmark/{locationId}

Create bookmark

POST /bookmark/{locationId}

Add given Location to bookmarks of the current user.

Possible responses
Code Description
201

Created.

401

Error - the user is not authorized to given Location.

404

Error - the given Location does not exist.

409

Error - Location is already bookmarked.

Check if Location is bookmarked

HEAD /bookmark/{locationId}

Checks if the given Location is bookmarked by the current user.

Possible responses
Code Description
200

OK - bookmarked.

401

Error - the user is not authorized for the given Location.

404

Error - the given Location does not exist / is not bookmarked.

Delete bookmark

DELETE /bookmark/{locationId}

Deletes the given Location from bookmarks of the current user.

Possible responses
Code Description
204

Deleted - no content.

401

Error - the user is not authorized for the given Location.

404

Error - the given Location does not exist / is not bookmarked.

Managing content

/content/objects

/content/objects

Create Content item

POST /content/objects

Creates a draft assigned to the authenticated user. If a different user ID is given in the input, the draft is assigned to the given user but this action requires special permissions for the authenticated user (this is useful for content staging where the transfer process does not have to authenticate with the user who created the Content item in the source server). The user needs to publish the Content item if it should be visible.

Header parameters

Accept

Content - If set, all information for the Content item including the embedded current version is returned in XML or JSON format. ContentInfo - If set, all information for the Content item (excluding the current version) is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Content+xml application/vnd.ez.api.Content+json application/vnd.ez.api.ContentInfo+xml application/vnd.ez.api.ContentInfo+json

Content-Type

The ContentCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentCreate+xml application/vnd.ez.api.ContentCreate+json
Possible responses
Code Description
201

400

Error - the input does not match the input schema definition or the validation on a field fails.

401

Error - the user is not authorized to create this Object in this Location.

404

Error - the parent Location specified in the request body does not exist.

Types
Type Description
ContentCreate This class is used for creating a new Content item.
Content Content ID matcher class.
ContentInfo This class provides all version independent information of the Content item.
Request
Media type application/vnd.ez.api.ContentCreate+xml
Schema ContentCreate * : ContentCreate
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/83" remoteId="a9c8f00b1dba880df7a5ed3e93fad421" id="83">
    <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2"/>
    <Name>draft article</Name>
    <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/83/versions"/>
    <CurrentVersion media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/83/currentversion">
        <Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/83/versions/1">
            <VersionInfo>
                <id>547</id>
                <versionNo>1</versionNo>
                <status>DRAFT</status>
                <modificationDate>2019-02-19T15:55:37+01:00</modificationDate>
                <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
                <creationDate>2019-02-19T15:55:37+01:00</creationDate>
                <initialLanguageCode>eng-GB</initialLanguageCode>
                <languageCodes>eng-GB</languageCodes>
                <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
                    <Language>
                        <languageCode>eng-GB</languageCode>
                    </Language>
                </VersionTranslationInfo>
                <names>
                    <value languageCode="eng-GB">draft article</value>
                </names>
                <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/83"/>
            </VersionInfo>
            <Fields>
                <field>
                    <id>446</id>
                    <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
                    <fieldValue>draft article</fieldValue>
                </field>
                <field>
                    <id>447</id>
                    <fieldDefinitionIdentifier>short_title</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
                    <fieldValue/>
                </field>
                <field>
                    <id>448</id>
                    <fieldDefinitionIdentifier>author</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezauthor</fieldTypeIdentifier>
                    <fieldValue/>
                </field>
                <field>
                    <id>449</id>
                    <fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
                    <fieldValue>
                        <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:ezxhtml=&quot;http://ez.no/xmlns/ezpublish/docbook/xhtml&quot; xmlns:ezcustom=&quot;http://ez.no/xmlns/ezpublish/docbook/custom&quot; version=&quot;5.0-variant ezpublish-1.0&quot;&gt;&lt;para&gt;draft draft&lt;/para&gt;&lt;/section&gt;
</value>
                        <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;&gt;&lt;p&gt;draft draft&lt;/p&gt;&lt;/section&gt;
</value>
                    </fieldValue>
                </field>
                <field>
                    <id>450</id>
                    <fieldDefinitionIdentifier>body</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
                    <fieldValue>
                        <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:ezxhtml=&quot;http://ez.no/xmlns/ezpublish/docbook/xhtml&quot; xmlns:ezcustom=&quot;http://ez.no/xmlns/ezpublish/docbook/custom&quot; version=&quot;5.0-variant ezpublish-1.0&quot;&gt;&lt;para&gt;draft draft draft &lt;/para&gt;&lt;/section&gt;
</value>
                        <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;&gt;&lt;p&gt;draft draft draft &lt;/p&gt;&lt;/section&gt;
</value>
                    </fieldValue>
                </field>
                <field>
                    <id>451</id>
                    <fieldDefinitionIdentifier>enable_comments</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezboolean</fieldTypeIdentifier>
                    <fieldValue>false</fieldValue>
                </field>
                <field>
                    <id>452</id>
                    <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezobjectrelation</fieldTypeIdentifier>
                    <fieldValue>
                        <value key="destinationContentId"/>
                    </fieldValue>
                </field>
            </Fields>
            <Relations media-type="application/vnd.ez.api.RelationList+xml" href="/api/ezp/v2/content/objects/83/versions/1/relations"/>
        </Version>
    </CurrentVersion>
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/1"/>
    <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/83/locations"/>
    <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <mainLanguageCode>eng-GB</mainLanguageCode>
    <currentVersionNo>1</currentVersionNo>
    <alwaysAvailable>true</alwaysAvailable>
    <ObjectStates media-type="application/vnd.ez.api.ContentObjectStates+xml" href="/api/ezp/v2/content/objects/83/objectstates"/>
</Content>

                                        
Load content by remote ID

GET /content/objects

Loads Content item for a given remote ID.

Query parameters
Property Type Value
remoteId string The remote ID of the Content item. If present, the Content item with the given remote ID is returned.
Possible responses
Code Description
307

Temporary redirect.

404

Error - the content with the given remote ID does not exist.

/content/objects/{contentId}

Load content

GET /content/objects/{contentId}

Loads the Content item for the given ID. Depending on the Accept header the current version is embedded (i.e. the current published version or if it does not exist, the draft of the authenticated user).

Header parameters

Accept

Content - If set, all information for the Content item including the embedded current version is returned in XML or JSON format. ContentInfo - If set, all information for the Content item (excluding the current version) is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Content+xml application/vnd.ez.api.Content+json application/vnd.ez.api.ContentInfo+xml application/vnd.ez.api.ContentInfo+json

If-None-Match

If the provided ETag matches the current ETag then a "304 Not Modified" is returned. The ETag changes if the meta data has changed, this happens also if there is a new published version.

Property Value
Type string
Examples ETag
Query parameters
Property Type Value
languages string Restricts the output of translatable fields to the given languages. Comma separated list.
Possible responses
Code Description
200

401

Error - the user is not authorized to read this object. This could also happen if there is no published version yet and another user owns a draft of this Content item.

404

Error - the ID is not found.

Types
Type Description
Content Content ID matcher class.
ContentInfo This class provides all version independent information of the Content item.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/54" remoteId="d2b6b7f5d0935c45456a80d3a154f2e7" id="54">
    <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2"/>
    <Name>test</Name>
    <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/54/versions"/>
    <CurrentVersion media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/54/currentversion">
        <Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/54/versions/1">
            <VersionInfo>
                <id>515</id>
                <versionNo>1</versionNo>
                <status>PUBLISHED</status>
                <modificationDate>2018-09-27T13:31:25+02:00</modificationDate>
                <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
                <creationDate>2018-09-27T13:31:24+02:00</creationDate>
                <initialLanguageCode>eng-GB</initialLanguageCode>
                <languageCodes>eng-GB</languageCodes>
                <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
                    <Language>
                        <languageCode>eng-GB</languageCode>
                    </Language>
                </VersionTranslationInfo>
                <names>
                    <value languageCode="eng-GB">test</value>
                </names>
                <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/54"/>
            </VersionInfo>
            <Fields>
                <field>
                    <id>249</id>
                    <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
                    <fieldValue>test</fieldValue>
                </field>
                <field>
                    <id>250</id>
                    <fieldDefinitionIdentifier>short_title</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
                    <fieldValue>test</fieldValue>
                </field>
                <field>
                    <id>251</id>
                    <fieldDefinitionIdentifier>author</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezauthor</fieldTypeIdentifier>
                    <fieldValue>
                        <value>
                            <value key="id">1</value>
                            <value key="name">Administrator User</value>
                            <value key="email">nospam@ez.no</value>
                        </value>
                    </fieldValue>
                </field>
                <field>
                    <id>252</id>
                    <fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
                    <fieldValue>
                        <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:ezxhtml=&quot;http://ez.no/xmlns/ezpublish/docbook/xhtml&quot; xmlns:ezcustom=&quot;http://ez.no/xmlns/ezpublish/docbook/custom&quot; version=&quot;5.0-variant ezpublish-1.0&quot;&gt;&lt;para&gt;Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.&lt;/para&gt;&lt;/section&gt;
</value>
                        <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;&gt;&lt;p&gt;Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.&lt;/p&gt;&lt;/section&gt;
</value>
                    </fieldValue>
                </field>
                <field>
                    <id>253</id>
                    <fieldDefinitionIdentifier>body</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
                    <fieldValue>
                        <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; version=&quot;5.0-variant ezpublish-1.0&quot;/&gt;
</value>
                        <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;/&gt;
</value>
                    </fieldValue>
                </field>
                <field>
                    <id>254</id>
                    <fieldDefinitionIdentifier>enable_comments</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezboolean</fieldTypeIdentifier>
                    <fieldValue>false</fieldValue>
                </field>
                <field>
                    <id>255</id>
                    <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>
                    <languageCode>eng-GB</languageCode>
                    <fieldTypeIdentifier>ezobjectrelation</fieldTypeIdentifier>
                    <fieldValue>
                        <value key="destinationContentId"/>
                    </fieldValue>
                </field>
            </Fields>
            <Relations media-type="application/vnd.ez.api.RelationList+xml" href="/api/ezp/v2/content/objects/54/versions/1/relations"/>
        </Version>
    </CurrentVersion>
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/1"/>
    <MainLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2/55"/>
    <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/54/locations"/>
    <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <lastModificationDate>2018-09-27T13:31:25+02:00</lastModificationDate>
    <publishedDate>2018-09-27T13:31:25+02:00</publishedDate>
    <mainLanguageCode>eng-GB</mainLanguageCode>
    <currentVersionNo>1</currentVersionNo>
    <alwaysAvailable>false</alwaysAvailable>
    <ObjectStates media-type="application/vnd.ez.api.ContentObjectStates+xml" href="/api/ezp/v2/content/objects/54/objectstates"/>
</Content>

                                        
Update content

PATCH /content/objects/{contentId}

This method updates the content metadata which is independent from a version. PATCH or POST with header X-HTTP-Method-Override PATCH.

Header parameters

Accept

If set, all information for the Content item (excluding the current version) is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentInfo+xml application/vnd.ez.api.ContentInfo+json

If-match

Causes to patch only if the specified ETag is the current one. Otherwise a 412 is returned.

Property Value
Type string
Examples ETag

Content-Type

The ContentUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentUpdate+xml application/vnd.ez.api.ContentUpdate+json
Possible responses
Code Description
200

400

Error - the input does not match the input schema definition.

401

Error - the user is not authorized to update this object.

404

Error - the content ID does not exist.

412

Error - the current ETag does not match with the one provided in the If-Match header.

415

Error - the media-type is not one of those specified in headers.

Types
Type Description
ContentInfo This class provides all version independent information of the Content item.
Request
Media type application/vnd.ez.api.ContentUpdate+xml
Schema ContentInfo * : ContentInfo
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/80" remoteId="69848aeb86164c35e5c98202eebe9e05" id="80">
    <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2"/>
    <Name>article1</Name>
    <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/80/versions"/>
    <CurrentVersion media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/80/currentversion"/>
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/1"/>
    <MainLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2/63/66"/>
    <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/80/locations"/>
    <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/11"/>
    <lastModificationDate>2019-02-19T15:00:34+01:00</lastModificationDate>
    <publishedDate>2019-02-19T15:00:34+01:00</publishedDate>
    <mainLanguageCode>eng-GB</mainLanguageCode>
    <currentVersionNo>1</currentVersionNo>
    <alwaysAvailable>false</alwaysAvailable>
    <ObjectStates media-type="application/vnd.ez.api.ContentObjectStates+xml" href="/api/ezp/v2/content/objects/80/objectstates"/>
</Content>

                                        
Delete Content

DELETE /content/objects/{contentId}

Deletes Content item. If Content item has multiple Locations, all of them will be deleted via delete a subtree.

Possible responses
Code Description
204

The Content item is deleted.

404

Error - Content item was not found.

401

Error - the user is not authorized to delete this Content item.

Copy content

COPY /content/objects/{contentId}

Creates new Content item as a copy, under the given parent Location given in the destination header. COPY or POST with header X-HTTP-Method-Override COPY.

Header parameters

destination

A Location resource to which the Content item should be copied.

Property Value
Type string
Possible responses
Code Description
201

Copy created.

401

Error - the user is not authorized to copy this Content item to the given Location.

404

Error - the source or destination resource does not exist.

/content/objects/{contentId}/translations/{languageCode}

Delete translation (permanently)

DELETE /content/objects/{contentId}/translations/{languageCode}

Permanently deletes a translation from all versions of a Content item.

Possible responses
Code Description
204

No Content

401

Error - the user is not authorized to delete Content item (content/remove policy).

404

Error - the Content item was not found.

406

Error - the given translation does not exist for the Content item.

409

Error - the specified translation is the only one any version has or is the main translation.

/content/objects/{contentId}/currentversion

Get current version

GET /content/objects/{contentId}/currentversion

Redirects to the current version of the Content item.

Possible responses
Code Description
200

307

Temporary redirect.

404

Error - the resource does not exist.

Types
Type Description
Version Returns the VersionInfo for this version.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/61/versions/4">
    <VersionInfo>
        <id>551</id>
        <versionNo>4</versionNo>
        <status>PUBLISHED</status>
        <modificationDate>2019-02-20T11:32:12+01:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <creationDate>2019-02-20T11:32:06+01:00</creationDate>
        <initialLanguageCode>eng-GB</initialLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
            <Language>
                <languageCode>eng-GB</languageCode>
            </Language>
        </VersionTranslationInfo>
        <names>
            <value languageCode="eng-GB">7777</value>
        </names>
        <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61"/>
    </VersionInfo>
    <Fields>
        <field>
            <id>298</id>
            <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
            <fieldValue>New article 7</fieldValue>
        </field>
        <field>
            <id>299</id>
            <fieldDefinitionIdentifier>short_title</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
            <fieldValue>7777</fieldValue>
        </field>
        <field>
            <id>300</id>
            <fieldDefinitionIdentifier>author</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezauthor</fieldTypeIdentifier>
            <fieldValue>
                <value>
                    <value key="id">1</value>
                    <value key="name">7777</value>
                    <value key="email"></value>
                </value>
            </fieldValue>
        </field>
        <field>
            <id>301</id>
            <fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
            <fieldValue>
                <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:ezxhtml=&quot;http://ez.no/xmlns/ezpublish/docbook/xhtml&quot; xmlns:ezcustom=&quot;http://ez.no/xmlns/ezpublish/docbook/custom&quot; version=&quot;5.0-variant ezpublish-1.0&quot;&gt;&lt;para&gt;777777777777788880000&lt;/para&gt;&lt;/section&gt;
</value>
                <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;&gt;&lt;p&gt;777777777777788880000&lt;/p&gt;&lt;/section&gt;
</value>
            </fieldValue>
        </field>
        <field>
            <id>302</id>
            <fieldDefinitionIdentifier>body</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
            <fieldValue>
                <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:ezxhtml=&quot;http://ez.no/xmlns/ezpublish/docbook/xhtml&quot; xmlns:ezcustom=&quot;http://ez.no/xmlns/ezpublish/docbook/custom&quot; version=&quot;5.0-variant ezpublish-1.0&quot;&gt;&lt;para&gt;88888888888&lt;/para&gt;&lt;para&gt;0000&lt;/para&gt;&lt;/section&gt;
</value>
                <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;&gt;&lt;p&gt;88888888888&lt;/p&gt;&lt;p&gt;0000&lt;/p&gt;&lt;/section&gt;
</value>
            </fieldValue>
        </field>
        <field>
            <id>303</id>
            <fieldDefinitionIdentifier>enable_comments</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezboolean</fieldTypeIdentifier>
            <fieldValue>false</fieldValue>
        </field>
        <field>
            <id>304</id>
            <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezobjectrelation</fieldTypeIdentifier>
            <fieldValue>
                <value key="destinationContentId"/>
            </fieldValue>
        </field>
    </Fields>
    <Relations media-type="application/vnd.ez.api.RelationList+xml" href="/api/ezp/v2/content/objects/61/versions/4/relations"/>
</Version>

                                        
Create a draft from current version

COPY /content/objects/{contentId}/currentversion

The system creates a new draft as a copy of the current version. COPY or POST with header X-HTTP-Method-Override COPY.

Header parameters

Accept

If set, the updated version is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Version+xml application/vnd.ez.api.Version+json
Possible responses
Code Description
201

Created

401

Error - the user is not authorized to update this Content item.

403

Error - the current version is already a draft.

404

Error - the Content item was not found.

Types
Type Description
Version Returns the VersionInfo for this version.
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/61/versions/6">
    <VersionInfo>
        <id>553</id>
        <versionNo>6</versionNo>
        <status>DRAFT</status>
        <modificationDate>2019-02-20T12:35:10+01:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <creationDate>2019-02-20T12:35:10+01:00</creationDate>
        <initialLanguageCode>eng-GB</initialLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
            <Language>
                <languageCode>eng-GB</languageCode>
            </Language>
        </VersionTranslationInfo>
        <names>
            <value languageCode="eng-GB">7777</value>
        </names>
        <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61"/>
    </VersionInfo>
    <Fields>
        <field>
            <id>298</id>
            <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
            <fieldValue>New article 7</fieldValue>
        </field>
        <field>
            <id>299</id>
            <fieldDefinitionIdentifier>short_title</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
            <fieldValue>7777</fieldValue>
        </field>
        <field>
            <id>300</id>
            <fieldDefinitionIdentifier>author</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezauthor</fieldTypeIdentifier>
            <fieldValue>
                <value>
                    <value key="id">1</value>
                    <value key="name">7777</value>
                    <value key="email"></value>
                </value>
            </fieldValue>
        </field>
        <field>
            <id>301</id>
            <fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
            <fieldValue>
                <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:ezxhtml=&quot;http://ez.no/xmlns/ezpublish/docbook/xhtml&quot; xmlns:ezcustom=&quot;http://ez.no/xmlns/ezpublish/docbook/custom&quot; version=&quot;5.0-variant ezpublish-1.0&quot;&gt;&lt;para&gt;777777777777788880000&lt;/para&gt;&lt;/section&gt;
</value>
                <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;&gt;&lt;p&gt;777777777777788880000&lt;/p&gt;&lt;/section&gt;
</value>
            </fieldValue>
        </field>
        <field>
            <id>302</id>
            <fieldDefinitionIdentifier>body</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
            <fieldValue>
                <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:ezxhtml=&quot;http://ez.no/xmlns/ezpublish/docbook/xhtml&quot; xmlns:ezcustom=&quot;http://ez.no/xmlns/ezpublish/docbook/custom&quot; version=&quot;5.0-variant ezpublish-1.0&quot;&gt;&lt;para&gt;88888888888&lt;/para&gt;&lt;para&gt;0000&lt;/para&gt;&lt;/section&gt;
</value>
                <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;&gt;&lt;p&gt;88888888888&lt;/p&gt;&lt;p&gt;0000&lt;/p&gt;&lt;/section&gt;
</value>
            </fieldValue>
        </field>
        <field>
            <id>303</id>
            <fieldDefinitionIdentifier>enable_comments</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezboolean</fieldTypeIdentifier>
            <fieldValue>false</fieldValue>
        </field>
        <field>
            <id>304</id>
            <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezobjectrelation</fieldTypeIdentifier>
            <fieldValue>
                <value key="destinationContentId"/>
            </fieldValue>
        </field>
    </Fields>
    <Relations media-type="application/vnd.ez.api.RelationList+xml" href="/api/ezp/v2/content/objects/61/versions/6/relations"/>
</Version>

                                        

/content/objects/{contentId}/versions

List versions

GET /content/objects/{contentId}/versions

Returns a list of all versions of the Content item. This method does not include fields and relations in the version elements of the response.

Header parameters

Accept

If set, the version list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.VersionList+xml application/vnd.ez.api.VersionList+json
Possible responses
Code Description
200

401

Error - the user has no permission to read the versions.

Types
Type Description
VersionList List of all versions of the content.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<VersionList media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/61/versions">
    <VersionItem>
        <Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/61/versions/1"/>
        <VersionInfo>
            <id>522</id>
            <versionNo>1</versionNo>
            <status>ARCHIVED</status>
            <modificationDate>2019-02-20T11:30:15+01:00</modificationDate>
            <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
            <creationDate>2018-11-09T14:50:16+01:00</creationDate>
            <initialLanguageCode>eng-GB</initialLanguageCode>
            <languageCodes>eng-GB</languageCodes>
            <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
                <Language>
                    <languageCode>eng-GB</languageCode>
                </Language>
            </VersionTranslationInfo>
            <names>
                <value languageCode="eng-GB">777</value>
            </names>
            <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61"/>
        </VersionInfo>
    </VersionItem>
    <VersionItem>
        <Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/61/versions/2"/>
        <VersionInfo>
            <id>543</id>
            <versionNo>2</versionNo>
            <status>ARCHIVED</status>
            <modificationDate>2019-02-20T11:31:52+01:00</modificationDate>
            <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
            <creationDate>2019-02-19T14:59:15+01:00</creationDate>
            <initialLanguageCode>eng-GB</initialLanguageCode>
            <languageCodes>eng-GB</languageCodes>
            <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
                <Language>
                    <languageCode>eng-GB</languageCode>
                </Language>
            </VersionTranslationInfo>
            <names>
                <value languageCode="eng-GB">777</value>
            </names>
            <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61"/>
        </VersionInfo>
    </VersionItem>
    <VersionItem>
        <Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/61/versions/3"/>
        <VersionInfo>
            <id>550</id>
            <versionNo>3</versionNo>
            <status>ARCHIVED</status>
            <modificationDate>2019-02-20T11:32:12+01:00</modificationDate>
            <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
            <creationDate>2019-02-20T11:31:34+01:00</creationDate>
            <initialLanguageCode>eng-GB</initialLanguageCode>
            <languageCodes>eng-GB</languageCodes>
            <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
                <Language>
                    <languageCode>eng-GB</languageCode>
                </Language>
            </VersionTranslationInfo>
            <names>
                <value languageCode="eng-GB">7777</value>
            </names>
            <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61"/>
        </VersionInfo>
    </VersionItem>
    <VersionItem>
        <Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/61/versions/4"/>
        <VersionInfo>
            <id>551</id>
            <versionNo>4</versionNo>
            <status>PUBLISHED</status>
            <modificationDate>2019-02-20T11:32:12+01:00</modificationDate>
            <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
            <creationDate>2019-02-20T11:32:06+01:00</creationDate>
            <initialLanguageCode>eng-GB</initialLanguageCode>
            <languageCodes>eng-GB</languageCodes>
            <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
                <Language>
                    <languageCode>eng-GB</languageCode>
                </Language>
            </VersionTranslationInfo>
            <names>
                <value languageCode="eng-GB">7777</value>
            </names>
            <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61"/>
        </VersionInfo>
    </VersionItem>
</VersionList>

                                        

/content/objects/{contentId}/versions/{versionNo}

Load version

GET /content/objects/{contentId}/versions/{versionNo}

Loads a specific version of a Content item. This method returns Fields and relations.

Header parameters

If-None-Match

Only return the version if the given ETag is the not current one, otherwise a 304 is returned.

Property Value
Type string
Examples ETag

Accept

If set, the version list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Version+xml application/vnd.ez.api.Version+json
Query parameters
Property Type Value
fields string Fields which should be returned in the response. Comma separated list.
responseGroups string Alternative comma separated lists of predefined Field groups.
languages string Restricts the output of translatable Fields to the given languages. Comma separated list.
Possible responses
Code Description
200

304

Error - the ETag does not match the current one.

401

Error - the user is not authorized to read this Content item.

404

Error - the ID or version is not found.

Types
Type Description
Version Returns the VersionInfo for this version.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/61/versions/3">
    <VersionInfo>
        <id>550</id>
        <versionNo>3</versionNo>
        <status>ARCHIVED</status>
        <modificationDate>2019-02-20T11:32:12+01:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <creationDate>2019-02-20T11:31:34+01:00</creationDate>
        <initialLanguageCode>eng-GB</initialLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
            <Language>
                <languageCode>eng-GB</languageCode>
            </Language>
        </VersionTranslationInfo>
        <names>
            <value languageCode="eng-GB">7777</value>
        </names>
        <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61"/>
    </VersionInfo>
    <Fields>
        <field>
            <id>298</id>
            <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
            <fieldValue>New article 77</fieldValue>
        </field>
        <field>
            <id>299</id>
            <fieldDefinitionIdentifier>short_title</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
            <fieldValue>7777</fieldValue>
        </field>
        <field>
            <id>300</id>
            <fieldDefinitionIdentifier>author</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezauthor</fieldTypeIdentifier>
            <fieldValue>
                <value>
                    <value key="id">1</value>
                    <value key="name">7777</value>
                    <value key="email"></value>
                </value>
            </fieldValue>
        </field>
        <field>
            <id>301</id>
            <fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
            <fieldValue>
                <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:ezxhtml=&quot;http://ez.no/xmlns/ezpublish/docbook/xhtml&quot; xmlns:ezcustom=&quot;http://ez.no/xmlns/ezpublish/docbook/custom&quot; version=&quot;5.0-variant ezpublish-1.0&quot;&gt;&lt;para&gt;777777777777788880000&lt;/para&gt;&lt;/section&gt;
</value>
                <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;&gt;&lt;p&gt;777777777777788880000&lt;/p&gt;&lt;/section&gt;
</value>
            </fieldValue>
        </field>
        <field>
            <id>302</id>
            <fieldDefinitionIdentifier>body</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
            <fieldValue>
                <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:ezxhtml=&quot;http://ez.no/xmlns/ezpublish/docbook/xhtml&quot; xmlns:ezcustom=&quot;http://ez.no/xmlns/ezpublish/docbook/custom&quot; version=&quot;5.0-variant ezpublish-1.0&quot;&gt;&lt;para&gt;88888888888&lt;/para&gt;&lt;para&gt;0000&lt;/para&gt;&lt;/section&gt;
</value>
                <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;&gt;&lt;p&gt;88888888888&lt;/p&gt;&lt;p&gt;0000&lt;/p&gt;&lt;/section&gt;
</value>
            </fieldValue>
        </field>
        <field>
            <id>303</id>
            <fieldDefinitionIdentifier>enable_comments</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezboolean</fieldTypeIdentifier>
            <fieldValue>false</fieldValue>
        </field>
        <field>
            <id>304</id>
            <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezobjectrelation</fieldTypeIdentifier>
            <fieldValue>
                <value key="destinationContentId"/>
            </fieldValue>
        </field>
    </Fields>
    <Relations media-type="application/vnd.ez.api.RelationList+xml" href="/api/ezp/v2/content/objects/61/versions/3/relations"/>
</Version>

                                        
Update version

PATCH /content/objects/{contentId}/versions/{versionNo}

A specific draft is updated. PATCH or POST with header X-HTTP-Method-Override PATCH.

Header parameters

Accept

If set, the updated version is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Version+xml application/vnd.ez.api.Version+json

If-match

Performs the patch only if the specified ETag is the current one.

Property Value
Type string

Content-Type

The VersionUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.VersionUpdate+xml application/vnd.ez.api.VersionUpdate+json
Query parameters
Property Type Value
languages string Restricts the output of translatable Fields to the given languages. Comma separated list.
Possible responses
Code Description
200

400

Error - the input does not match the input schema definition.

401

Error - the user is not authorized to update this version.

403

Error - the version is not allowed to change - i.e. version is not a DRAFT.

404

Error - the content ID or version ID does not exist.

412

Error - the current ETag does not match with the one provided in the If-Match header.

Types
Type Description
VersionUpdate
Version Returns the VersionInfo for this version.
Request
Media type application/vnd.ez.api.VersionUpdate+xml
Schema VersionUpdate * : VersionUpdate
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Version href="/content/objects/23/versions/4" media-type="application/vnd.ez.api.Version+xml">
  <VersionInfo>
    <id>45</id>
    <versionNo>4</versionNo>
    <status>DRAFT</status>
    <modificationDate>2012-02-20T12:00:00</modificationDate>
    <Creator href="/user/users/44" media-type="application/vnd.ez.api.User+xml" />
    <creationDate>22012-02-20T12:00:00</creationDate>
    <initialLanguageCode>ger-DE</initialLanguageCode>
    <names>
      <value languageCode="ger-DE">Neuer Titel</value>
    </names>
    <Content href="/content/objects/23" media-type="application/vnd.ez.api.ContentInfo+xml" />
  </VersionInfo>
  <Fields>
    <field>
      <id>1234</id>
      <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier>
      <languageCode>ger-DE</languageCode>
      <fieldValue>Neuer Titel</fieldValue>
    </field>
    <field>
      <id>1235</id>
      <fieldDefinitionIdentifier>summary</fieldDefinitionIdentifier>
      <languageCode>ger-DE</languageCode>
      <fieldValue>Dies ist eine neuse Zusammenfassungy</fieldValue>
    </field>
    <field>
      <fieldDefinitionIdentifier>authors</fieldDefinitionIdentifier>
      <languageCode>ger-DE</languageCode>
      <fieldValue>
        <authors>
          <author name="Klaus Mustermann" email="klaus.mustermann@example.net" />
        </authors>
      </fieldValue>
    </field>
  </Fields>
  <Relations>
    <Relation href="/content/object/32/versions/2/relations/43" media-type="application/vnd.ez.api.Relation+xml">
      <SourceContent href="/content/objects/23"
        media-type="application/vnd.ez.api.ContentInfo+xml" />
      <DestinationContent href="/content/objects/45"
        media-type="application/vnd.ez.api.ContentInfo+xml" />
      <RelationType>COMMON</RelationType>
    </Relation>
  </Relations>
</Version>

                                        
Create a draft from a version

COPY /content/objects/{contentId}/versions/{versionNo}

The system creates a new draft as a copy of the given version. COPY or POST with header X-HTTP-Method-Override COPY.

Header parameters

Accept

If set, the updated version is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Version+xml application/vnd.ez.api.Version+json
Possible responses
Code Description
201

Created.

401

Error - the user is not authorized to update this Content item.

404

Error - the Content item was not found.

Types
Type Description
Version Returns the VersionInfo for this version.
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/61/versions/6">
    <VersionInfo>
        <id>555</id>
        <versionNo>6</versionNo>
        <status>DRAFT</status>
        <modificationDate>2019-02-22T14:55:11+01:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <creationDate>2019-02-22T14:55:11+01:00</creationDate>
        <initialLanguageCode>eng-GB</initialLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
            <Language>
                <languageCode>eng-GB</languageCode>
            </Language>
        </VersionTranslationInfo>
        <names>
            <value languageCode="eng-GB">777</value>
        </names>
        <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61"/>
    </VersionInfo>
    <Fields>
        <field>
            <id>298</id>
            <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
            <fieldValue>New article 7</fieldValue>
        </field>
        <field>
            <id>299</id>
            <fieldDefinitionIdentifier>short_title</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
            <fieldValue>777</fieldValue>
        </field>
        <field>
            <id>300</id>
            <fieldDefinitionIdentifier>author</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezauthor</fieldTypeIdentifier>
            <fieldValue>
                <value>
                    <value key="id">1</value>
                    <value key="name">7777</value>
                    <value key="email"></value>
                </value>
            </fieldValue>
        </field>
        <field>
            <id>301</id>
            <fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
            <fieldValue>
                <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:ezxhtml=&quot;http://ez.no/xmlns/ezpublish/docbook/xhtml&quot; xmlns:ezcustom=&quot;http://ez.no/xmlns/ezpublish/docbook/custom&quot; version=&quot;5.0-variant ezpublish-1.0&quot;&gt;&lt;para&gt;77777777777778888&lt;/para&gt;&lt;/section&gt;
</value>
                <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;&gt;&lt;p&gt;77777777777778888&lt;/p&gt;&lt;/section&gt;
</value>
            </fieldValue>
        </field>
        <field>
            <id>302</id>
            <fieldDefinitionIdentifier>body</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezrichtext</fieldTypeIdentifier>
            <fieldValue>
                <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:ezxhtml=&quot;http://ez.no/xmlns/ezpublish/docbook/xhtml&quot; xmlns:ezcustom=&quot;http://ez.no/xmlns/ezpublish/docbook/custom&quot; version=&quot;5.0-variant ezpublish-1.0&quot;&gt;&lt;para&gt;88888888888&lt;/para&gt;&lt;/section&gt;
</value>
                <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;&gt;&lt;p&gt;88888888888&lt;/p&gt;&lt;/section&gt;
</value>
            </fieldValue>
        </field>
        <field>
            <id>303</id>
            <fieldDefinitionIdentifier>enable_comments</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezboolean</fieldTypeIdentifier>
            <fieldValue>false</fieldValue>
        </field>
        <field>
            <id>304</id>
            <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezobjectrelation</fieldTypeIdentifier>
            <fieldValue>
                <value key="destinationContentId"/>
            </fieldValue>
        </field>
    </Fields>
    <Relations media-type="application/vnd.ez.api.RelationList+xml" href="/api/ezp/v2/content/objects/61/versions/6/relations"/>
</Version>

                                        
Delete content version

DELETE /content/objects/{contentId}/versions/{versionNo}

Deletes the content version.

Possible responses
Code Description
204

No Content - the version is deleted.

404

Error - the Content item or version were not found.

401

Error - the user is not authorized to delete this version.

403

Error - the version is in published state.

Publish a content version

PUBLISH /content/objects/{contentId}/versions/{versionNo}

Publishes the content version. PUBLISH or POST with header X-HTTP-Method-Override PUBLISH

Possible responses
Code Description
204

No Content - the content version is published.

401

Error - the user is not authorized to publish this version.

403

Error - the version is not a draft.

404

Error - the Content item or version were not found.

/content/objects/{contentId}/versions/{versionNo}/translations/{languageCode}

Delete translation from version draft

DELETE /content/objects/{contentId}/versions/{versionNo}/translations/{languageCode}

Removes a translation from a version draft.

Possible responses
Code Description
204

No Content - removes a translation from a version draft.

401

Error - the user is not authorized to delete this translation.

403

Error - the version is not in draft state.

404

Error - the Content item or version number were not found.

406

Error - the given translation does not exist for the version.

409

Error - the specified translation is the only one the version has or is the main translation.

/content/objects/{contentId}/versions/{versionNo}/relations

Load Relations of Content item version

GET /content/objects/{contentId}/versions/{versionNo}/relations

Loads the Relations of the given version.

Header parameters

Accept

If set, the Relation is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.RelationList+xml application/vnd.ez.api.RelationList+json
Query parameters
Property Type Value
offset integer The offset of the result set.
limit integer The number of bookmarks returned.
Possible responses
Code Description
200

401

Error - the user is not authorized to read this Content item.

404

Error - the Content item was not found.

Types
Type Description
RelationList Class representing a list of relations between content.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Relations media-type="application/vnd.ez.api.RelationList+xml" href="/api/ezp/v2/content/objects/61/versions/6/relations">
    <Relation media-type="application/vnd.ez.api.Relation+xml" href="/api/ezp/v2/content/objects/61/versions/6/relations/2">
        <SourceContent media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61"/>
        <DestinationContent media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/86"/>
        <RelationType>COMMON</RelationType>
    </Relation>
    <Relation media-type="application/vnd.ez.api.Relation+xml" href="/api/ezp/v2/content/objects/61/versions/6/relations/3">
        <SourceContent media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61"/>
        <DestinationContent media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61"/>
        <RelationType>COMMON</RelationType>
    </Relation>
</Relations>

                                        
Create new Relation

POST /content/objects/{contentId}/versions/{versionNo}/relations

Creates a new Relation of type COMMON for the given draft.

Header parameters

Accept

If set, the updated version is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Relation+xml application/vnd.ez.api.Relation+json

Content-Type

The RelationCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.RelationCreate+xml application/vnd.ez.api.RelationCreate+json
Possible responses
Code Description
201

Types
Type Description
Relation Class representing a relation between content.
Request
Media type application/vnd.ez.api.RelationCreate+xml
Schema Relation * : Relation
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Relation media-type="application/vnd.ez.api.Relation+xml" href="/api/ezp/v2/content/objects/86/versions/1/relations/1">
    <SourceContent media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/86"/>
    <DestinationContent media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/86"/>
    <RelationType>COMMON</RelationType>
</Relation>

                                        

/content/objects/{contentId}/versions/{versionNo}/relations/{relationId}

Load Relation

GET /content/objects/{contentId}/versions/{versionNo}/relations/{relationId}

Loads a Relation for the given Content item.

Header parameters

Accept

If set, the Relation is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Relation+xml application/vnd.ez.api.Relation+json
Possible responses
Code Description
200

OK - loads a Relation for the given Content item.

401

Error - the user is not authorized to read this Content item.

404

Error - the Content item with the given ID or the Relation does not exist.

Types
Type Description
Relation Class representing a relation between content.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Relation media-type="application/vnd.ez.api.Relation+xml" href="/api/ezp/v2/content/objects/86/versions/1/relations/1">
    <SourceContent media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/86"/>
    <DestinationContent media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/86"/>
    <RelationType>COMMON</RelationType>
</Relation>

                                        
Delete Relation

DELETE /content/objects/{contentId}/versions/{versionNo}/relations/{relationId}

Deletes a Relation of the given draft.

Possible responses
Code Description
204

No Content - deleted a Relation of the given draft.

401

Error - the user is not authorized to delete this Relation.

403

Error - the Relation is not of type COMMON or the given version is not a draft.

404

Error - Content item or the Relation were not found in the given version.

/content/objects/{contentId}/relations

Load Relations of Content item

GET /content/objects/{contentId}/relations

Redirects to the Relations of the current version.

Possible responses
Code Description
307

Temporary redirect.

401

Error - the user is not authorized to read this Content item.

404

Error - the Content item was not found.

/content/objects/{contentId}/locations

Create new Location for Content item

POST /content/objects/{contentId}/locations

Creates a new Location for the given Content item.

Header parameters

Accept

If set, the new Location is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Location+xml application/vnd.ez.api.Location+json

Content-Type

The LocationCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.LocationCreate+json application/vnd.ez.api.LocationCreate+xml
Possible responses
Code Description
201

400

Error - the input does not match the input schema definition.

401

Error - the user is not authorized to create this Location.

403

Error - a Location under the given parent ID already exists.

Types
Type Description
LocationCreate
Location This class represents a Location in the Repository.
Request
Media type application/vnd.ez.api.LocationCreate+xml
Schema LocationCreate * : LocationCreate
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Location media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2/42/69">
    <id>69</id>
    <priority>0</priority>
    <hidden>false</hidden>
    <invisible>false</invisible>
    <ParentLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2/42"/>
    <pathString>/1/2/42/69/</pathString>
    <depth>3</depth>
    <childCount>0</childCount>
    <remoteId>0e8d6b87fe3b1588533b636a8549cc0c</remoteId>
    <Children media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/locations/1/2/42/69/children"/>
    <Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/61"/>
    <sortField>PATH</sortField>
    <sortOrder>ASC</sortOrder>
    <UrlAliases media-type="application/vnd.ez.api.UrlAliasRefList+xml" href="/api/ezp/v2/content/locations/1/2/42/69/urlaliases"/>
    <ContentInfo media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61">
        <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/61" remoteId="2c90ebb85a849a377a8df1ba775dbba4" id="61">
            <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2"/>
            <Name>7777</Name>
            <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/61/versions"/>
            <CurrentVersion media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/61/currentversion"/>
            <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/1"/>
            <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/61/locations"/>
            <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
            <lastModificationDate>2019-02-22T15:01:46+01:00</lastModificationDate>
            <publishedDate>2018-11-09T14:50:16+01:00</publishedDate>
            <mainLanguageCode>eng-GB</mainLanguageCode>
            <currentVersionNo>5</currentVersionNo>
            <alwaysAvailable>false</alwaysAvailable>
            <ObjectStates media-type="application/vnd.ez.api.ContentObjectStates+xml" href="/api/ezp/v2/content/objects/61/objectstates"/>
        </Content>
    </ContentInfo>
</Location>

                                        
Get Locations for Content item

GET /content/objects/{contentId}/locations

Loads all Locations for the given Content item.

Header parameters

Accept

If set, the Location list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.LocationList+xml application/vnd.ez.api.LocationList+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

401

Error - the user is not authorized to read this Content item.

404

Error - the Content item with the given ID does not exist.

Types
Type Description
LocationList This class represents a queried Location list holding a totalCount and a partial list of Locations (by offset/limit parameters and permission filters).
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<LocationList media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/61/locations">
    <Location media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2/62"/>
</LocationList>

                                        

/content/objects/{contentId}/objectstates

Get Object states of Content item

GET /content/objects/{contentId}/objectstates

Returns the Object states of a Content item

Header parameters

Accept

If set, the Object states are returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentObjectStates+xml application/vnd.ez.api.ContentObjectStates+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - returns the Object state.

404

Error - The Content item does not exist.

Types
Type Description
ContentObjectStates Base struct for content create/update structs.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateList media-type="application/vnd.ez.api.ObjectStateList+xml" href="/api/ezp/v2/content/objectstategroups/2/objectstates">
    <ObjectState media-type="application/vnd.ez.api.ObjectState+xml" href="/api/ezp/v2/content/objectstategroups/2/objectstates/1">
        <id>1</id>
        <identifier>not_locked</identifier>
        <priority>0</priority>
        <ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/2"/>
        <defaultLanguageCode>eng-GB</defaultLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <names>
            <value languageCode="eng-GB">Not locked</value>
        </names>
        <descriptions>
            <value languageCode="eng-GB"></value>
        </descriptions>
    </ObjectState>
    <ObjectState media-type="application/vnd.ez.api.ObjectState+xml" href="/api/ezp/v2/content/objectstategroups/2/objectstates/4">
        <id>4</id>
        <identifier>old-state</identifier>
        <priority>1</priority>
        <ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/2"/>
        <defaultLanguageCode>eng-GB</defaultLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <names>
            <value languageCode="eng-GB">New State</value>
        </names>
        <descriptions>
            <value languageCode="eng-GB">New Object State</value>
        </descriptions>
    </ObjectState>
    <ObjectState media-type="application/vnd.ez.api.ObjectState+xml" href="/api/ezp/v2/content/objectstategroups/2/objectstates/3">
        <id>3</id>
        <identifier>new-state</identifier>
        <priority>2</priority>
        <ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/2"/>
        <defaultLanguageCode>eng-GB</defaultLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <names>
            <value languageCode="eng-GB">New State</value>
        </names>
        <descriptions>
            <value languageCode="eng-GB">New Object State</value>
        </descriptions>
    </ObjectState>
    <ObjectState media-type="application/vnd.ez.api.ObjectState+xml" href="/api/ezp/v2/content/objectstategroups/2/objectstates/2">
        <id>2</id>
        <identifier>locked</identifier>
        <priority>3</priority>
        <ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/2"/>
        <defaultLanguageCode>eng-GB</defaultLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <names>
            <value languageCode="eng-GB">Locked</value>
        </names>
        <descriptions>
            <value languageCode="eng-GB"></value>
        </descriptions>
    </ObjectState>
</ObjectStateList>

                                        
Set Object states of Content item

PATCH /content/objects/{contentId}/objectstates

Updates Object states of a Content item. An Object state in the input overrides the state of the Object state group. PATCH or POST with header X-HTTP-Method-Override PATCH.

Header parameters

Accept

If set, the updated Object state is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectState+xml application/vnd.ez.api.ObjectState+json

Content-Type

The Content item Object states input schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectStateUpdate+xml application/vnd.ez.api.ObjectStateUpdate+json

If-Match

ETag

Property Value
Type string
Possible responses
Code Description
204

OK - Object state updated.

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to set an Object state.

403

Error - The input contains multiple Object states of the same Object state group.

412

Error - The current ETag does not match the one provided in the If-Match header.

Types
Type Description
ObjectStateUpdate
ObjectState This class represents a Object state value.
Request
Media type application/vnd.ez.api.ObjectState+xml
Schema ObjectStateUpdate * : ObjectStateUpdate

/content/objectstategroups

/content/objectstategroups

List Object state groups

GET /content/objectstategroups

Returns a list of all Object state groups.

Header parameters

Accept

If set, the Object state group list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectStateGroupList+xml application/vnd.ez.api.ObjectStateGroupList+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - returns a list of Object state groups.

401

Error - The user has no permission to read Object state groups.

Types
Type Description
ObjectStateGroupList List of Object state groups.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateGroupList media-type="application/vnd.ez.api.ObjectStateGroupList+xml" href="/api/ezp/v2/content/objectstategroups">
    <ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/2">
        <id>2</id>
        <identifier>ez_lock</identifier>
        <defaultLanguageCode>eng-GB</defaultLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <ObjectStates media-type="application/vnd.ez.api.ObjectStateList+xml" href="/api/ezp/v2/content/objectstategroups/2/objectstates"/>
        <names>
            <value languageCode="eng-GB">Lock</value>
        </names>
        <descriptions>
            <value languageCode="eng-GB"></value>
        </descriptions>
    </ObjectStateGroup>
    <ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/3">
        <id>3</id>
        <identifier>testgroup</identifier>
        <defaultLanguageCode>eng-GB</defaultLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <ObjectStates media-type="application/vnd.ez.api.ObjectStateList+xml" href="/api/ezp/v2/content/objectstategroups/3/objectstates"/>
        <names>
            <value languageCode="eng-GB">Testgroup</value>
        </names>
        <descriptions>
            <value languageCode="eng-GB"></value>
        </descriptions>
    </ObjectStateGroup>
</ObjectStateGroupList>

                                        
Create Object state group

POST /content/objectstategroups

Creates a new Object state group.

Header parameters

Accept

If set, the new Object state group is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectStateGroup+xml application/vnd.ez.api.ObjectStateGroup+json

Content-Type

The Object state group input schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectStateGroupCreate+json application/vnd.ez.api.ObjectStateGroupCreate+xml
Possible responses
Code Description
201

Object state group created.

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to create an Object state group.

403

Error - An Object state group with the same identifier already exists.

Types
Type Description
ObjectStateGroupCreate
ObjectStateGroup This class represents an Object state group value.
Request
Media type application/vnd.ez.api.ObjectStateGroupCreate+xml
Schema ObjectStateGroupCreate * : ObjectStateGroupCreate
Media type application/vnd.ez.api.ObjectStateGroupCreate+json
Schema ObjectStateGroupCreate * : ObjectStateGroupCreate
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/6">
    <id>6</id>
    <identifier>custom-states</identifier>
    <defaultLanguageCode>eng-GB</defaultLanguageCode>
    <languageCodes>eng-GB</languageCodes>
    <ObjectStates media-type="application/vnd.ez.api.ObjectStateList+xml" href="/api/ezp/v2/content/objectstategroups/6/objectstates"/>
    <names>
        <value languageCode="eng-GB">Custom State</value>
    </names>
    <descriptions>
        <value languageCode="eng-GB">Custom Object state</value>
    </descriptions>
</ObjectStateGroup>

                                        

/content/objectstategroups/{objectStateGroupId}

Get Object state group

GET /content/objectstategroups/{objectStateGroupId}

Returns the Object state group with the provided ID.

Header parameters

Accept

If set, the Object state group is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectStateGroup+xml application/vnd.ez.api.ObjectStateGroup+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - returns the Object state group.

401

Error - The user is not authorized to read this Object state group.

404

Error - The Object state group does not exist.

Types
Type Description
ObjectStateGroup This class represents an Object state group value.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/6">
    <id>6</id>
    <identifier>custom-states</identifier>
    <defaultLanguageCode>eng-GB</defaultLanguageCode>
    <languageCodes>eng-GB</languageCodes>
    <ObjectStates media-type="application/vnd.ez.api.ObjectStateList+xml" href="/api/ezp/v2/content/objectstategroups/6/objectstates"/>
    <names>
        <value languageCode="eng-GB">Custom State</value>
    </names>
    <descriptions>
        <value languageCode="eng-GB">Custom Object state</value>
    </descriptions>
</ObjectStateGroup>

                                        
Update Object state group

PATCH /content/objectstategroups/{objectStateGroupId}

Updates an Object state group. PATCH or POST with header X-HTTP-Method-Override PATCH.

Header parameters

Accept

If set, the updated Object state group is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectStateGroup+xml application/vnd.ez.api.ObjectStateGroup+json

Content-Type

The Object state group input schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectStateGroupUpdate+json application/vnd.ez.api.ObjectStateGroupUpdate+xml

If-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - Object stated group updated.

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to update an Object state group.

403

Error - An Object state group with the provided identifier already exists.

412

Error - The current ETag does not match the one provided in the If-Match header.

Types
Type Description
ObjectStateGroupUpdate
ObjectStateGroup This class represents an Object state group value.
Request
Media type application/vnd.ez.api.ObjectStateGroupUpdate+xml
Schema ObjectStateGroupUpdate * : ObjectStateGroupUpdate
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/6">
    <id>6</id>
    <identifier>custom-states</identifier>
    <defaultLanguageCode>eng-GB</defaultLanguageCode>
    <languageCodes>eng-GB</languageCodes>
    <ObjectStates media-type="application/vnd.ez.api.ObjectStateList+xml" href="/api/ezp/v2/content/objectstategroups/6/objectstates"/>
    <names>
        <value languageCode="eng-GB">New Custom State name</value>
    </names>
    <descriptions>
        <value languageCode="eng-GB">Custom Object state</value>
    </descriptions>
</ObjectStateGroup>

                                        
Delete Object state group

DELETE /content/objectstategroups/{objectStateGroupId}

Deletes the given Object state group including Object states.

Possible responses
Code Description
204

No Content - Object state group deleted.

401

Error - The user is not authorized to delete an Object state group.

404

Error - The Object state group does not exist.

/content/objectstategroups/objectstates

List Object states

GET /content/objectstategroups/objectstates

Returns a list of all Object states of the given group.

Header parameters

Accept

If set, the Object state list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectStateList+xml application/vnd.ez.api.ObjectStateList+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - returns a list of Object states.

401

Error - The user has no permission to read Object states.

Types
Type Description
ObjectStateList List of Object states.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateList media-type="application/vnd.ez.api.ObjectStateList+xml" href="/api/ezp/v2/content/objectstategroups/2/objectstates">
    <ObjectState media-type="application/vnd.ez.api.ObjectState+xml" href="/api/ezp/v2/content/objectstategroups/2/objectstates/1">
        <id>1</id>
        <identifier>not_locked</identifier>
        <priority>0</priority>
        <ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/2"/>
        <defaultLanguageCode>eng-GB</defaultLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <names>
            <value languageCode="eng-GB">Not locked</value>
        </names>
        <descriptions>
            <value languageCode="eng-GB"></value>
        </descriptions>
    </ObjectState>
    <ObjectState media-type="application/vnd.ez.api.ObjectState+xml" href="/api/ezp/v2/content/objectstategroups/2/objectstates/2">
        <id>2</id>
        <identifier>locked</identifier>
        <priority>1</priority>
        <ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/2"/>
        <defaultLanguageCode>eng-GB</defaultLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <names>
            <value languageCode="eng-GB">Locked</value>
        </names>
        <descriptions>
            <value languageCode="eng-GB"></value>
        </descriptions>
    </ObjectState>
</ObjectStateList>

                                        
Create Object state

POST /content/objectstategroups/objectstates

Creates a new Object state.

Header parameters

Accept

If set, the new Object state is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectState+xml application/vnd.ez.api.ObjectState+json

Content-Type

The Object state input schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectStateCreate+json application/vnd.ez.api.ObjectStateCreate+xml
Possible responses
Code Description
201

Object state created.

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to create an Object state.

403

Error - An Object state with the same identifier already exists in the given group.

Types
Type Description
ObjectStateCreate
ObjectState This class represents a Object state value.
Request
Media type application/vnd.ez.api.ObjectStateCreate+xml
Schema ObjectStateCreate * : ObjectStateCreate
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ObjectState media-type="application/vnd.ez.api.ObjectState+xml" href="/api/ezp/v2/content/objectstategroups/6/objectstates/6">
    <id>6</id>
    <identifier>new-state</identifier>
    <priority>0</priority>
    <ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/6"/>
    <defaultLanguageCode>eng-GB</defaultLanguageCode>
    <languageCodes>eng-GB</languageCodes>
    <names>
        <value languageCode="eng-GB">New State</value>
    </names>
    <descriptions>
        <value languageCode="eng-GB">New Object State</value>
    </descriptions>
</ObjectState>

                                        

/content/objectstategroups/objectstates/{objectStateId}

Get Object state

GET /content/objectstategroups/objectstates/{objectStateId}

Returns the Object state.

Header parameters

Accept

If set, the Object State is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectState+xml application/vnd.ez.api.ObjectState+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - returns the Object state.

401

Error - The user is not authorized to read this Object state.

404

Error - The Object state does not exist.

Types
Type Description
ObjectState This class represents a Object state value.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ObjectState media-type="application/vnd.ez.api.ObjectState+xml" href="/api/ezp/v2/content/objectstategroups/6/objectstates/2">
<id>2</id>
<identifier>locked</identifier>
<priority>1</priority>
<ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/6"/>
<defaultLanguageCode>eng-GB</defaultLanguageCode>
<languageCodes>eng-GB</languageCodes>
<names>
    <value languageCode="eng-GB">Locked</value>
</names>
<descriptions>
    <value languageCode="eng-GB"></value>
</descriptions>
</ObjectState>

                                        
Update Object state

PATCH /content/objectstategroups/objectstates/{objectStateId}

Updates an Object state. PATCH or POST with header X-HTTP-Method-Override PATCH.

Header parameters

Accept

If set, the updated Object state is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectState+xml application/vnd.ez.api.ObjectState+json

Content-Type

The Object state input schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ObjectStateUpdate+json application/vnd.ez.api.ObjectStateUpdate+xml

If-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - Object State updated

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to update the Object state.

403

Error - An Object state with the provided identifier already exists in this group.

412

Error - The current ETag does not match the one provided in the If-Match header.

Types
Type Description
ObjectStateUpdate
ObjectState This class represents a Object state value.
Request
Media type application/vnd.ez.api.ObjectStateUpdate+xml
Schema ObjectStateUpdate * : ObjectStateUpdate
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ObjectState media-type="application/vnd.ez.api.ObjectState+xml" href="/api/ezp/v2/content/objectstategroups/2/objectstates/2">
    <id>2</id>
    <identifier>locked</identifier>
    <priority>1</priority>
    <ObjectStateGroup media-type="application/vnd.ez.api.ObjectStateGroup+xml" href="/api/ezp/v2/content/objectstategroups/2"/>
    <defaultLanguageCode>eng-GB</defaultLanguageCode>
    <languageCodes>eng-GB</languageCodes>
    <names>
        <value languageCode="eng-GB">New Object State name</value>
    </names>
    <descriptions>
        <value languageCode="eng-GB"></value>
    </descriptions>
</ObjectState>

                                        
Delete Object state

DELETE /content/objectstategroups/objectstates/{objectStateId}

Deletes provided Object state.

Possible responses
Code Description
204

No Content - Object state deleted.

401

Error - The user is not authorized to delete an Object state.

404

Error - The Object state does not exist.

/content/locations

/content/locations

Load Locations by id/remoteId/urlAlias

GET /content/locations

Loads the Location for a given ID (x), remote ID or URL alias.

Query parameters
Property Type Value
id string The ID of the Location. If present, the Location with the given ID is returned.
remoteId string The remote ID of the Location. If present, the Location with the given remote ID is returned.
urlAlias string One of the URL aliases of the Location. If present, the Location with given URL Alias is returned.
Possible responses
Code Description
307

Temporary redirect to the main resource URL.

200

404

Error - the Location with the given ID (remote ID or URL Alias) does not exist.

Types
Type Description
Location This class represents a Location in the Repository.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<LocationList href="/content/objects/23/locations" media-type="application/vnd.ez.api.LocationList+xml">
  <Location href="/content/locations/1/2/56" media-type="application/vnd.ez.api.Location+xml"/>
  <Location href="/content/locations/1/4/73/133" media-type="application/vnd.ez.api.Location+xml"/>
</LocationList>

                                        

/content/locations/{path}

Load Location

GET /content/locations/{path}

Loads the Location for the given path e.g. '/content/locations/1/2/61'.

Header parameters

Accept

If set, the new Location is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Location+xml application/vnd.ez.api.Location+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

401

Error - the user is not authorized to read this Location.

404

Error - the Location with the given path does not exist.

Types
Type Description
Location This class represents a Location in the Repository.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Location media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2/61">
    <id>61</id>
    <priority>0</priority>
    <hidden>false</hidden>
    <invisible>false</invisible>
    <ParentLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2" />
    <pathString>/1/2/61/</pathString>
    <depth>2</depth>
    <childCount>0</childCount>
    <remoteId>2cfa66027e3806b113d994c9c26d3a66</remoteId>
    <Children media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/locations/1/2/61/children" />
    <Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/60" />
    <sortField>NAME</sortField>
    <sortOrder>ASC</sortOrder>
    <UrlAliases media-type="application/vnd.ez.api.UrlAliasRefList+xml" href="/api/ezp/v2/content/locations/1/2/61/urlaliases" />
    <ContentInfo media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/60">
        <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/60" remoteId="f9198276543bfe5e1dfc01a9a8d0c7ee" id="60">
            <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2" />
            <Name>666</Name>
            <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/60/versions" />
            <CurrentVersion media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/60/currentversion" />
            <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/1" />
            <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/60/locations" />
            <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14" />
            <lastModificationDate>2018-11-09T14:49:52+01:00</lastModificationDate>
            <publishedDate>2018-11-09T14:49:52+01:00</publishedDate>
            <mainLanguageCode>eng-GB</mainLanguageCode>
            <currentVersionNo>1</currentVersionNo>
            <alwaysAvailable>false</alwaysAvailable>
            <ObjectStates media-type="application/vnd.ez.api.ContentObjectStates+xml" href="/api/ezp/v2/content/objects/60/objectstates" />
        </Content>
    </ContentInfo>
</Location>

                                        
Move subtree

MOVE /content/locations/{path}

Moves Location to a different parent. The destination can also be '/content/trash' where the Location is put into the trash. (NOTE - Be aware that the user might lose access to the item after it has been moved, for example when read access is limited by a subtree). MOVE or POST with header X-HTTP-Method-Override MOVE.

Header parameters

Destination

A parent Location resource to which the Location is moved e.g. '/api/ezp/v2/content/locations/1/63'.

Property Value
Type string
Possible responses
Code Description
201

Created. If destination is '/api/ezp/v2/content/trash' and content only has one Location (NOTE - Like on normal subtree moves, be aware that the user might lose access to the item after it has been moved to Trash.)

204

No Content. If destination is '/api/ezp/v2/content/trash' and content still has other Locations (no trash item is created).

401

Error - the user is not authorized to move this Location.

404

Error - the Location with the given ID does not exist.

Copy subtree

COPY /content/locations/{path}

Copies the subtree to a different parent. COPY or POST with header X-HTTP-Method-Override COPY.

Header parameters

Destination

A parent Location resource to which the Location is moved e.g. '/api/ezp/v2/content/locations/1/63'.

Property Value
Type string
Possible responses
Code Description
201

Created. Copied the subtree to a different parent.

401

Error - the user is not authorized to move this Location.

404

Error - the Location with the given ID does not exist.

Delete subtree

DELETE /content/locations/{path}

Deletes the complete subtree for the given path. Every Content item which does not have any other Location is deleted. Otherwise the deleted Location is removed from the Content item. The children are recursively deleted.

Possible responses
Code Description
204

No Content - deleted.

401

Error - the user is not authorized to delete this subtree.

404

Error - the Location with the given ID does not exist.

/content/locations/{path}/{locationId}

Update Location

PATCH /content/locations/{path}/{locationId}

Updates the Location. This method can also be used to hide/reveal a Location via the hidden field in the LocationUpdate. PATCH or POST with header X-HTTP-Method-Override PATCH.

Header parameters

Accept

If set, the Location is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Location+xml application/vnd.ez.api.Location+json

Content-Type

The LocationUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.LocationUpdate+xml application/vnd.ez.api.LocationUpdate+json

If-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

401

Error - the user is not authorized to update this Location.

404

Error - the Location with the given ID does not exist.

Types
Type Description
LocationUpdateStruct This class is used for updating Location meta data.
Location This class represents a Location in the Repository.
Request
Media type application/vnd.ez.api.LocationUpdate+xml
Schema LocationUpdateStruct * : LocationUpdateStruct
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Location href="/content/locations/1/5/73/133" media-type="application/vnd.ez.api.Location+xml">
  <id>133</id>
  <priority>3</priority>
  <hidden>true</hidden>
  <invisible>true</invisible>
  <ParentLocation href="/content/locations/1/5/73" media-type="application/vnd.ez.api.Location+xml"/>
  <pathString>/1/5/73/133</pathString>
  <depth>4</depth>
  <childCount>0</childCount>
  <remoteId>remoteId-qwert999</remoteId>
  <Children href="/content/locations/1/5/73/133/children" media-type="application/vnd.ez.api.LocationList+xml"/>
  <Content href="/content/objects/23" media-type="application/vnd.ez.api.Content+xml"/>
  <sortField>CLASS</sortField>
  <sortOrder>ASC</sortOrder>
</Location>

                                        
Swap Location

SWAP /content/locations/{path}/{locationId}

Swaps the Location of a Content item with the given Location of another Content item. SWAP or POST with header X-HTTP-Method-Override SWAP.

Header parameters

Destination

A parent Location resource to which the Location is moved e.g. '/api/ezp/v2/content/locations/1/63'.

Property Value
Type string
Possible responses
Code Description
204

No Content. Swapped the Location of a Content item with the given Location of another Content item.

401

Error - the user is not authorized to swap this Location.

404

Error - the Location with the given ID does not exist.

/content/views

/content/views

Create View

POST /content/views

Executes a query and returns View including the results. The View input reflects the criteria model of the public API. Will respond with a 301, as the resource has been moved to /views (Platform 1.0) - DEPRECATED.

Header parameters

Accept

The View in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.View+xml application/vnd.ez.api.View+json application/vnd.ez.api.View+xml; version=1.1 application/vnd.ez.api.View+json; version=1.1

Content-Type

The View input in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ViewInput+xml application/vnd.ez.api.ViewInput+json application/vnd.ez.api.ViewInput+xml; version=1.1 application/vnd.ez.api.ViewInput+json; version=1.1
Possible responses
Code Description
301

Moved permanently.

400

Error - the input does not match the input schema definition.

List Views

GET /content/views

Returns a list of View URIs. The list includes a public View and a private View of the authenticated user. - DEPRECATED

Header parameters

Accept

The view link list in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.RefList+xml application/vnd.ez.api.RefList+json
Possible responses
Code Description
200

OK - list of View URIs.

/content/views/{identifier}

Get View

GET /content/views/{identifier}

Returns the View - DEPRECATED.

Header parameters

Accept

The View results in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.View+xml application/vnd.ez.api.View+json
Possible responses
Code Description
200

OK - returns the View.

401

Error - the View is not public and from another user.

Delete View

DELETE /content/views/{identifier}

The given View is deleted - DEPRECATED.

Possible responses
Code Description
204

No content - the given View is deleted.

401

Error - the user is not authorized to delete this View.

404

Error - the View does not exist.

/content/views/{identifier}/results

Get results of existing View

GET /content/views/{identifier}/results

Returns result of the View - DEPRECATED.

Header parameters

Accept

The View excluding results in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ViewResult+xml application/vnd.ez.api.ViewResult+json
Possible responses
Code Description
200

OK - result of the View.

401

Error - the View is not public and from another user.

/content/sections

/content/sections

Create new Section

POST /content/sections

Creates a new Section.

Header parameters

Accept

If set, the new Section is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Section+xml application/vnd.ez.api.Section+json

Content-Type

The Section input schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.SectionInput+json application/vnd.ez.api.SectionInput+xml
Possible responses
Code Description
201

Types
Type Description
SectionInput
Section This class represents a Section.
Request
Media type application/vnd.ez.api.SectionInput+xml
Schema SectionInput * : SectionInput
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/7">
    <sectionId>7</sectionId>
    <identifier>restricted</identifier>
    <name>Restricted</name>
</Section>

                                        
Get Sections

GET /content/sections

Returns a list of all Sections.

Header parameters

Accept

If set, the Section list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.SectionList+xml application/vnd.ez.api.SectionList+json

If-None-Match

ETag

Property Value
Type string
Query parameters
Property Type Value
identifer string Only the Section with the given identifier is returned.
Possible responses
Code Description
200

401

Error - The user has no permission to read the Section.

Types
Type Description
SectionList This class represents a Section list.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<SectionList media-type="application/vnd.ez.api.SectionList+xml" href="/api/ezp/v2/content/sections">
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/1">
        <sectionId>1</sectionId>
        <identifier>standard</identifier>
        <name>Standard</name>
    </Section>
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/2">
        <sectionId>2</sectionId>
        <identifier>users</identifier>
        <name>Users</name>
    </Section>
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/3">
        <sectionId>3</sectionId>
        <identifier>media</identifier>
        <name>Media</name>
    </Section>
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/4">
        <sectionId>4</sectionId>
        <identifier>setup</identifier>
        <name>Setup</name>
    </Section>
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/5">
        <sectionId>5</sectionId>
        <identifier>design</identifier>
        <name>Design</name>
    </Section>
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/6">
        <sectionId>6</sectionId>
        <identifier>form</identifier>
        <name>Form</name>
    </Section>
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/7">
        <sectionId>7</sectionId>
        <identifier>restricted</identifier>
        <name>Restricted</name>
    </Section>
</SectionList>

                                        

/content/sections/{sectionId}

Get Section

GET /content/sections/{sectionId}

Returns the Section by given Section ID.

Header parameters

Accept

If set, the Section is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Section+xml application/vnd.ez.api.Section+json

If-None-match

ETag

Property Value
Type string
Possible responses
Code Description
200

401

Error - The user is not authorized to read this Section.

404

Error - The Section does not exist.

Types
Type Description
Section This class represents a Section.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/5">
    <sectionId>5</sectionId>
    <identifier>design</identifier>
    <name>Design</name>
</Section>

                                        
Update a Section

PATCH /content/sections/{sectionId}

Updates a Section. PATCH or POST with header X-HTTP-Method-Override PATCH.

Header parameters

Accept

If set, the updated Section is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Section+xml application/vnd.ez.api.Section+json

Content-Type

The Section input schema encoded in XML or JSON.

Property Value
Type string
Examples application/vnd.ez.api.SectionInput+xml application/vnd.ez.api.SectionInput+json

If-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - Section updated.

400

Error - the input does not match the input schema definition.

401

Error - the user is not authorized to create this Section.

403

Error - a Section with the given identifier already exists.

412

Error - the current ETag does not match with the one provided in the If-Match header.

Types
Type Description
SectionInput
Section This class represents a Section.
Request
Media type application/vnd.ez.api.SectionInput+xml
Schema SectionInput * : SectionInput
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/7">
    <sectionId>7</sectionId>
    <identifier>template</identifier>
    <name>Template</name>
</Section>

                                        
Delete Section

DELETE /content/sections/{sectionId}

The given Section is deleted.

Possible responses
Code Description
204

No Content - given Section is deleted.

401

Error - the user is not authorized to delete this Section.

404

Error - the Section does not exist.

/content/trash

/content/trash

List Trash items

GET /content/trash

Returns a list of all items in the Trash.

Header parameters

Accept

If set, the Trash item list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.Trash+xml application/vnd.ez.api.Trash+json
Query parameters
Property Type Value
limit string Only limit. Items will be returned, starting with the offset.
offset string Offset of the result set.
Possible responses
Code Description
200

OK - returns the list of items in the Trash.

401

Error - The user has no permission to read the Trash.

Types
Type Description
Trash
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<Trash media-type="application/vnd.ez.api.Trash+xml" href="/api/ezp/v2/content/trash">
    <TrashItem media-type="application/vnd.ez.api.TrashItem+xml" href="/api/ezp/v2/content/trash/58">
        <id>58</id>
        <priority>0</priority>
        <hidden>false</hidden>
        <invisible>false</invisible>
        <ParentLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2/56"/>
        <pathString>/1/2/56/58/</pathString>
        <depth>3</depth>
        <childCount>0</childCount>
        <remoteId>59800915ad2eb8514de0bebe84f6ccba</remoteId>
        <Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/52"/>
        <sortField>PATH</sortField>
        <sortOrder>ASC</sortOrder>
        <ContentInfo media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/52">
            <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/52" remoteId="881da87102313b0354dc2aa8f0e4b63b" id="52">
                <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/1"/>
                <Name>Folder 1</Name>
                <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/52/versions"/>
                <CurrentVersion media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/52/currentversion"/>
                <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/1"/>
                <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/52/locations"/>
                <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
                <lastModificationDate>2019-02-06T09:03:09+01:00</lastModificationDate>
                <publishedDate>2019-02-06T09:03:09+01:00</publishedDate>
                <mainLanguageCode>eng-GB</mainLanguageCode>
                <currentVersionNo>1</currentVersionNo>
                <alwaysAvailable>true</alwaysAvailable>
                <ObjectStates media-type="application/vnd.ez.api.ContentObjectStates+xml" href="/api/ezp/v2/content/objects/52/objectstates"/>
            </Content>
        </ContentInfo>
    </TrashItem>
</Trash>

                                        
Empty Trash

DELETE /content/trash

Empties the Trash.

Possible responses
Code Description
204

No Content - Trash emptied.

401

Error - The user is not authorized to empty all items from Trash.

/content/trash/{trashItemid}

Get Trash item

GET /content/trash/{trashItemid}

Returns the item in Trash with the provided ID.

Header parameters

Accept

If set, the item in Trash is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.TrashItem+xml application/vnd.ez.api.TrashItem+json
Possible responses
Code Description
200

401

Error - The user has no permission to read the item in Trash.

404

Error - An item in Trash with the provided ID does not exist.

Types
Type Description
TrashItem This class represents a trash item, which is actually a trashed Location.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<TrashItem media-type="application/vnd.ez.api.TrashItem+xml" href="/api/ezp/v2/content/trash/81">
    <id>81</id>
    <priority>0</priority>
    <hidden>false</hidden>
    <invisible>false</invisible>
    <ParentLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2/42"/>
    <pathString>/1/2/42/81/</pathString>
    <depth>3</depth>
    <childCount>0</childCount>
    <remoteId>135e8a84b61848a67be36e9552d2724d</remoteId>
    <Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/99"/>
    <sortField>PATH</sortField>
    <sortOrder>ASC</sortOrder>
    <ContentInfo media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/99">
        <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/99" remoteId="ae2b4568c0d2e7a4a9bca9495e73591a" id="99">
            <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/1"/>
            <Name>Folder 1</Name>
            <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/99/versions"/>
            <CurrentVersion media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/99/currentversion"/>
            <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/1"/>
            <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/99/locations"/>
            <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
            <lastModificationDate>2019-04-25T12:45:58+02:00</lastModificationDate>
            <publishedDate>2019-04-25T12:45:58+02:00</publishedDate>
            <mainLanguageCode>eng-GB</mainLanguageCode>
            <currentVersionNo>1</currentVersionNo>
            <alwaysAvailable>true</alwaysAvailable>
            <status>TRASHED</status>
            <ObjectStates media-type="application/vnd.ez.api.ContentObjectStates+xml" href="/api/ezp/v2/content/objects/99/objectstates"/>
        </Content>
    </ContentInfo>
</TrashItem>

                                        
Untrash Content item

MOVE /content/trash/{trashItemid}

Restores an item from Trash. MOVE or POST with header X-HTTP-Method-Override MOVE.

Header parameters

Destination

If the destination Location URI is provided, the item from Trash is restored under this Location, otherwise it is restored under its original parent Location.

Property Value
Type string
Possible responses
Code Description
201

Item restored.

401

Error - The user is not authorized to restore this item from Trash.

403

Error - The provided parent Location does not exist.

404

Error - The provided item does not exist in Trash.

Delete Trash item

DELETE /content/trash/{trashItemid}

Deletes the provided item from Trash.

Possible responses
Code Description
204

No Content - item deleted.

401

Error - The user is not authorized to delete the provided item.

404

Error - The provided item does not exist in Trash.

/content/urlaliases

/content/urlaliases

List global URL aliases

GET /content/urlaliases

Returns the list of global URL aliases.

Header parameters

Accept

If set, the URL alias list contains only references and is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UrlAliasRefList+xml application/vnd.ez.api.UrlAliasRefList+json
Possible responses
Code Description
200

OK - returns the list of URL aliases.

401

Error - The user has no permission to read URL aliases.

Types
Type Description
UrlAliasRefList List of URL alias in the Repository.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<UrlAliasRefList media-type="application/vnd.ez.api.UrlAliasRefList+xml" href="/api/ezp/v2/content/urlaliases">
    <UrlAlias media-type="application/vnd.ez.api.UrlAlias+xml" href="/api/ezp/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36" />
</UrlAliasRefList>

                                        
Create URL alias

POST /content/urlaliases

Creates a URL alias.

Header parameters

Accept

If set, the created URL alias is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UrlAlias+xml application/vnd.ez.api.UrlAlias+json

Content-Type

The URL alias input schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UrlAliasCreate+xml application/vnd.ez.api.UrlAliasCreate+json
Possible responses
Code Description
201

URL alias created.

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to create a URL alias.

403

Error - A URL alias with the same identifier already exists.

Types
Type Description
UrlAliasCreate
UrlAlias This class represents a URL alias in the Repository.
Request
Media type application/vnd.ez.api.UrlAliasCreate+xml
Schema UrlAliasCreate * : UrlAliasCreate
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<UrlAlias media-type="application/vnd.ez.api.UrlAlias+xml" href="/api/ezp/v2/content/urlaliases/0-deca3dadca45c3dff7861274b8e67ed7" id="0-deca3dadca45c3dff7861274b8e67ed7" type="LOCATION">
    <location media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/59"/>
    <path>/example-urlalias</path>
    <languageCodes>eng-GB</languageCodes>
    <alwaysAvailable>true</alwaysAvailable>
    <isHistory>false</isHistory>
    <forward>true</forward>
    <custom>true</custom>
</UrlAlias>

                                        

/content/urlaliases/{urlAliasId}

Get URL alias

GET /content/urlaliases/{urlAliasId}

Returns the URL alias with the given ID.

Header parameters

Accept

If set, the URL alias is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UrlAlias+xml application/vnd.ez.api.UrlAlias+json
Possible responses
Code Description
200

OK - returns the URL alias.

401

Error - The user is not authorized to read URL aliases.

404

Error - The URL alias does not exist.

Types
Type Description
UrlAlias This class represents a URL alias in the Repository.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<UrlAlias media-type="application/vnd.ez.api.UrlAlias+xml" href="/api/ezp/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36" id="0-2cecdff5f90b8595d76b68c417b09f36" type="RESOURCE">
    <resource>content/view/full</resource>
    <path>/example-global</path>
    <languageCodes>eng-GB</languageCodes>
    <alwaysAvailable>true</alwaysAvailable>
    <isHistory>false</isHistory>
    <forward>true</forward>
    <custom>true</custom>
</UrlAlias>

                                        
Delete URL alias

DELETE /content/urlaliases/{urlAliasId}

Deletes the provided URL alias.

Possible responses
Code Description
204

No Content - URL alias deleted.

401

Error - The user is not authorized to delete a URL alias.

404

Error - The URL alias does not exist.

/content/urlwildcards

/content/urlwildcards

List URL wildcards

GET /content/urlwildcards

Returns a list of URL wildcards.

Header parameters

Accept

If set, the URL wildcard is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UrlWildcardList+xml application/vnd.ez.api.UrlWildcardList+json
Possible responses
Code Description
200

OK - returns a list of URL wildcards.

401

Error - The user has no permission to read URL wildcards.

Types
Type Description
UrlWildcardList List of URL alias in the Repository.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<UrlWildcardList media-type="application/vnd.ez.api.UrlWildcardList+xml" href="/api/ezp/v2/content/urlwildcards">
    <UrlWildcard media-type="application/vnd.ez.api.UrlWildcard+xml" href="/api/ezp/v2/content/urlwildcards/1" id="1">
        <sourceUrl>/api/ezp/v2/content/location/2</sourceUrl>
        <destinationUrl>/api/ezp/v2/content/location/59</destinationUrl>
        <forward>true</forward>
    </UrlWildcard>
</UrlWildcardList>

                                        
Create URL wildcard

POST /content/urlwildcards

Creates a new URL wildcard.

Header parameters

Accept

If set, the new URL wildcard is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UrlWildcard+xml application/vnd.ez.api.UrlWildcard+json

Content-Type

The URL Wildcard input schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UrlWildcardCreate+xml application/vnd.ez.api.UrlWildcardCreate+json
Possible responses
Code Description
201

URL wildcard created.

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to create a URL wildcard.

403

Error - A URL wildcard with the same identifier already exists.

Types
Type Description
UrlWildcardCreate
UrlWildcard This class represents a URL alias in the Repository.
Request
Media type application/vnd.ez.api.UrlWildcardCreate.xml
Schema UrlWildcardCreate * : UrlWildcardCreate
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<UrlWildcard media-type="application/vnd.ez.api.UrlWildcard+xml" href="/api/ezp/v2/content/urlwildcards/1" id="1">
    <sourceUrl>/api/ezp/v2/content/location/2</sourceUrl>
    <destinationUrl>/api/ezp/v2/content/location/59</destinationUrl>
    <forward>true</forward>
</UrlWildcard>

                                        

/content/urlwildcards/{wildcardId}

Get URL wildcard

GET /content/urlwildcards/{wildcardId}

Returns the URL wildcard with the given ID.

Header parameters

Accept

If set, the URL wildcard is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UrlWildcard+xml application/vnd.ez.api.UrlWildcard+json
Possible responses
Code Description
200

OK - returns the URL wildcard.

401

Error - The user is not authorized to read URL wildcards.

404

Error - The URL wildcard does not exist.

Types
Type Description
UrlWildcard This class represents a URL alias in the Repository.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<UrlWildcard media-type="application/vnd.ez.api.UrlWildcard+xml" href="/api/ezp/v2/content/urlwildcards/1" id="1">
    <sourceUrl>/api/ezp/v2/content/location/2</sourceUrl>
    <destinationUrl>/api/ezp/v2/content/location/59</destinationUrl>
    <forward>true</forward>
</UrlWildcard>

                                        
Delete URL wildcard

DELETE /content/urlwildcards/{wildcardId}

Deletes the given URL wildcard.

Possible responses
Code Description
204

No Content - URL wildcard deleted.

401

Error - The user is not authorized to delete a URL wildcard.

404

Error - The URL wildcard does not exist.

/content/typegroups

/content/typegroups

Get Content Type groups

GET /content/typegroups

Returns a list of all Content Type groups. If an identifier is provided, loads the Content Type group for this identifier.

Header parameters

Accept

If set, the Content Type group list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeGroupList+xml application/vnd.ez.api.ContentTypeGroupList+json
Query parameters
Property Type Value
identifier string The identifier of the Content Type group. If present, the Content Type group with this identifier is returned.
Possible responses
Code Description
200

OK - returns a list of Content Type groups.

307

Temporary redirect.

401

Error - The user has no permission to read Content Types.

404

Error - The Content Type group with the given identifier does not exist.

Types
Type Description
ContentTypeGroupList List of Content Type groups.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroupList media-type="application/vnd.ez.api.ContentTypeGroupList+xml" href="/api/ezp/v2/content/typegroups">
    <ContentTypeGroup media-type="application/vnd.ez.api.ContentTypeGroup+xml" href="/api/ezp/v2/content/typegroups/1">
        <id>1</id>
        <identifier>Content</identifier>
        <created>2002-09-05T11:08:48+02:00</created>
        <modified>2002-10-06T18:35:06+02:00</modified>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <ContentTypes media-type="application/vnd.ez.api.ContentTypeInfoList+xml" href="/api/ezp/v2/content/typegroups/1/types"/>
    </ContentTypeGroup>
    <ContentTypeGroup media-type="application/vnd.ez.api.ContentTypeGroup+xml" href="/api/ezp/v2/content/typegroups/2">
        <id>2</id>
        <identifier>Users</identifier>
        <created>2002-09-05T11:09:01+02:00</created>
        <modified>2002-10-06T18:35:13+02:00</modified>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <ContentTypes media-type="application/vnd.ez.api.ContentTypeInfoList+xml" href="/api/ezp/v2/content/typegroups/2/types"/>
    </ContentTypeGroup>
    <ContentTypeGroup media-type="application/vnd.ez.api.ContentTypeGroup+xml" href="/api/ezp/v2/content/typegroups/3">
        <id>3</id>
        <identifier>Media</identifier>
        <created>2002-09-14T15:22:23+02:00</created>
        <modified>2002-10-06T18:35:20+02:00</modified>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <ContentTypes media-type="application/vnd.ez.api.ContentTypeInfoList+xml" href="/api/ezp/v2/content/typegroups/3/types"/>
    </ContentTypeGroup>
</ContentTypeGroupList>

                                        
Create Content Type group

POST /content/typegroups

Creates a new Content Type group.

Header parameters

Accept

If set, the new Content Type group is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeGroup+xml application/vnd.ez.api.ContentTypeGroup+json

Content-Type

The Content Type group input schema encoded in XML or JSON.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeGroupInput+xml application/vnd.ez.api.ContentTypeGroupInput+json
Possible responses
Code Description
201

Content Type group created.

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to create this Content Type group.

403

Error - A Content Type group with the same identifier already exists.

Types
Type Description
ContentTypeGroupInput
ContentTypeGroup This class represents a Content Type group value.
Request
Media type application/vnd.ez.api.ContentTypeGroupInput+xml
Schema ContentTypeGroupInput * : ContentTypeGroupInput
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroup href="/content/typesgroups/7" media-type="application/vnd.ez.api.ContentTypeGroup+xml">
    <id>7</id>
    <identifier>newContentTypeGroup</identifier>
    <created>2012-02-31T12:45:00</created>
    <modified>2012-02-31T12:45:00</modified>
    <Creator href="/user/users/13" media-type="application/vnd.ez.api.User+xml"/>
    <Modifier href="/user/users/13" media-type="application/vnd.ez.api.User+xml"/>
    <ContentTypes href="/content/typegroups/7/types" media-type="application/vnd.ez.api.ContentTypeList+xml"/>
</ContentTypeGroup>

                                        

/content/typegroups/{contentTypeGroupId}

Get Content Type group

GET /content/typegroups/{contentTypeGroupId}

Returns the Content Type group with provided ID.

Header parameters

Accept

If set, the Content Type group is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeGroup+xml application/vnd.ez.api.ContentTypeGroup+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - returns the Content Type group.

401

Error - The user is not authorized to read this Content Type group.

404

Error - The Content Type group does not exist.

Types
Type Description
ContentTypeGroup This class represents a Content Type group value.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroup media-type="application/vnd.ez.api.ContentTypeGroup+xml" href="/api/ezp/v2/content/typegroups/1">
    <id>1</id>
    <identifier>Content</identifier>
    <created>2002-09-05T11:08:48+02:00</created>
    <modified>2002-10-06T18:35:06+02:00</modified>
    <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <ContentTypes media-type="application/vnd.ez.api.ContentTypeInfoList+xml" href="/api/ezp/v2/content/typegroups/1/types"/>
</ContentTypeGroup>

                                        
Update Content Type group

PATCH /content/typegroups/{contentTypeGroupId}

Updates a Content Type group. PATCH or POST with header X-HTTP-Method-Override PATCH.

Header parameters

Accept

If set, the updated Content Type group is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeGroup+xml application/vnd.ez.api.ContentTypeGroup+json

Content-Type

The Content Type group input schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeGroupInput+xml application/vnd.ez.api.ContentTypeGroupInput+json

If-Match

ETag causes patching only if the specified ETag is the current one. Otherwise a 412 is returned.

Property Value
Type string
Possible responses
Code Description
200

Content Type group updated.

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to create this Content Type group.

403

Error - A Content Type group with the given identifier already exists.

412

Error - The current ETag does not match the one provided in the If-Match header.

Types
Type Description
ContentTypeGroupInput
ContentTypeGroup This class represents a Content Type group value.
Request
Media type application/vnd.ez.api.ContentTypeGroupInput+xml
Schema ContentTypeGroupInput * : ContentTypeGroupInput
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroup media-type="application/vnd.ez.api.ContentTypeGroup+xml" href="/api/ezp/v2/content/typegroups/1">
    <id>4</id>
    <identifier>updatedIdentifer</identifier>
    <created>2002-09-05T11:08:48+02:00</created>
    <modified>2019-02-22T14:42:55+01:00</modified>
    <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <ContentTypes media-type="application/vnd.ez.api.ContentTypeInfoList+xml" href="/api/ezp/v2/content/typegroups/1/types"/>
</ContentTypeGroup>

                                        
Delete Content Type group

DELETE /content/typegroups/{contentTypeGroupId}

Deletes the provided Content Type group.

Possible responses
Code Description
204

No Content - Content Type group deleted.

401

Error - The user is not authorized to delete this Content Type group.

403

Error - The Content Type group is not empty.

404

Error - The Content Type group does not exist.

/content/typegroups/{contentTypeGroupId}/types

List Content Types for group

GET /content/typegroups/{contentTypeGroupId}/types

Returns a list of Content Types in the provided group.

Header parameters

Accept

If set, the list of Content Type info objects or Content Types (including Field definitions) is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeInfoList+xml application/vnd.ez.api.ContentTypeInfoList+json application/vnd.ez.api.ContentTypeList+xml application/vnd.ez.api.ContentTypeList+json
Possible responses
Code Description
200

OK - returns a list on Content Types.

401

Error - The user has no permission to read the Content Types.

Types
Type Description
ContentTypeInfoList List of Content Type information.
ContentTypeList List of Content Types.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeInfoList media-type="application/vnd.ez.api.ContentTypeInfoList+xml" href="/api/ezp/v2/content/typegroups/1/types">
    <ContentTypeInfo media-type="application/vnd.ez.api.ContentTypeInfo+xml" href="/api/ezp/v2/content/types/2">
        <id>2</id>
        <status>DEFINED</status>
        <identifier>article</identifier>
        <names>
            <value languageCode="eng-GB">Article</value>
        </names>
        <descriptions/>
        <creationDate>2002-06-18T11:21:38+02:00</creationDate>
        <modificationDate>2004-04-20T11:56:29+02:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/2/groups"/>
        <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2/draft"/>
        <remoteId>c15b600eb9198b1924063b5a68758232</remoteId>
        <urlAliasSchema></urlAliasSchema>
        <nameSchema>&lt;short_title|title&gt;</nameSchema>
        <isContainer>true</isContainer>
        <mainLanguageCode>eng-GB</mainLanguageCode>
        <defaultAlwaysAvailable>false</defaultAlwaysAvailable>
        <defaultSortField>PATH</defaultSortField>
        <defaultSortOrder>ASC</defaultSortOrder>
    </ContentTypeInfo>
    <ContentTypeInfo media-type="application/vnd.ez.api.ContentTypeInfo+xml" href="/api/ezp/v2/content/types/1">
        <id>1</id>
        <status>DEFINED</status>
        <identifier>folder</identifier>
        <names>
            <value languageCode="eng-GB">Folder</value>
        </names>
        <descriptions/>
        <creationDate>2002-06-18T11:21:38+02:00</creationDate>
        <modificationDate>2015-11-29T22:14:32+01:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/1/groups"/>
        <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/1/draft"/>
        <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId>
        <urlAliasSchema></urlAliasSchema>
        <nameSchema>&lt;short_name|name&gt;</nameSchema>
        <isContainer>true</isContainer>
        <mainLanguageCode>eng-GB</mainLanguageCode>
        <defaultAlwaysAvailable>true</defaultAlwaysAvailable>
        <defaultSortField>PATH</defaultSortField>
        <defaultSortOrder>ASC</defaultSortOrder>
    </ContentTypeInfo>
</ContentTypeInfoList>

                                        

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeList media-type="application/vnd.ez.api.ContentTypeList+xml" href="/api/ezp/v2/content/typegroups/1/types">
    <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2">
        <id>2</id>
        <status>DEFINED</status>
        <identifier>article</identifier>
        <names>
            <value languageCode="eng-GB">Article</value>
        </names>
        <descriptions/>
        <creationDate>2002-06-18T11:21:38+02:00</creationDate>
        <modificationDate>2004-04-20T11:56:29+02:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/2/groups"/>
        <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2/draft"/>
        <remoteId>c15b600eb9198b1924063b5a68758232</remoteId>
        <urlAliasSchema></urlAliasSchema>
        <nameSchema>&lt;short_title|title&gt;</nameSchema>
        <isContainer>true</isContainer>
        <mainLanguageCode>eng-GB</mainLanguageCode>
        <defaultAlwaysAvailable>false</defaultAlwaysAvailable>
        <defaultSortField>PATH</defaultSortField>
        <defaultSortOrder>ASC</defaultSortOrder>
        <FieldDefinitions media-type="application/vnd.ez.api.FieldDefinitionList+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions">
            <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/1">
                <id>1</id>
                <identifier>title</identifier>
                <fieldType>ezstring</fieldType>
                <fieldGroup></fieldGroup>
                <position>1</position>
                <isTranslatable>true</isTranslatable>
                <isRequired>true</isRequired>
                <isInfoCollector>false</isInfoCollector>
                <defaultValue>New article</defaultValue>
                <isSearchable>true</isSearchable>
                <names>
                    <value languageCode="eng-GB">Title</value>
                </names>
                <descriptions/>
                <fieldSettings/>
                <validatorConfiguration>
                    <value key="StringLengthValidator">
                        <value key="maxStringLength">255</value>
                        <value key="minStringLength"/></value>
                </validatorConfiguration>
            </FieldDefinition>
            <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/152">
                <id>152</id>
                <identifier>short_title</identifier>
                <fieldType>ezstring</fieldType>
                <fieldGroup></fieldGroup>
                <position>2</position>
                <isTranslatable>true</isTranslatable>
                <isRequired>false</isRequired>
                <isInfoCollector>false</isInfoCollector>
                <defaultValue/>
                <isSearchable>true</isSearchable>
                <names>
                    <value languageCode="eng-GB">Short title</value>
                </names>
                <descriptions/>
                <fieldSettings/>
                <validatorConfiguration>
                    <value key="StringLengthValidator">
                        <value key="maxStringLength">255</value>
                        <value key="minStringLength"/></value>
                </validatorConfiguration>
            </FieldDefinition>
            <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/153">
                <id>153</id>
                <identifier>author</identifier>
                <fieldType>ezauthor</fieldType>
                <fieldGroup></fieldGroup>
                <position>3</position>
                <isTranslatable>true</isTranslatable>
                <isRequired>false</isRequired>
                <isInfoCollector>false</isInfoCollector>
                <defaultValue/>
                <isSearchable>false</isSearchable>
                <names>
                    <value languageCode="eng-GB">Author</value>
                </names>
                <descriptions/>
                <fieldSettings>
                    <value key="defaultAuthor">1</value>
                </fieldSettings>
                <validatorConfiguration/>
            </FieldDefinition>
            <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/120">
                <id>120</id>
                <identifier>intro</identifier>
                <fieldType>ezrichtext</fieldType>
                <fieldGroup></fieldGroup>
                <position>4</position>
                <isTranslatable>true</isTranslatable>
                <isRequired>true</isRequired>
                <isInfoCollector>false</isInfoCollector>
                <defaultValue>
                    <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; version=&quot;5.0-variant ezpublish-1.0&quot;/&gt;
</value>
                    <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;/&gt;
</value>
                </defaultValue>
                <isSearchable>true</isSearchable>
                <names>
                    <value languageCode="eng-GB">Intro</value>
                </names>
                <descriptions/>
                <fieldSettings/>
                <validatorConfiguration/>
            </FieldDefinition>
            <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/121">
                <id>121</id>
                <identifier>body</identifier>
                <fieldType>ezrichtext</fieldType>
                <fieldGroup></fieldGroup>
                <position>5</position>
                <isTranslatable>true</isTranslatable>
                <isRequired>false</isRequired>
                <isInfoCollector>false</isInfoCollector>
                <defaultValue>
                    <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; version=&quot;5.0-variant ezpublish-1.0&quot;/&gt;
</value>
                    <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;/&gt;
</value>
                </defaultValue>
                <isSearchable>true</isSearchable>
                <names>
                    <value languageCode="eng-GB">Body</value>
                </names>
                <descriptions/>
                <fieldSettings/>
                <validatorConfiguration/>
            </FieldDefinition>
            <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/123">
                <id>123</id>
                <identifier>enable_comments</identifier>
                <fieldType>ezboolean</fieldType>
                <fieldGroup></fieldGroup>
                <position>6</position>
                <isTranslatable>false</isTranslatable>
                <isRequired>false</isRequired>
                <isInfoCollector>false</isInfoCollector>
                <defaultValue>false</defaultValue>
                <isSearchable>false</isSearchable>
                <names>
                    <value languageCode="eng-GB">Enable comments</value>
                </names>
                <descriptions/>
                <fieldSettings/>
                <validatorConfiguration/>
            </FieldDefinition>
            <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/154">
                <id>154</id>
                <identifier>image</identifier>
                <fieldType>ezobjectrelation</fieldType>
                <fieldGroup></fieldGroup>
                <position>7</position>
                <isTranslatable>true</isTranslatable>
                <isRequired>false</isRequired>
                <isInfoCollector>false</isInfoCollector>
                <defaultValue>
                    <value key="destinationContentId"/>
                </defaultValue>
                <isSearchable>true</isSearchable>
                <names>
                    <value languageCode="eng-GB">Image</value>
                </names>
                <descriptions/>
                <fieldSettings>
                    <value key="selectionMethod">SELECTION_BROWSE</value>
                    <value key="selectionRoot"></value>
                    <value key="selectionContentTypes"/>
                </fieldSettings>
                <validatorConfiguration/>
            </FieldDefinition>
        </FieldDefinitions>
    </ContentType>
</ContentTypeList>

                                        
Create Content Type

POST /content/typegroups/{contentTypeGroupId}/types

Creates a new Content Type draft in the given Content Type group.

Header parameters

Accept

If set, the new Content Type or draft is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentType+xml application/vnd.ez.api.ContentType+json

Content-Type

The Content Type Create schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeCreate+xml application/vnd.ez.api.ContentTypeCreate+json
Query parameters
Property Type Value
publish boolean If true, the Content Type is published after creating (default false).
Possible responses
Code Description
201

Content Type created.

400

Error - The input does not match the input schema definition. Validation on a Field definition fails. Validation of the Content Type fails, e.g. multiple Fields of a same singular Field Type are provided. Publish is set to true and the input is not complete e.g. no Field definitions are provided.

401

Error - The user is not authorized to create this Content Type.

403

Error - A Content Type with same identifier already exists.

Types
Request
Media type application/vnd.ez.api.ContentTypeCreate.xml
Schema ContentTypeCreate * : ContentTypeCreate
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/20/draft">
    <id>20</id>
    <status>DRAFT</status>
    <identifier>newContentType</identifier>
    <names>
        <value languageCode="eng-GB">New Content Type</value>
    </names>
    <descriptions>
        <value languageCode="eng-GB">This is a description</value>
    </descriptions>
    <creationDate>2019-02-26T09:39:58+01:00</creationDate>
    <modificationDate>2019-02-26T09:39:58+01:00</modificationDate>
    <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/20/groups"/>
    <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/20/draft"/>
    <remoteId>remoteId-qwert548</remoteId>
    <urlAliasSchema>&lt;title&gt;</urlAliasSchema>
    <nameSchema>&lt;title&gt;</nameSchema>
    <isContainer>true</isContainer>
    <mainLanguageCode>eng-GB</mainLanguageCode>
    <defaultAlwaysAvailable>true</defaultAlwaysAvailable>
    <defaultSortField>PATH</defaultSortField>
    <defaultSortOrder>ASC</defaultSortOrder>
    <FieldDefinitions media-type="application/vnd.ez.api.FieldDefinitionList+xml" href="/api/ezp/v2/content/types/20/draft/fieldDefinitions">
        <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/20/draft/fieldDefinitions/223">
            <id>223</id>
            <identifier>title</identifier>
            <fieldType>ezstring</fieldType>
            <fieldGroup>content</fieldGroup>
            <position>1</position>
            <isTranslatable>true</isTranslatable>
            <isRequired>true</isRequired>
            <isInfoCollector>false</isInfoCollector>
            <defaultValue>New Title</defaultValue>
            <isSearchable>true</isSearchable>
            <names>
                <value languageCode="eng-GB">Title</value>
            </names>
            <descriptions>
                <value languageCode="eng-GB">This is the title</value>
            </descriptions>
            <fieldSettings/>
            <validatorConfiguration>
                <value key="StringLengthValidator">
                    <value key="minStringLength">0</value>
                    <value key="maxStringLength"/></value>
            </validatorConfiguration>
        </FieldDefinition>
    </FieldDefinitions>
</ContentType>

                                        

/content/types

/content/types

List Content Types

GET /content/types

Returns a list of Content Types.

Header parameters

Accept

If set, the list of Content Type info objects or Content Types (including Field definitions) is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeInfoList+xml application/vnd.ez.api.ContentTypeInfoList+json application/vnd.ez.api.ContentTypeList+xml application/vnd.ez.api.ContentTypeList+json
Query parameters
Property Type Value
identifier string Retrieves the Content Type for the given identifer.
remoteId string Retrieves the Content Type for the given remote ID.
limit string Only 'limit' items will be returned, starting with the offset.
offset string Offset of the result set.
orderby string One of (name|lastmodified).
sort string One of (asc|desc).
Possible responses
Code Description
200

OK - returns a list of Content Types.

401

Error - The user has no permission to read the Content Types.

Types
Type Description
ContentTypeInfoList List of Content Type information.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeInfoList media-type="application/vnd.ez.api.ContentTypeInfoList+xml" href="/api/ezp/v2/content/types">
    <ContentTypeInfo media-type="application/vnd.ez.api.ContentTypeInfo+xml" href="/api/ezp/v2/content/types/2">
        <id>2</id>
        <status>DEFINED</status>
        <identifier>article</identifier>
        <names>
            <value languageCode="eng-GB">Article</value>
        </names>
        <descriptions/>
        <creationDate>2002-06-18T11:21:38+02:00</creationDate>
        <modificationDate>2004-04-20T11:56:29+02:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/2/groups"/>
        <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2/draft"/>
        <remoteId>c15b600eb9198b1924063b5a68758232</remoteId>
        <urlAliasSchema></urlAliasSchema>
        <nameSchema>&lt;short_title|title&gt;</nameSchema>
        <isContainer>true</isContainer>
        <mainLanguageCode>eng-GB</mainLanguageCode>
        <defaultAlwaysAvailable>false</defaultAlwaysAvailable>
        <defaultSortField>PATH</defaultSortField>
        <defaultSortOrder>ASC</defaultSortOrder>
    </ContentTypeInfo>
    <ContentTypeInfo media-type="application/vnd.ez.api.ContentTypeInfo+xml" href="/api/ezp/v2/content/types/13">
        <id>13</id>
        <status>DEFINED</status>
        <identifier>copy_of_article_13</identifier>
        <names>
            <value languageCode="eng-GB">Article</value>
        </names>
        <descriptions/>
        <creationDate>2019-02-06T10:55:12+01:00</creationDate>
        <modificationDate>2019-02-06T10:55:12+01:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/13/groups"/>
        <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/13/draft"/>
        <remoteId>b045340aaa8a7a1111f5a6bed6e70715</remoteId>
        <urlAliasSchema></urlAliasSchema>
        <nameSchema>&lt;short_title|title&gt;</nameSchema>
        <isContainer>true</isContainer>
        <mainLanguageCode>eng-GB</mainLanguageCode>
        <defaultAlwaysAvailable>false</defaultAlwaysAvailable>
        <defaultSortField>PATH</defaultSortField>
        <defaultSortOrder>ASC</defaultSortOrder>
    </ContentTypeInfo>
    <ContentTypeInfo media-type="application/vnd.ez.api.ContentTypeInfo+xml" href="/api/ezp/v2/content/types/14">
        <id>14</id>
        <status>DEFINED</status>
        <identifier>copy_of_article_14</identifier>
        <names>
            <value languageCode="eng-GB">Article</value>
        </names>
        <descriptions/>
        <creationDate>2019-02-06T10:56:36+01:00</creationDate>
        <modificationDate>2019-02-06T10:56:36+01:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/14/groups"/>
        <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/14/draft"/>
        <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId>
        <urlAliasSchema></urlAliasSchema>
        <nameSchema>&lt;short_title|title&gt;</nameSchema>
        <isContainer>true</isContainer>
        <mainLanguageCode>eng-GB</mainLanguageCode>
        <defaultAlwaysAvailable>false</defaultAlwaysAvailable>
        <defaultSortField>PATH</defaultSortField>
        <defaultSortOrder>ASC</defaultSortOrder>
    </ContentTypeInfo>
    <ContentTypeInfo media-type="application/vnd.ez.api.ContentTypeInfo+xml" href="/api/ezp/v2/content/types/1">
        <id>1</id>
        <status>DEFINED</status>
        <identifier>folder</identifier>
        <names>
            <value languageCode="eng-GB">Folder</value>
        </names>
        <descriptions/>
        <creationDate>2002-06-18T11:21:38+02:00</creationDate>
        <modificationDate>2015-11-29T22:14:32+01:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/1/groups"/>
        <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/1/draft"/>
        <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId>
        <urlAliasSchema></urlAliasSchema>
        <nameSchema>&lt;short_name|name&gt;</nameSchema>
        <isContainer>true</isContainer>
        <mainLanguageCode>eng-GB</mainLanguageCode>
        <defaultAlwaysAvailable>true</defaultAlwaysAvailable>
        <defaultSortField>PATH</defaultSortField>
        <defaultSortOrder>ASC</defaultSortOrder>
    </ContentTypeInfo>
    <ContentTypeInfo media-type="application/vnd.ez.api.ContentTypeInfo+xml" href="/api/ezp/v2/content/types/4">
        <id>4</id>
        <status>DEFINED</status>
        <identifier>user</identifier>
        <names>
            <value languageCode="eng-GB">User</value>
        </names>
        <descriptions/>
        <creationDate>2002-06-18T11:21:38+02:00</creationDate>
        <modificationDate>2004-04-15T10:39:24+02:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/4/groups"/>
        <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/4/draft"/>
        <remoteId>40faa822edc579b02c25f6bb7beec3ad</remoteId>
        <urlAliasSchema></urlAliasSchema>
        <nameSchema>&lt;first_name&gt; &lt;last_name&gt;</nameSchema>
        <isContainer>false</isContainer>
        <mainLanguageCode>eng-GB</mainLanguageCode>
        <defaultAlwaysAvailable>true</defaultAlwaysAvailable>
        <defaultSortField>PATH</defaultSortField>
        <defaultSortOrder>ASC</defaultSortOrder>
    </ContentTypeInfo>

</ContentTypeInfoList>

                                        

/content/types/{contentTypeId}

Get Content Type

GET /content/types/{contentTypeId}

Returns the Content Type with the provided ID.

Header parameters

Accept

If set, the Content Type is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentType+xml application/vnd.ez.api.ContentType+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - returns the Content Type.

401

Error - The user is not authorized to read this Content Type.

404

Error - The Content Type does not exist.

Types
Type Description
ContentType
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2">
    <id>2</id>
    <status>DEFINED</status>
    <identifier>article</identifier>
    <names>
        <value languageCode="eng-GB">Article</value>
    </names>
    <descriptions/>
    <creationDate>2002-06-18T11:21:38+02:00</creationDate>
    <modificationDate>2004-04-20T11:56:29+02:00</modificationDate>
    <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/2/groups"/>
    <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/2/draft"/>
    <remoteId>c15b600eb9198b1924063b5a68758232</remoteId>
    <urlAliasSchema></urlAliasSchema>
    <nameSchema>&lt;short_title|title&gt;</nameSchema>
    <isContainer>true</isContainer>
    <mainLanguageCode>eng-GB</mainLanguageCode>
    <defaultAlwaysAvailable>false</defaultAlwaysAvailable>
    <defaultSortField>PATH</defaultSortField>
    <defaultSortOrder>ASC</defaultSortOrder>
    <FieldDefinitions media-type="application/vnd.ez.api.FieldDefinitionList+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions">
        <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/1">
            <id>1</id>
            <identifier>title</identifier>
            <fieldType>ezstring</fieldType>
            <fieldGroup></fieldGroup>
            <position>1</position>
            <isTranslatable>true</isTranslatable>
            <isRequired>true</isRequired>
            <isInfoCollector>false</isInfoCollector>
            <defaultValue>New article</defaultValue>
            <isSearchable>true</isSearchable>
            <names>
                <value languageCode="eng-GB">Title</value>
            </names>
            <descriptions/>
            <fieldSettings/>
            <validatorConfiguration>
                <value key="StringLengthValidator">
                    <value key="maxStringLength">255</value>
                    <value key="minStringLength"/></value>
            </validatorConfiguration>
        </FieldDefinition>
        <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/152">
            <id>152</id>
            <identifier>short_title</identifier>
            <fieldType>ezstring</fieldType>
            <fieldGroup></fieldGroup>
            <position>2</position>
            <isTranslatable>true</isTranslatable>
            <isRequired>false</isRequired>
            <isInfoCollector>false</isInfoCollector>
            <defaultValue/>
            <isSearchable>true</isSearchable>
            <names>
                <value languageCode="eng-GB">Short title</value>
            </names>
            <descriptions/>
            <fieldSettings/>
            <validatorConfiguration>
                <value key="StringLengthValidator">
                    <value key="maxStringLength">255</value>
                    <value key="minStringLength"/></value>
            </validatorConfiguration>
        </FieldDefinition>
        <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/153">
            <id>153</id>
            <identifier>author</identifier>
            <fieldType>ezauthor</fieldType>
            <fieldGroup></fieldGroup>
            <position>3</position>
            <isTranslatable>true</isTranslatable>
            <isRequired>false</isRequired>
            <isInfoCollector>false</isInfoCollector>
            <defaultValue/>
            <isSearchable>false</isSearchable>
            <names>
                <value languageCode="eng-GB">Author</value>
            </names>
            <descriptions/>
            <fieldSettings>
                <value key="defaultAuthor">1</value>
            </fieldSettings>
            <validatorConfiguration/>
        </FieldDefinition>
        <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/120">
            <id>120</id>
            <identifier>intro</identifier>
            <fieldType>ezrichtext</fieldType>
            <fieldGroup></fieldGroup>
            <position>4</position>
            <isTranslatable>true</isTranslatable>
            <isRequired>true</isRequired>
            <isInfoCollector>false</isInfoCollector>
            <defaultValue>
                <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; version=&quot;5.0-variant ezpublish-1.0&quot;/&gt;
</value>
                <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;/&gt;
</value>
            </defaultValue>
            <isSearchable>true</isSearchable>
            <names>
                <value languageCode="eng-GB">Intro</value>
            </names>
            <descriptions/>
            <fieldSettings/>
            <validatorConfiguration/>
        </FieldDefinition>
        <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/121">
            <id>121</id>
            <identifier>body</identifier>
            <fieldType>ezrichtext</fieldType>
            <fieldGroup></fieldGroup>
            <position>5</position>
            <isTranslatable>true</isTranslatable>
            <isRequired>false</isRequired>
            <isInfoCollector>false</isInfoCollector>
            <defaultValue>
                <value key="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://docbook.org/ns/docbook&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; version=&quot;5.0-variant ezpublish-1.0&quot;/&gt;
</value>
                <value key="xhtml5edit">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;section xmlns=&quot;http://ez.no/namespaces/ezpublish5/xhtml5/edit&quot;/&gt;
</value>
            </defaultValue>
            <isSearchable>true</isSearchable>
            <names>
                <value languageCode="eng-GB">Body</value>
            </names>
            <descriptions/>
            <fieldSettings/>
            <validatorConfiguration/>
        </FieldDefinition>
        <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/123">
            <id>123</id>
            <identifier>enable_comments</identifier>
            <fieldType>ezboolean</fieldType>
            <fieldGroup></fieldGroup>
            <position>6</position>
            <isTranslatable>false</isTranslatable>
            <isRequired>false</isRequired>
            <isInfoCollector>false</isInfoCollector>
            <defaultValue>false</defaultValue>
            <isSearchable>false</isSearchable>
            <names>
                <value languageCode="eng-GB">Enable comments</value>
            </names>
            <descriptions/>
            <fieldSettings/>
            <validatorConfiguration/>
        </FieldDefinition>
        <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/2/fieldDefinitions/154">
            <id>154</id>
            <identifier>image</identifier>
            <fieldType>ezobjectrelation</fieldType>
            <fieldGroup></fieldGroup>
            <position>7</position>
            <isTranslatable>true</isTranslatable>
            <isRequired>false</isRequired>
            <isInfoCollector>false</isInfoCollector>
            <defaultValue>
                <value key="destinationContentId"/>
            </defaultValue>
            <isSearchable>true</isSearchable>
            <names>
                <value languageCode="eng-GB">Image</value>
            </names>
            <descriptions/>
            <fieldSettings>
                <value key="selectionMethod">SELECTION_BROWSE</value>
                <value key="selectionRoot"></value>
                <value key="selectionContentTypes"/>
            </fieldSettings>
            <validatorConfiguration/>
        </FieldDefinition>
    </FieldDefinitions>
</ContentType>

                                        
Copy Content Type

COPY /content/types/{contentTypeId}

Copies a Content Type. A new remote ID is generated, and the identifier of the copy is set to 'copy_of_originalBaseIdentifier_newTypeId' (or another random string). COPY or POST with header X-HTTP-Method-Override COPY.

Possible responses
Code Description
201

Copy of the Content Type created.

401

Error - The user is not authorized to copy this Content Type.

Create Draft

POST /content/types/{contentTypeId}

Creates a draft and updates it with the given data.

Header parameters

Accept

If set, the new Content Type draft is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeInfo+xml application/vnd.ez.api.ContentTypeInfo+json

Content-Type

The Content Type Update schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeUpdate+xml application/vnd.ez.api.ContentTypeUpdate+json
Possible responses
Code Description
201

Draft created.

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to create the draft.

403

Error - A Content Type with the given new identifier already exists. A draft already exists.

Types
Type Description
ContentTypeUpdate
ContentTypeInfo This class stores Content Type information.
Request
Media type application/vnd.ez.api.ContentTypeUpdate+xml
Schema ContentTypeUpdate * : ContentTypeUpdate
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeInfo media-type="application/vnd.ez.api.ContentTypeInfo+xml" href="/api/ezp/v2/content/types/3/draft">
    <id>3</id>
    <status>DRAFT</status>
    <identifier>user_group</identifier>
    <names>
        <value languageCode="eng-GB">User group</value>
    </names>
    <descriptions/>
    <creationDate>2002-06-18T11:21:38+02:00</creationDate>
    <modificationDate>2019-02-25T14:41:53+01:00</modificationDate>
    <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/3/groups"/>
    <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/3/draft"/>
    <remoteId>25b4268cdcd01921b808a0d854b877ef</remoteId>
    <urlAliasSchema></urlAliasSchema>
    <nameSchema>&lt;name&gt;</nameSchema>
    <isContainer>true</isContainer>
    <mainLanguageCode>eng-GB</mainLanguageCode>
    <defaultAlwaysAvailable>true</defaultAlwaysAvailable>
    <defaultSortField>PATH</defaultSortField>
    <defaultSortOrder>ASC</defaultSortOrder>
</ContentTypeInfo>

                                        
Delete Content Type

DELETE /content/types/{contentTypeId}

Deletes the provided Content Type.

Possible responses
Code Description
204

No Content - Content Type deleted.

401

Error - The user is not authorized to delete this Content Type.

403

Error - There are object instances of this Content Type.

404

Error - The Content Type does not exist.

/content/types/{contentTypeId}/{fieldDefinitionId}

Get Field definition

GET /content/types/{contentTypeId}/{fieldDefinitionId}

Returns the Field definition by the given ID.

Header parameters

Accept

If set, the Field definition is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.FieldDefinition+xml application/vnd.ez.api.FieldDefinition+json
Possible responses
Code Description
200

OK - returns the Field definition.

401

Error - The user is not authorized to read the Content Type.

404

Error - The Content Type does not exist.

Types
Type Description
FieldDefinition This class represents a Field definition.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/15/fieldDefinitions/195">
    <id>195</id>
    <identifier>title</identifier>
    <fieldType>ezstring</fieldType>
    <fieldGroup></fieldGroup>
    <position>1</position>
    <isTranslatable>true</isTranslatable>
    <isRequired>true</isRequired>
    <isInfoCollector>false</isInfoCollector>
    <defaultValue>New article</defaultValue>
    <isSearchable>true</isSearchable>
    <names>
        <value languageCode="eng-GB">Title</value>
    </names>
    <descriptions/>
    <fieldSettings/>
    <validatorConfiguration>
        <value key="StringLengthValidator">
            <value key="maxStringLength">255</value>
            <value key="minStringLength"/></value>
    </validatorConfiguration>
</FieldDefinition>

                                        

/content/types/{contentTypeId}/draft

Update Content Type draft

PATCH /content/types/{contentTypeId}/draft

Updates metadata of a draft. This method does not handle Field definitions. PATCH or POST with header X-HTTP-Method-Override PATCH.

Header parameters

Accept

If set, the new Content Type draft is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeInfo+xml application/vnd.ez.api.ContentTypeInfo+json

Content-Type

The Content Type update schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeUpdate+xml application/vnd.ez.api.ContentTypeUpdate+json
Possible responses
Code Description
200

Draft metadata updated.

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to update the draft.

403

Error - A Content Type with the given new identifier already exists.

404

Error - There is no draft for this Content Type.

Types
Type Description
ContentTypeUpdate
ContentTypeInfo This class stores Content Type information.
Request
Media type application/vnd.ez.api.ContentTypeUpdate+xml
Schema ContentTypeUpdate * : ContentTypeUpdate
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeInfo media-type="application/vnd.ez.api.ContentTypeInfo+xml" href="/api/ezp/v2/content/types/14/draft">
    <id>14</id>
    <status>DRAFT</status>
    <identifier>new_content_type</identifier>
    <names>
        <value languageCode="eng-GB">Updated Content Type name</value>
    </names>
    <descriptions>
        <value languageCode="eng-GB">This is an updated Content Type description</value>
    </descriptions>
    <creationDate>2019-02-06T10:56:36+01:00</creationDate>
    <modificationDate>2019-02-25T12:15:51+01:00</modificationDate>
    <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/14/groups"/>
    <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/14/draft"/>
    <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId>
    <urlAliasSchema></urlAliasSchema>
    <nameSchema>&lt;short_title|title&gt;</nameSchema>
    <isContainer>true</isContainer>
    <mainLanguageCode>eng-GB</mainLanguageCode>
    <defaultAlwaysAvailable>false</defaultAlwaysAvailable>
    <defaultSortField>PATH</defaultSortField>
    <defaultSortOrder>ASC</defaultSortOrder>
</ContentTypeInfo>

                                        
Publish Content Type draft

PUBLISH /content/types/{contentTypeId}/draft

Publishes a Content Type draft. PUBLISH or POST with header X-HTTP-Method-Override PUBLISH.

Possible responses
Code Description
200

Content Type draft published.

401

Error - The user is not authorized to publish this Content Type draft.

403

Error - The Content Type draft is not complete, e.g. there is no Field definition provided.

404

Error - If there is no draft or Content Type with the given ID.

Types
Type Description
ContentType
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/14">
    <id>14</id>
    <status>DEFINED</status>
    <identifier>copy_of_article_14</identifier>
    <names>
        <value languageCode="eng-GB">Updated Content Type name</value>
    </names>
    <descriptions>
        <value languageCode="eng-GB">This is an updated Content Type description</value>
    </descriptions>
    <creationDate>2019-02-06T10:56:36+01:00</creationDate>
    <modificationDate>2019-02-25T12:15:51+01:00</modificationDate>
    <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <Groups media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/types/14/groups"/>
    <Draft media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/14/draft"/>
    <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId>
    <urlAliasSchema></urlAliasSchema>
    <nameSchema>&lt;short_title|title&gt;</nameSchema>
    <isContainer>true</isContainer>
    <mainLanguageCode>eng-GB</mainLanguageCode>
    <defaultAlwaysAvailable>false</defaultAlwaysAvailable>
    <defaultSortField>PATH</defaultSortField>
    <defaultSortOrder>ASC</defaultSortOrder>
    <FieldDefinitions media-type="application/vnd.ez.api.FieldDefinitionList+xml" href="/api/ezp/v2/content/types/14/fieldDefinitions">
        <FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/14/fieldDefinitions/188">
            <id>188</id>
            <identifier>title</identifier>
            <fieldType>ezstring</fieldType>
            <fieldGroup></fieldGroup>
            <position>1</position>
            <isTranslatable>true</isTranslatable>
            <isRequired>true</isRequired>
            <isInfoCollector>false</isInfoCollector>
            <defaultValue>New article</defaultValue>
            <isSearchable>true</isSearchable>
            <names>
                <value languageCode="eng-GB">Title</value>
            </names>
            <descriptions/>
            <fieldSettings/>
            <validatorConfiguration>
                <value key="StringLengthValidator">
                    <value key="maxStringLength">255</value>
                    <value key="minStringLength"/></value>
            </validatorConfiguration>
        </FieldDefinition>
        </FieldDefinitions>
</ContentType>

                                        
Delete Content Type draft

DELETE /content/types/{contentTypeId}/draft

Deletes the provided Content Type draft.

Possible responses
Code Description
204

No Content - Content Type draft deleted.

401

Error - The user is not authorized to delete this Content Type draft.

404

Error - The Content Type draft does not exist.

/content/types/{contentTypeId}/draft/fieldDefinitions

Add Content Type Draft Field definition

POST /content/types/{contentTypeId}/draft/fieldDefinitions

Creates a new Field definition for the given Content Type.

Header parameters

Accept

If set, the new Field definition is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.FieldDefinition+xml application/vnd.ez.api.FieldDefinition+json

Content-Type

The Field Definition Create schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.FieldDefinitionCreate+xml application/vnd.ez.api.FieldDefinitionCreate+json
Possible responses
Code Description
201

Field definition created.

400

Error - The input does not match the input schema definition or validation on the Field definition fails.

401

Error - The user is not authorized to add a Field definition.

403

Error - A Field definition with the same identifier already exists in the given Content Type. The Field definition is of singular type, already existing in the given Content Type. The Field definition you want to add is of a type that can't be added to a Content Type that already has content instances.

Types
Type Description
FieldDefinitionCreate
FieldDefinition This class represents a Field definition.
Request
Media type application/vnd.ez.api.FieldDefinitionCreate+xml
Schema FieldDefinitionCreate * : FieldDefinitionCreate
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/14/draft/fieldDefinitions/221">
    <id>221</id>
    <identifier>name2</identifier>
    <fieldType>ezstring</fieldType>
    <fieldGroup></fieldGroup>
    <position>0</position>
    <isTranslatable>true</isTranslatable>
    <isRequired>true</isRequired>
    <isInfoCollector>false</isInfoCollector>
    <defaultValue/>
    <isSearchable>true</isSearchable>
    <names/>
    <descriptions/>
    <fieldSettings/>
    <validatorConfiguration>
        <value key="StringLengthValidator">
            <value key="maxStringLength">32</value>
            <value key="minStringLength">8</value>
        </value>
    </validatorConfiguration>
</FieldDefinition>

                                        

/content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}

Get Content Type Draft Field definition

GET /content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}

Returns the Field definition by the given ID.

Header parameters

Accept

If set, the Field definition is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.FieldDefinition+xml application/vnd.ez.api.FieldDefinition+json
Possible responses
Code Description
200

OK - returns the Field definition.

401

Error - The user is not authorized to read the Content Type draft.

404

Error - The Content Type or draft does not exist.

Types
Type Description
FieldDefinition This class represents a Field definition.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/15/draft/fieldDefinitions/195">
    <id>195</id>
    <identifier>title</identifier>
    <fieldType>ezstring</fieldType>
    <fieldGroup></fieldGroup>
    <position>1</position>
    <isTranslatable>true</isTranslatable>
    <isRequired>true</isRequired>
    <isInfoCollector>false</isInfoCollector>
    <defaultValue>New article</defaultValue>
    <isSearchable>true</isSearchable>
    <names>
        <value languageCode="eng-GB">Title</value>
    </names>
    <descriptions/>
    <fieldSettings/>
    <validatorConfiguration>
        <value key="StringLengthValidator">
            <value key="maxStringLength">255</value>
            <value key="minStringLength"/></value>
    </validatorConfiguration>
</FieldDefinition>

                                        
Update Content Type Draft Field definition

PATCH /content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}

Updates the attributes of a Field definition.

Header parameters

Accept

If set, the updated Field definition is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.FieldDefinition+xml application/vnd.ez.api.FieldDefinition+json

Content-Type

The Field definition update schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.FieldDefinitionUpdate+xml application/vnd.ez.api.FieldDefinitionUpdate+json
Possible responses
Code Description
200

OK - attributes updated.

400

Error - The input does not match the input schema definition.

401

Error - The user is not authorized to update the Field definition.

403

Error - A Field definition with the given identifier already exists in the given Content Type.

Types
Type Description
FieldDefinitionUpdate
FieldDefinition This class represents a Field definition.
Request
Media type application/vnd.ez.api.FieldDefinitionUpdate+xml
Schema FieldDefinitionUpdate * : FieldDefinitionUpdate
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<FieldDefinition media-type="application/vnd.ez.api.FieldDefinition+xml" href="/api/ezp/v2/content/types/15/draft/fieldDefinitions/197">
    <id>197</id>
    <identifier>author</identifier>
    <fieldType>ezauthor</fieldType>
    <fieldGroup>new_field_group</fieldGroup>
    <position>10</position>
    <isTranslatable>true</isTranslatable>
    <isRequired>false</isRequired>
    <isInfoCollector>false</isInfoCollector>
    <defaultValue/>
    <isSearchable>false</isSearchable>
    <names>
        <value languageCode="eng-GB">Author</value>
    </names>
    <descriptions/>
    <fieldSettings>
        <value key="defaultAuthor">1</value>
    </fieldSettings>
    <validatorConfiguration/>
</FieldDefinition>

                                        
Delete Content Type Draft Field definition

DELETE /content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}

Deletes the provided Field definition.

Possible responses
Code Description
204

No Content - Field definition deleted.

401

Error - The user is not authorized to delete this Content Type.

403

Error - There is no draft of the Content Type assigned to the authenticated user.

/content/types/{contentTypeId}/groups

Get groups of Content Type

GET /content/types/{contentTypeId}/groups

Returns the Content Type group to which Content Type belongs to.

Header parameters

Accept

If set, the Content Type group list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ContentTypeGroupRefList+xml application/vnd.ez.api.ContentTypeGroupRefList+json
Possible responses
Code Description
200

401

Error - The user is not authorized to read this Content Type.

404

Error - The Content Type does not exist.

Types
Type Description
ContentTypeGroupRefList List of Content Type groups references.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroupRefList media-type="application/vnd.ez.api.ContentTypeGroupRefList+xml" href="/api/ezp/v2/content/typegroups/12/types">
    <ContentTypeGroupRef media-type="application/vnd.ez.api.ContentTypeGroup+xml" href="/api/ezp/v2/content/typegroups/3"/>
</ContentTypeGroupRefList>

                                        

/content/types/{contentTypeId}/groups/{id}

Views

/views

Create View

POST /views

Executes a query and returns a View including the results. The View input reflects the criteria model of the public API.

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.View+xml application/vnd.ez.api.View+json application/vnd.ez.api.View+xml; version=1.1 application/vnd.ez.api.View+json; version=1.1

Content-Type

The view input in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.ViewInput+xml application/vnd.ez.api.ViewInput+json application/vnd.ez.api.ViewInput+xml; version=1.1 application/vnd.ez.api.ViewInput+json; version=1.1
Possible responses
Code Description
200

400

Error - the input does not match the input schema definition.

Types
Type Description
ViewInput
View View.
Request
Media type application/vnd.ez.api.ViewInput+xml
Schema ViewInput * : ViewInput
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<View href="/views/TitleView" media-type="application/vnd.ez.api.View+xml; version=1.1">
  <identifier>TitleView</identifier>
  <User href="/user/users/14" media-type="vnd.ez.api.User+xml"/>
  <public>false</public>
  <LocationQuery>
    <Filter>
      <ParentLocationIdCriterion>2</ParentLocationIdCriterion>
    </Filter>
    <limit>10</limit>
    <offset>0</offset>
    <SortClauses>
      <ContentName>ascending</ContentName>
    </SortClauses>
    <FacetBuilders>
      <contentTypeFacetBuilder/>
    </FacetBuilders>
  </LocationQuery>
  <Result href="/content/views/view1234/results"
    media-type="application/vnd.ez.api.ViewResult+xml" count="34" time="31" maxScore="1.0">
    <searchHits>
      <searchHit score="1.0" index="installid1234567890">
        <hightlight/>
        <value>
          <Location media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2">
            <id>2</id>
            <priority>0</priority>
            <hidden>false</hidden>
            <invisible>false</invisible>
            <ParentLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1"/>
            <pathString>/1/2/</pathString>
            <depth>1</depth>
            <childCount>8</childCount>
            <remoteId>f3e90596361e31d496d4026eb624c983</remoteId>
            <Children media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/locations/1/2/children"/>
            <Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/57"/>
            <sortField>PRIORITY</sortField>
            <sortOrder>ASC</sortOrder>
            <UrlAliases media-type="application/vnd.ez.api.UrlAliasRefList+xml" href="/api/ezp/v2/content/locations/1/2/urlaliases"/>
          </Location>

        </value>
      </searchHit>
      <!-- ... -->
    </searchHits>
    <facets>
      <contentTypeFacet>
        <contentTypeFacetEntry>
          <contentType href="/content/types/1"  media-type="application/vnd.ez.api.ContentType+xml"/>
          <count>3</count>
        </contentTypeFacetEntry>
        <contentTypeFacetEntry>
          <contentType href="/content/types/7"  media-type="application/vnd.ez.api.ContentType+xml"/>
          <count>9</count>
        </contentTypeFacetEntry>
        <contentTypeFacetEntry>
          <contentType href="/content/types/11"  media-type="application/vnd.ez.api.ContentType+xml"/>
          <count>1</count>
        </contentTypeFacetEntry>
        <contentTypeFacetEntry>
          <contentType href="/content/types/15"  media-type="application/vnd.ez.api.ContentType+xml"/>
          <count>8</count>
        </contentTypeFacetEntry>
      </contentTypeFacet>
    </facets>
  </Result>
</View>

                                        

Managing users

/user/groups

/user/groups

Load User Groups

GET /user/groups

Loads User Groups for either an an ID or a remote ID or a Role.

Header parameters

Accept

UserGroupList - If set, the User Group List is returned in XML or JSON format. UserGroupRefList - If set, the link list of User Group is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UserGroupList+xml application/vnd.ez.api.UserGroupList+json application/vnd.ez.api.UserGroupRefList+xml application/vnd.ez.api.UserGroupRefList+json
Query parameters
Property Type Value
roleId string Lists User Groups assigned to the given Role.
id string Retrieves the User Groups for the given ID.
remoteID string Retrieves the User Groups for the given remote ID.
Possible responses
Code Description
200

401

Error - the user has no permission to read User Groups.

Types
Type Description
UserGroupList
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<UserGroupList media-type="application/vnd.ez.api.UserGroupList+xml" href="/api/ezp/v2/user/groups">
<UserGroup media-type="application/vnd.ez.api.UserGroup+xml" href="/api/ezp/v2/user/groups/1/5/13/15" id="14" remoteId="1bb4fe25487f05527efa8bfd394cecc7">
    <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/4"/>
    <name>Administrator User</name>
    <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/14/versions"/>
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/2"/>
    <MainLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/5/13/15"/>
    <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/14/locations"/>
    <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <publishDate>2002-10-06T18:13:50+02:00</publishDate>
    <lastModificationDate>2011-03-25T15:07:04+01:00</lastModificationDate>
    <mainLanguageCode>eng-GB</mainLanguageCode>
    <alwaysAvailable>true</alwaysAvailable>
    <Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/14/versions/3">
        <VersionInfo>
            <id>499</id>
            <versionNo>3</versionNo>
            <status>PUBLISHED</status>
            <modificationDate>2011-03-25T15:07:04+01:00</modificationDate>
            <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
            <creationDate>2011-03-25T15:03:03+01:00</creationDate>
            <initialLanguageCode>eng-GB</initialLanguageCode>
            <languageCodes>eng-GB</languageCodes>
            <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
                <Language>
                    <languageCode>eng-GB</languageCode>
                </Language>
            </VersionTranslationInfo>
            <names>
                <value languageCode="eng-GB">Administrator User</value>
            </names>
            <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/14"/>
        </VersionInfo>
        <Fields>
            <field>
                <id>28</id>
                <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>
                <languageCode>eng-GB</languageCode>
                <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
                <fieldValue>Administrator</fieldValue>
            </field>
            <field>
                <id>29</id>
                <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>
                <languageCode>eng-GB</languageCode>
                <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
                <fieldValue>User</fieldValue>
            </field>
            <field>
                <id>30</id>
                <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier>
                <languageCode>eng-GB</languageCode>
                <fieldTypeIdentifier>ezuser</fieldTypeIdentifier>
                <fieldValue>
                    <value key="hasStoredLogin">true</value>
                    <value key="contentId">14</value>
                    <value key="login">admin</value>
                    <value key="email">nospam@ez.no</value>
                    <value key="enabled">true</value>
                    <value key="maxLogin">10</value>
                </fieldValue>
            </field>
            <field>
                <id>178</id>
                <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier>
                <languageCode>eng-GB</languageCode>
                <fieldTypeIdentifier>eztext</fieldTypeIdentifier>
                <fieldValue/>
            </field>
            <field>
                <id>180</id>
                <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>
                <languageCode>eng-GB</languageCode>
                <fieldTypeIdentifier>ezimage</fieldTypeIdentifier>
                <fieldValue/>
            </field>
        </Fields>
        <Relations media-type="application/vnd.ez.api.RelationList+xml" href="/api/ezp/v2/content/objects/14/versions/3/relations"/>
    </Version>
    <ParentUserGroup media-type="application/vnd.ez.api.UserGroup+xml" href="/api/ezp/v2/user/groups/1/5/13"/>
    <Subgroups media-type="application/vnd.ez.api.UserGroupList+xml" href="/api/ezp/v2/user/groups/1/5/13/15/subgroups"/>
    <Users media-type="application/vnd.ez.api.UserList+xml" href="/api/ezp/v2/user/groups/1/5/13/15/users"/>
    <Roles media-type="application/vnd.ez.api.RoleAssignmentList+xml" href="/api/ezp/v2/user/groups/1/5/13/15/roles"/>
</UserGroup>
</UserGroupList>

                                        

/user/groups/root

Get root User Group

GET /user/groups/root

Redirects to the root User Group.

Possible responses
Code Description
301

Moved permanently.

Load User Group

GET /user/groups/{path}

Loads User Groups for the given {path}.

Header parameters

Accept

If set, the new User Group is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UserGroup+xml application/vnd.ez.api.UserGroup+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - loads User Groups.

401

Error - the user has no permission to read User Groups.

404

Error - the User Group does not exist.

Types
Type Description
UserGroup This class represents a User group.
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<UserGroup media-type="application/vnd.ez.api.UserGroup+xml" href="/api/ezp/v2/user/groups/1/5/14" id="13" remoteId="3c160cca19fb135f83bd02d911f04db2">
    <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/3"/>
    <name>Editors</name>
    <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/13/versions"/>
    <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/2"/>
    <MainLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/5/14"/>
    <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/13/locations"/>
    <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
    <publishDate>2002-10-06T18:13:14+02:00</publishDate>
    <lastModificationDate>2002-10-06T18:13:14+02:00</lastModificationDate>
    <mainLanguageCode>eng-GB</mainLanguageCode>
    <alwaysAvailable>true</alwaysAvailable>
    <Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/13/versions/1">
        <VersionInfo>
            <id>441</id>
            <versionNo>1</versionNo>
            <status>PUBLISHED</status>
            <modificationDate>2002-10-06T18:13:14+02:00</modificationDate>
            <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
            <creationDate>2002-10-06T18:13:06+02:00</creationDate>
            <initialLanguageCode>eng-GB</initialLanguageCode>
            <languageCodes>eng-GB</languageCodes>
            <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
                <Language>
                    <languageCode>eng-GB</languageCode>
                </Language>
            </VersionTranslationInfo>
            <names>
                <value languageCode="eng-GB">Editors</value>
            </names>
            <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/13"/>
        </VersionInfo>
        <Fields>
            <field>
                <id>26</id>
                <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>
                <languageCode>eng-GB</languageCode>
                <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
                <fieldValue>Editors</fieldValue>
            </field>
            <field>
                <id>27</id>
                <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier>
                <languageCode>eng-GB</languageCode>
                <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
                <fieldValue/>
            </field>
        </Fields>
        <Relations media-type="application/vnd.ez.api.RelationList+xml" href="/api/ezp/v2/content/objects/13/versions/1/relations"/>
    </Version>
    <ParentUserGroup media-type="application/vnd.ez.api.UserGroup+xml" href="/api/ezp/v2/user/groups/1/5"/>
    <Subgroups media-type="application/vnd.ez.api.UserGroupList+xml" href="/api/ezp/v2/user/groups/1/5/14/subgroups"/>
    <Users media-type="application/vnd.ez.api.UserList+xml" href="/api/ezp/v2/user/groups/1/5/14/users"/>
    <Roles media-type="application/vnd.ez.api.RoleAssignmentList+xml" href="/api/ezp/v2/user/groups/1/5/14/roles"/>
</UserGroup>

                                        
Update User Group

PATCH /user/groups/{path}

Updates a User Group. PATCH or POST with header X-HTTP-Method-Override PATCH.

Header parameters

Accept

If set, the new User Group is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UserGroup+xml application/vnd.ez.api.UserGroup+json

Content-Type

The UserGroupUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UserGroupUpdate+json application/vnd.ez.api.UserGroupUpdate+xml

If-Match

Performs the PATCH only if the specified ETag is the current one. Otherwise a 412 is returned.

Property Value
Type string
Examples ETag
Possible responses
Code Description
200

OK - updated User Group.

400

Error - the input does not match the input schema definition.

401

Error - the user is not authorized to update the User Group.

412

Error - if the current ETag does not match with the one provided in the If-Match header.

Types
Type Description
UserGroupUpdate
UserGroup This class represents a User group.
Request
Media type application/vnd.ez.api.UserGroupUpdate+xml
Schema UserGroupUpdate * : UserGroupUpdate
Code: 200

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
 <UserGroup media-type="application/vnd.ez.api.UserGroup+xml" href="/api/ezp/v2/user/groups/1/5/65" id="57" remoteId="9819b9739e775b69f8d791cdc6cb4c34">
     <ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/3"/>
     <name>Editors</name>
     <Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/57/versions"/>
     <Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/2"/>
     <MainLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/5/65"/>
     <Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/57/locations"/>
     <Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
     <publishDate>2019-02-27T09:58:39+01:00</publishDate>
     <lastModificationDate>2019-02-27T09:58:39+01:00</lastModificationDate>
     <mainLanguageCode>eng-GB</mainLanguageCode>
     <alwaysAvailable>true</alwaysAvailable>
     <Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/57/versions/1">
         <VersionInfo>
             <id>512</id>
             <versionNo>1</versionNo>
             <status>PUBLISHED</status>
             <modificationDate>2019-02-27T09:58:39+01:00</modificationDate>
             <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
             <creationDate>2019-02-27T09:58:39+01:00</creationDate>
             <initialLanguageCode>eng-GB</initialLanguageCode>
             <languageCodes>eng-GB</languageCodes>
             <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
                 <Language>
                     <languageCode>eng-GB</languageCode>
                 </Language>
             </VersionTranslationInfo>
             <names>
                 <value languageCode="eng-GB">Editors</value>
             </names>
             <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/57"/>
         </VersionInfo>
         <Fields>
             <field>
                 <id>203</id>
                 <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>
                 <languageCode>eng-GB</languageCode>
                 <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
                 <fieldValue>Editors</fieldValue>
             </field>
             <field>
                 <id>204</id>
                 <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier>
                 <languageCode>eng-GB</languageCode>
                 <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
                 <fieldValue>editors</fieldValue>
             </field>
         </Fields>
         <Relations media-type="application/vnd.ez.api.RelationList+xml" href="/api/ezp/v2/content/objects/57/versions/1/relations"/>
     </Version>
     <ParentUserGroup media-type="application/vnd.ez.api.UserGroup+xml" href="/api/ezp/v2/user/groups/1/5"/>
     <Subgroups media-type="application/vnd.ez.api.UserGroupList+xml" href="/api/ezp/v2/user/groups/1/5/65/subgroups"/>
     <Users media-type="application/vnd.ez.api.UserList+xml" href="/api/ezp/v2/user/groups/1/5/65/users"/>
     <Roles media-type="application/vnd.ez.api.RoleAssignmentList+xml" href="/api/ezp/v2/user/groups/1/5/65/roles"/>
 </UserGroup>

                                        
Delete User Group

DELETE /user/groups/{path}

The given User Group is deleted.

Possible responses
Code Description
204

No content - the given User Group is deleted.

401

Error - the user is not authorized to delete this Content Type.

403

Error - the User Group is not empty.

Move User Group

MOVE /user/groups/{path}

Moves the User Group to another parent. MOVE or POST with header X-HTTP-Method-Override MOVE.

Header parameters

Destination

A parent group resource to which the Location is moved.

Property Value
Type string
Possible responses
Code Description
201

Created - moves the User Group to another parent.

401

Error - the user is not authorized to update the User Group.

403

Error - the new parent does not exist.

404

Error - the User Group does not exist.

/user/groups/{path}/users

Create User

POST /user/groups/{path}/users

Creates a new User in the given Group.

Header parameters

Accept

If set, the new User is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.User+xml application/vnd.ez.api.User+json

Content-Type

The UserCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ez.api.UserCreate+json application/vnd.ez.api.UserCreate+xml
Possible responses
Code Description
201

400

Error - the input does not match the input schema definition.

401

Error - the user is not authorized to create this User.

403

Error - a User with the same login already exists.

404

Error - the Group with the given ID does not exist.

Types
Type Description
UserCreate
User This class represents a User value.
Request
Media type application/vnd.ez.api.UserCreate+xml
Schema UserCreate * : UserCreate
Code: 201

file_copy

                                        <?xml version="1.0" encoding="UTF-8"?>
<User media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/59" id="59" remoteId="remoteId-qwert426">
<ContentType media-type="application/vnd.ez.api.ContentType+xml" href="/api/ezp/v2/content/types/4"/>
<name>Yura Rajzer</name>
<Versions media-type="application/vnd.ez.api.VersionList+xml" href="/api/ezp/v2/content/objects/59/versions"/>
<Section media-type="application/vnd.ez.api.Section+xml" href="/api/ezp/v2/content/sections/2"/>
<MainLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/5/65/67"/>
<Locations media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/objects/59/locations"/>
<Groups media-type="application/vnd.ez.api.UserGroupRefList+xml" href="/api/ezp/v2/user/users/59/groups"/>
<Owner media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
<publishDate>2019-02-27T11:23:42+01:00</publishDate>
<lastModificationDate>2019-02-27T11:23:42+01:00</lastModificationDate>
<mainLanguageCode>eng-GB</mainLanguageCode>
<alwaysAvailable>true</alwaysAvailable>
<Version media-type="application/vnd.ez.api.Version+xml" href="/api/ezp/v2/content/objects/59/versions/1">
    <VersionInfo>
        <id>515</id>
        <versionNo>1</versionNo>
        <status>PUBLISHED</status>
        <modificationDate>2019-02-27T11:23:42+01:00</modificationDate>
        <Creator media-type="application/vnd.ez.api.User+xml" href="/api/ezp/v2/user/users/14"/>
        <creationDate>2019-02-27T11:23:42+01:00</creationDate>
        <initialLanguageCode>eng-GB</initialLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <VersionTranslationInfo media-type="application/vnd.ez.api.VersionTranslationInfo+xml">
            <Language>
                <languageCode>eng-GB</languageCode>
            </Language>
        </VersionTranslationInfo>
        <names>
            <value languageCode="eng-GB">Yura Rajzer</value>
        </names>
        <Content media-type="application/vnd.ez.api.ContentInfo+xml" href="/api/ezp/v2/content/objects/59"/>
    </VersionInfo>
    <Fields>
        <field>
            <id>207</id>
            <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
            <fieldValue>Yura</fieldValue>
        </field>
        <field>
            <id>208</id>
            <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezstring</fieldTypeIdentifier>
            <fieldValue>Rajzer</fieldValue>
        </field>
        <field>
            <id>209</id>
            <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier>
            <languageCode>eng-GB</languageCode>
            <fieldTypeIdentifier>ezuser</fieldTypeIdent