3 Content
3.1 Overview
In the content module there are the root collections objects, locations, trash and sections
|
POST | GET | PATCH/PUT | DELETE | COPY | ||
/ | . | list root resources | . | . | |||
/content/objects | create new content | . | . | . | |||
/content/objects/<ID> | . | load content | update content meta data | delete content | copy content | ||
/content/objects/<ID>/<lang_code> | . | . | . | delete language from content | |||
/content/objects/<ID>/versions | . | load all versions (version infos) | . | . | |||
/content/objects/<ID>/currentversion | . | redirect to current v. | . | . | create draft from current version | ||
/content/objects/<ID>/versions/<no> | . | get a specific version | update a version/draft | delete version | create draft from version | ||
/content/objects/<ID>/versions/<no>/relations | create new relation | load relations of vers. | . | . | |||
/content/objects/<ID>/versions/<no>/relations/<ID> | . | load relation details | . | delete relation | |||
/content/objects/<ID>/locations | create location | load locations of cont- ent | . | . | |||
/content/locations | . | list/find locations | . | . | |||
/content/locations/<path> | . | load a location | update location | delete location | copy subtree | ||
/content/locations/<path>/children | . | load children | . | . | |||
/content/views | create view | list views | . | . | |||
/content/views/<ID> | . | get view | . | delete view | |||
/content/views/<ID>/results | . | get view results | . | . | |||
/content/sections | create section | list all sections | . | . | |||
/content/sections/<ID> | . | load section | update section | delete section | |||
/content/trash | . | list trash items | . | empty trash | |||
/content/trash/<ID> | . | load trash item | untrash item | delete from trsh | |||
/content/objectstategroups | create objectstate group | list objectstategroups | . | . | |||
/content/objectstategroups/<ID> | . | get objectstate group | update objectstategroup | delete osg. | |||
/content/objectstategroups/<ID>/objectstates | create object state | list object states | . | . | |||
/content/objectstategroups/<ID>/objectstates/<ID> | . | get object state | update objectstate | delete objectst. | |||
/content/objects/<ID>/objectstates | . | get object states of content | update objectstates of content | . | |||
/content/urlaliases | create url alias | list url aliases | . | . | |||
/content/urlaliases/<ID> | . | get url alias | . | delete url wc. | |||
/content/urlwildcards | create url wildcard | list url wildcards | . | . | |||
/content/urlwildcards/<ID> | . | get url wildcard | . | delete url wc. |
3.2 Specification
3.2.1 General Error Codes
(see also HTTP 1.1 Specification)
500: | The server encountered an unexpected condition which prevented it from fulfilling the request - e.g. database down etc. |
---|---|
501: | The requested method was not implemented yet |
404: | Requested resource was not found |
405: | The request method is not available. The available methods are returned for this resource |
406: | The request contains an Accept header which is not supported. |
3.2.2 List Root Resources
Resource: | / |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | list the root resources of the ez publish installation |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
Root
3.2.2.1 XML Example
GET / HTTP/1.1 Host: api.example.net Accept: application/vnd.ez.api.Root+xml
HTTP/1.1 200 OK Content-Type: application/vnd.ez.api.Root+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <Root> <content href="/content/objects" media-type=""/> <contentTypes href="/content/types" media-type="application/vnd.ez.api.ContentTypeInfoList+xml"/> <users href="/user/users" media-type="application/vnd.ez.api.UserRefList+xml"/> <roles href="/user/roles" media-type="application/vnd.ez.api.RoleList+xml"/> <rootLocation href="/content/locations/1" media-type="application/vnd.ez.api.Location+xml"/> <rootUserGroup href="/user/groups/1/3" media-type="application/vnd.ez.api.UserGroup+xml"/> <rootMediaFolder href="/content/locations/1/43" media-type="application/vnd.ez.api.Location+xml"/> <trash href="/content/trash" media-type="application/vnd.ez.api.LocationList+xml"/> <sections href="/content/sections" media-type="application/vnd.ez.api.SectionList+xml"/> <views href="/content/views" media-type="application/vnd.ez.api.RefList+xml"/> </Root>
3.2.2.2 JSON Example
GET / HTTP/1.1 Host: api.example.net Accept: application/vnd.ez.api.Root+json
HTTP/1.1 200 OK Content-Type: application/vnd.ez.api.Root+json Content-Length: xxx
{ "Root": { "content": { "_href": "/content/objects" }, "contentTypes": { "_href": "/content/types", "_media-type": "application/vnd.ez.api.ContentTypeInfoList+json" }, "users": { "_href": "/user/users", "_media-type": "application/vnd.ez.api.UserRefList+json" }, "roles": { "_href": "/user/roles", "_media-type": "application/vnd.ez.api.RoleList+json" }, "rootLocation": { "_href": "/content/locations/1", "_media-type": "application/vnd.ez.api.Location+json" }, "rootUserGroup": { "_href": "/user/groups/1/5", "_media-type": "application/vnd.ez.api.UserGroup+json" }, "rootMediaFolder": { "_href": "/content/locations/1/43", "_media-type": "application/vnd.ez.api.Location+json" } "trash": { "_href": "/content/trash", "_media-type": "application/vnd.ez.api.LocationList+json" }, "sections": { "_href": "/content/sections", "_media-type": "application/vnd.ez.api.SectionList+json" } "sections": { "_href": "/content/views", "_media-type": "application/vnd.ez.api.ViewList+json" } } }
3.2.3 Managing content
3.2.3.1 Creating Content
Resource: | /content/objects |
||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | POST |
||||||||||||||||||||||||||||
Description: | Creates a new content draft assigned to the authenticated user. If a different userId is given in the input it is assigned to the given user but this required special rights for the authenticated user (this is useful for content staging where the transfer process does not have to authenticate with the user which created the content object in the source server). The user has to publish the content if it should be visible. |
||||||||||||||||||||||||||||
Headers: |
|
||||||||||||||||||||||||||||
Response: |
HTTP/1.1 201 Created Location: /content/objects/<newID> ETag: "<new etag>" Accept-Patch: application/vnd.ez.api.ContentUpdate+(json|xml) Content-Type: <depending on accept header> Content-Length: <length>
Content
Error codes: |
|
---|
3.2.3.1.1 XML Example
POST /content/objects HTTP/1.1 Host: www.example.net Accept: application/vnd.ez.api.Content+xml Content-Type: application/vnd.ez.api.ContentCreate+xml Content-Length: xxx
<ContentCreate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ContentType href="/content/types/10"/> <mainLanguageCode>eng-US</mainLanguageCode> <LocationCreate> <ParentLocation href="/content/locations/1/4/89" /> <priority>0</priority> <hidden>false</hidden> <sortField>PATH</sortField> <sortOrder>ASC</sortOrder> </LocationCreate> <Section href="/content/sections/4"/> <alwaysAvailable>true</alwaysAvailable> <remoteId>remoteId12345678</remoteId> <fields> <field> <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier> <languageCode>eng-US</languageCode> <fieldValue>This is a title</fieldValue> </field> <field> <fieldDefinitionIdentifier>summary</fieldDefinitionIdentifier> <languageCode>eng-US</languageCode> <fieldValue>This is a summary</fieldValue> </field> <field> <fieldDefinitionIdentifier>authors</fieldDefinitionIdentifier> <languageCode>eng-US</languageCode> <fieldValue> <value> <value key="name">John Doe</value> <value key="email">john.doe@example.net</value> </value> <value> <value key="name">Bruce Willis</value> <value key="email">bruce.willis@example.net</value> </value> </fieldValue> </field> </fields> </ContentCreate>
HTTP/1.1 201 Created Location: /content/objects/23 ETag: "12345678" Accept-Patch: application/vnd.ez.api.ContentUpdate+xml;charset=utf8 Content-Type: application/vnd.ez.api.Content+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <Content href="/content/objects/23" id="23" media-type="application/vnd.ez.api.Content+xml" remoteId="remoteId12345678" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ContentType href="/content/types/10" media-type="application/vnd.ez.api.ContentType+xml" /> <Name>This is a title</Name> <Versions href="/content/objects/23/versions" media-type="application/vnd.ez.api.VersionList+xml" /> <CurrentVersion href="/content/objects/23/currentversion" media-type="application/vnd.ez.api.Version+xml"> <Version href="/content/objects/23/versions/1" media-type="application/vnd.ez.api.Version+xml"> <VersionInfo> <id>123</id> <versionNo>1</versionNo> <status>DRAFT</status> <modificationDate>2012-02-12T12:30:00</modificationDate> <Creator href="/user/users/14" media-type="application/vnd.ez.api.User+xml" /> <creationDate>2012-02-12T12:30:00</creationDate> <initialLanguageCode>eng-US</initialLanguageCode> <Content href="/content/objects/23" media-type="application/vnd.ez.api.ContentInfo+xml" /> </VersionInfo> <fields> <field> <id>1234</id> <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier> <languageCode>eng-UK</languageCode> <fieldValue>This is a title</fieldValue> </field> <field> <id>1235</id> <fieldDefinitionIdentifier>summary</fieldDefinitionIdentifier> <languageCode>eng-UK</languageCode> <fieldValue>This is a summary</fieldValue> </field> <field> <fieldDefinitionIdentifier>authors</fieldDefinitionIdentifier> <languageCode>eng-US</languageCode> <fieldValue> <value> <value key="name">John Doe</value> <value key="email">john.doe@example.net</value> </value> <value> <value key="name">Bruce Willis</value> <value key="email">bruce.willis@example.net</value> </value> </fieldValue> </field> </fields> <Relations href="/content/objects/23/versions/1/relations" media-type="application/vnd.ez.api.RelationList+xml" /> </Version> </CurrentVersion> <Section href="/content/sections/4" media-type="application/vnd.ez.api.Section+xml" /> <MainLocation href="/content/locations/1/4/65" media-type="application/vnd.ez.api.Location+xml" /> <Locations href="/content/objects/23/locations" media-type="application/vnd.ez.api.LocationList+xml" /> <Owner href="/user/users/14" media-type="application/vnd.ez.api.User+xml" /> <lastModificationDate>2012-02-12T12:30:00</lastModificationDate> <mainLanguageCode>eng-US</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> </Content>
3.2.3.1.2 JSON Example
POST /content/objects HTTP/1.1 Host: www.example.net Accept: application/vnd.ez.api.Content+json Content-Type: application/vnd.ez.api.ContentCreate+json Content-Length: xxx
{ "ContentCreate": { "ContentType": { "_href": "/content/types/10" }, "mainLanguageCode": "eng-US", "LocationCreate": { "ParentLocation": { "_href": "/content/locations/1/4/89" }, "priority": "0", "hidden": "false", "sortField": "PATH", "sortOrder": "ASC" } "Section": { "_href": "/content/sections/4" }, "alwaysAvailable": "true", "remoteId": "remoteId12345678", "fields": { "field": [ { "fieldDefinitionIdentifier": "title", "languageCode": "eng-US", "fieldValue": "This is a title" }, { "fieldDefinitionIdentifier": "summary", "languageCode": "eng-US", "fieldValue": "This is a summary" }, { "fieldDefinitionIdentifier": "authors", "languageCode": "eng-US", "fieldValue": [ { "name": "John Doe", "email": "john.doe@example.net" }, { "name": "Bruce Willis", "email": "bruce.willis@example.net" } ] } ] } } }
HTTP/1.1 201 Created Location: /content/objects/23 ETag: "12345678" Accept-Patch: application/vnd.ez.api.ContentUpdate+json;charset=utf8 Content-Type: application/vnd.ez.api.Content+json Content-Length: xxx
{ "Content": { "_href": "/content/objects/23", "_id": "23", "_media-type": "application/vnd.ez.api.Content+json", "_remoteId": "qwert123", "ContentType": { "_href": "/content/types/10", "_media-type": "application/vnd.ez.api.ContentType+json" }, "name": "This is a title", "Versions": { "_href": "/content/objects/23/versions", "_media-type": "application/vnd.ez.api.VersionList+json" }, "CurrentVersion": { "_href": "/content/objects/23/currentversion", "_media-type": "application/vnd.ez.api.Version+json", "Version": { "_href": "/content/objects/23/versions/1", "_media-type": "application/vnd.ez.api.Version+json", "VersionInfo": { "id": "123", "versionNo": "1", "status": "DRAFT", "modificationDate": "2012-02-12T12:30:00", "creator": { "_href": "/user/users/14", "_media-type": "application/vnd.ez.api.User+json" }, "creationDate": "2012-02-12T12:30:00", "initialLanguageCode": "eng-US", "Content": { "_href": "/content/objects/23", "_media-type": "application/vnd.ez.api.ContentInfo+json" } }, "fields": { "field": [ { "id": "1234", "fieldDefinitionIdentifier": "title", "languageCode": "eng-UK", "fieldValue": "This is a title" }, { "id": "1235", "fieldDefinitionIdentifier": "summary", "languageCode": "eng-UK", "fieldValue": "This is a summary" }, { "fieldDefinitionIdentifier": "authors", "languageCode": "eng-US", "fieldValue": [ { "name": "John Doe", "email": "john.doe@example.net" }, { "name": "Bruce Willis", "email": "bruce.willis@example.net" } ] } ] } } }, "Section": { "_href": "/content/sections/4", "_media-type": "application/vnd.ez.api.Section+json" }, "MainLocation": { "_href": "/content/locations/1/4/65", "_media-type": "application/vnd.ez.api.Location+json" }, "Locations": { "_href": "/content/objects/23/locations", "_media-type": "application/vnd.ez.api.LocationList+json" }, "Owner": { "_href": "/user/users/14", "_media-type": "application/vnd.ez.api.User+json" }, "lastModificationDate": "2012-02-12T12:30:00", "mainLanguageCode": "eng-US", "alwaysAvailable": "true" } }
3.2.3.2 List/Search Content
Resource: | /content/objects |
---|---|
Method: | GET (not implemented) |
Description: | This resource will used in future for searching content by providing a query string as alternative to posting a view to /content/views. |
3.2.3.3 Load Content by remote id
Resource: | /content/objects |
||
---|---|---|---|
Method: | GET |
||
Description: | loads the content for a given remote id |
||
Parameters: |
|
||
Response: |
HTTP/1.1 307 Temporary Redirect Location: /content/objects/<id>
Error Codes: |
|
---|
3.2.3.4 Load Content
Resource: | /content/objects/<ID> |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||||||||||||
Description: | Loads the content object for the given id. Depending on the Accept header the current version is embedded (i.e the current published version or if not exists the draft of the authenticated user) |
||||||||||||||||||||
Headers: |
|
||||||||||||||||||||
Parameters: |
|
||||||||||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<ETag>" Accept-Patch: application/vnd.ez.api.ContentUpdate+(json|xml) Content-Type: <depending on accept header> Content-Length: <length>
Content
Error Codes: |
|
---|
3.2.3.4.1 XML Example
GET /content/objects/23 HTTP/1.1 Accept: application/vnd.ez.api.ContentInfo+xml If-None-Match: "12340577"
HTTP/1.1 200 OK ETag: "12345678" Accept-Patch: application/vnd.ez.api.ContentUpdate+xml;charset=utf8 Content-Type: application/vnd.ez.api.ContentInfo+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <Content href="/content/objects/23" id="23" media-type="application/vnd.ez.api.Content+xml" remoteId="qwert123"> <ContentType href="/content/types/10" media-type="application/vnd.ez.api.ContentType+xml" /> <Name>This is a title</Name> <Versions href="/content/objects/23/versions" media-type="application/vnd.ez.api.VersionList+xml" /> <CurrentVersion href="/content/objects/23/currentversion" media-type="application/vnd.ez.api.Version+xml"/> <Section href="/content/sections/4" media-type="application/vnd.ez.api.Section+xml" /> <MainLocation href="/content/locations/1/4/65" media-type="application/vnd.ez.api.Location+xml" /> <Locations href="/content/objects/23/locations" media-type="application/vnd.ez.api.LocationList+xml" /> <Owner href="/user/users/14" media-type="application/vnd.ez.api.User+xml" /> <lastModificationDate>2012-02-12T12:30:00</lastModificationDate> <publishedDate>2012-02-12T15:30:00</publishedDate> <mainLanguageCode>eng-US</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> </Content>
3.2.3.5 Update Content
Resource: | /content/objects/<ID> |
||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | PATCH or POST with header: X-HTTP-Method-Override: PATCH |
||||||||||||||||||||||
Description: | this method updates the content metadata which is independent from a version. |
||||||||||||||||||||||
Headers: |
|
||||||||||||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<new etag>" Accept-Patch: application/vnd.ez.api.ContentUpdate+(json|xml) Content-Type: <depending on accept header> Content-Length: <length>
Content
Error Codes: |
|
---|
3.2.3.5.1 XML Example
- In this example
- the main language is changed
- a new section is assigned
- the main location is changed
- the always avalable flag is changed
- the remoteId is changed
- the owner of the content object is changed
POST /content/objects/23 HTTP/1.1 X-HTTP-Method-Override: PATCH Host: www.example.net If-Match: "12345678" Accept: application/vnd.ez.api.ContentInfo+xml Content-Type: application/vnd.ez.api.ContentCreate+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <ContentUpdate> <mainLanguageCode>ger-DE</mainLanguageCode> <Section href="/content/sections/3"/> <MainLocation href="/content/locations/1/13/55"/> <Owner href="/user/users/13"/> <alwaysAvailable>false</alwaysAvailable> <remoteId>qwert4321</remoteId> </ContentUpdate>
HTTP/1.1 200 OK ETag: "12345699" Accept-Patch: application/vnd.ez.api.ContentUpdate+xml;charset=utf8 Content-Type: application/vnd.ez.api.ContentInfo+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <Content href="/content/objects/23" id="23" media-type="application/vnd.ez.api.Content+xml" remoteId="qwert4321"> <ContentType href="/content/types/10" media-type="application/vnd.ez.api.ContentType+xml" /> <Name>This is a title</Name> <Versions href="/content/objects/23/versions" media-type="application/vnd.ez.api.VersionList+xml" /> <CurrentVersion href="/content/objects/23/currentversion" media-type="application/vnd.ez.api.Version+xml"/> <Section href="/content/sections/3" media-type="application/vnd.ez.api.Section+xml" /> <MainLocation href="/content/locations/1/13/55" media-type="application/vnd.ez.api.Location+xml" /> <Locations href="/content/objects/23/locations" media-type="application/vnd.ez.api.LocationList+xml" /> <Owner href="/user/users/13" media-type="application/vnd.ez.api.User+xml" /> <lastModificationDate>2012-02-12T12:30:00</lastModificationDate> <publishedDate>2012-02-12T15:30:00</publishedDate> <mainLanguageCode>ger-DE</mainLanguageCode> <alwaysAvailable>false</alwaysAvailable> </Content>
3.2.3.6 Delete Content
Resource: | /content/objects/<ID> |
||||
---|---|---|---|---|---|
Method: | DELETE |
||||
Description: | The content is deleted. If the content has locations (which is required in 4.x) on delete all locations assigned the content object are deleted via delete subtree. |
||||
Response: | 204 |
||||
Error Codes: |
|
3.2.3.7 Copy content
Resource: | /content/objects/<ID> |
||
---|---|---|---|
Method: | COPY or POST with header: X-HTTP-Method-Override COPY |
||
Description: | Creates a new content object as copy under the given parent location given in the destination header. |
||
Headers: |
|
||
Response: |
HTTP/1.1 201 Created Location: /content/objects/<newId>
Error codes: |
|
---|
3.2.3.7.1 Example
COPY /content/objects/23 HTTP/1.1 Host: api.example.com Destination: /content/locations/1/4/78 HTTP/1.1 201 Created Location: /content/objects/74
3.2.4 Managing Versions
3.2.4.1 Get Current Version
Resource: | /content/objects/<ID>/currentversion |
---|---|
Method: | GET |
Description: | Redirects to the current version of the content object |
Response: |
HTTP/1.1 307 Temporary Redirect Location: /content/objects/<ID>/version/<current_version_no>
Error Codes: |
|
---|
3.2.4.2 List Versions
Resource: | /content/objects/<ID>/versions |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | Returns a list of all versions of the content. This method does not include fields and relations in the Version elements of the response. |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
VersionList
Error Codes: |
|
---|
3.2.4.2.1 XML Example
GET /content/objects/23/versions HTTP/1.1 Host: api.example.com Accept: application/vnd.ez.api.VersionList+xml
HTTP/1.1 200 OK Content-Type: application/vnd.ez.api.VersionList+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <VersionList href="/content/objects/23/versions" media-type="application/vnd.ez.api.VersionList+xml"> <VersionItem> <Version href="/content/objects/23/versions/1" media-type="application/vnd.ez.api.Version+xml"/> <VersionInfo> <id>12</id> <versionNo>1</versionNo> <status>ARCHIVED</status> <modificationDate>2012-02-15T12:00:00</modificationDate> <Creator href="/user/users/8" media-type="application/vnd.ez.api.User+xml" /> <creationDate>22012-02-15T12:00:00</creationDate> <initialLanguageCode>eng-US</initialLanguageCode> <names> <value languageCode="eng-US">Name</value> </names> <Content href="/content/objects/23" media-type="application/vnd.ez.api.ContentInfo+xml" /> </VersionInfo> </VersionItem> <VersionItem> <Version href="/content/objects/23/versions/2" media-type="application/vnd.ez.api.Version+xml"/> <VersionInfo> <id>22</id> <versionNo>2</versionNo> <status>PUBLISHED</status> <modificationDate>2012-02-17T12:00:00</modificationDate> <Creator href="/user/users/8" media-type="application/vnd.ez.api.User+xml" /> <creationDate>22012-02-17T12:00:00</creationDate> <initialLanguageCode>eng-US</initialLanguageCode> <names> <value languageCode="eng-US">Name</value> </names> <Content href="/content/objects/23" media-type="application/vnd.ez.api.ContentInfo+xml" /> </VersionInfo> </VersionItem> <VersionItem> <Version href="/content/objects/23/versions/3" media-type="application/vnd.ez.api.Version+xml"/> <VersionInfo> <id>44</id> <versionNo>3</versionNo> <status>DRAFT</status> <modificationDate>2012-02-19T12:00:00</modificationDate> <Creator href="/user/users/65" media-type="application/vnd.ez.api.User+xml" /> <creationDate>22012-02-19T12:00:00</creationDate> <initialLanguageCode>fra-FR</initialLanguageCode> <names> <value languageCode="eng-US">Name</value> <value languageCode="fra-FR">Nom</value> </names> <Content href="/content/objects/23" media-type="application/vnd.ez.api.ContentInfo+xml" /> </VersionInfo> </VersionItem> <VersionItem> <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="eng-US">Name</value> <value languageCode="ger-DE">Name</value> </names> <Content href="/content/objects/23" media-type="application/vnd.ez.api.ContentInfo+xml" /> </VersionInfo> </VersionItem> </VersionList>
3.2.4.3 Load Version
Resource: | /content/objects/<ID>/versions/<versionNo> |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||||
Description: | Loads a specific version of a content object. This method returns fields and relations |
||||||||||||
Parameters: |
|
||||||||||||
Headers: |
|
||||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending_on_accept_header> Content-Length: <length> ETag: <etag> Accept-Patch: application/vnd.ez.api.VersionUpdate+xml (ONLY if version is a draft)
Version
Error Codes: |
|
---|
3.2.4.3.1 XML Example
GET /content/objects/23/versions/4 HTTP/1.1 Host: api.example.com If-None-Match: "1758f762" Accept: application/vnd.ez.api.Version+xml
HTTP/1.1 200 OK Accept-Patch: application/vnd.ez.api.VersionUpdate+xml ETag: "a3f2e5b7" Content-Type: application/vnd.ez.api.Version+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <Version href="/content/objects/23/versions/4" media-type="application/vnd.ez.api.Version+xml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <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">Name</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>Titel</fieldValue> </field> <field> <id>1235</id> <fieldDefinitionIdentifier>summary</fieldDefinitionIdentifier> <languageCode>ger-DE</languageCode> <fieldValue>Dies ist eine Zusammenfassungy</fieldValue> </field> <field> <fieldDefinitionIdentifier>authors</fieldDefinitionIdentifier> <languageCode>ger-DE</languageCode> <fieldValue> <value> <value key="name">Karl Mustermann</value> <value key="email">karl.mustermann@example.net</value> </value> </fieldValue> </field> </Fields> <Relations href="/content/objects/23/relations" media-type="application/vnd.ez.api.RelationList+xml">> <Relation href="/content/objects/23/relations/32" 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>
3.2.4.4 Update Version
Resource: | /content/objects/<ID>/version/<versionNo> |
||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | PATCH or POST with header X-HTTP-Method-Override: PATCH |
||||||||||||||||||||||
Description: | A specific draft is updated. |
||||||||||||||||||||||
Parameters: |
|
||||||||||||||||||||||
Headers: |
|
||||||||||||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<new etag>" Accept-Patch: application/vnd.ez.api.VersionUpdate+(json|xml) Content-Type: <depending on accept header> Content-Length: <length>
Version
Error Codes: |
|
---|
3.2.4.4.1 XML Example
POST /content/objects/23/versions/4 HTTP/1.1 X-HTTP-Method-Override: PATCH Host: www.example.net If-Match: "a3f2e5b7" Accept: application/vnd.ez.api.Version+xml Content-Type: application/vnd.ez.api.VersionUpdate+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <VersionUpdate xmlns:p="http://ez.no/API/Values" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ez.no/API/Values ../VersionUpdate.xsd "> <modificationDate>2001-12-31T12:00:00</modificationDate> <initialLanguageCode>ger-DE</initialLanguageCode> <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 neue Zusammenfassungy</fieldValue> </field> </fields> </VersionUpdate>
HTTP/1.1 200 OK Accept-Patch: application/vnd.ez.api.VersionUpdate+xml ETag: "a3f2e5b9" Content-Type: application/vnd.ez.api.Version+xml Content-Length: xxx
<?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>
3.2.4.5 Create a Draft from a Version
Resource: | /content/objects/<ID>/versions/<no> |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | COPY or POST with header X-HTTP-Method-Override: COPY |
||||||||||
Description: | The system creates a new draft version as a copy from the given version |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 201 Created Location: /content/objects/<ID>/versions/<new-versionNo> ETag: <etag> Accept-Patch: application/vnd.ez.api.VersionUpdate+xml Content-Type: <depending on accept header> Content-Length: <length>
Version
Error Codes: |
|
---|
3.2.4.6 Create a Draft from current Version
Resource: | /content/objects/<ID>/currentversion |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | COPY or POST with header X-HTTP-Method-Override: COPY |
||||||||||
Description: | The system creates a new draft version as a copy from the current version |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 201 Created Location: /content/objects/<ID>/versions/<new-versionNo> ETag: <etag> Accept-Patch: application/vnd.ez.api.VersionUpdate+xml Content-Type: <depending on accept header> Content-Length: <length>
Version
Error Codes: |
|
---|
3.2.4.7 Delete Content Version
Resource: | /content/objects/<ID>/version/<versionNo> |
---|---|
Method: | DELETE |
Description: | The version is deleted |
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.4.8 Publish a content version
Resource: | /content/objects/<ID>/version/<versionNo> |
---|---|
Method: | PUBLISH or POST with header X-HTTP-Method-Override: PUBLISH |
Description: | The content version is published |
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.5 Managing Relations
3.2.5.1 Load relations of content
Resource: | /content/objects/<ID>/relations |
---|---|
Method: | GET |
Description: | redirects to the relations of the current version |
Response: |
HTTP/1.1 307 Temporary Redirect Location: /content/objects/<ID>/versions/<currentversion>/relations
Error Codes: | |
---|---|
401: | If the user is not authorized to read this object |
404: | If the content object was not found |
3.2.5.2 Load relations of version
Resource: | /content/objects/<ID>/versions/<no>/relations |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | loads the relations of the given version |
||||||||||
Parameters: |
|
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on Accept header> Content-Length: xxx
RelationList
Error Codes: |
|
---|
3.2.5.2.1 XML Example
GET /content/objects/23/versions/2/relations HTTP/1.1 Accept: application/vnd.ez.api.RelationList+xml
HTTP/1.1 200 OK Content-Type: application/vnd.ez.api.RelationList+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <Relations href="/content/object/32/versions/2/relations" media-type="application/vnd.ez.api.RelationList+xml"> <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> <Relation href="/content/object/32/versions/2/relations/98" 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/87" media-type="application/vnd.ez.api.ContentInfo+xml" /> <sourceFieldDefinitionIdentifier>body</sourceFieldDefinitionIdentifier> <RelationType>EMBED</RelationType> </Relation> </Relations>
3.2.5.3 Load a relation
Resource: | /content/objects/<ID>/versions/<no>/relations/<ID> |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | loads a relation for the given content object |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on Accept header> Content-Length: xxx
Relation (relationValueType(
Error Codes: |
|
---|
3.2.5.4 Create a new Relation
Resource: | /content/objects/<ID>/versions/<no>/relations |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | POST |
||||||||||||||||||||
Description: | Creates a new relation of type COMMON for the given draft. |
||||||||||||||||||||
Headers: |
|
||||||||||||||||||||
Response: |
HTTP/1.1 201 Created Location: /content/objects/<ID>/versions/<no>/relations/<newId> Content-Type: <depending on Accept header> Content-Length: xxx
Relation (relationValueType(
Error Codes: |
|
---|
3.2.5.4.1 XML Example
POST /content/objects/23/versions/4/relations HTTP/1.1 Accept: application/vnd.ez.api.Relation+xml Content-Type: application/vnd.ez.api.RelationCreate+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <RelationCreate> <Destination href="/content/objects/66"/> </RelationCreate>
HTTP/1.1 201 Created Location: /content/objects/23/versions/4/relations Content-Type: application/vnd.ez.api.RelationCreate+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <Relation href="/content/object/32/versions/2/relations/66" 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/66" media-type="application/vnd.ez.api.ContentInfo+xml" /> <RelationType>COMMON</RelationType> </Relation>
3.2.5.5 Delete a relation
Resource: | /content/objects/<ID>/versions/<versionNo>/relations/<ID> |
---|---|
Method: | DELETE |
Description: | Deletes a relation of the given draft. |
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.6 Managing Locations
3.2.6.1 Create a new location for a content object
Resource: | /content/objects/<ID>/locations |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | POST |
||||||||||||||||||||
Description: | Creates a new location for the given content object |
||||||||||||||||||||
Headers: |
|
||||||||||||||||||||
Response: |
HTTP/1.1 201 Created Location: /content/locations/<newPath> ETag: "<new etag>" Accept-Patch: application/vnd.ez.api.LocationUpdate+(json|xml) Content-Type: <depending on accept header> Content-Length: <length>
Location
Error Codes: |
|
---|
3.2.6.1.1 XML Example
POST /content/objects/23/locations HTTP/1.1 Accept: application/vnd.ez.api.Location+xml Content-Type: application/vnd.ez.api.LocationCreate+xml Contnt-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <LocationCreate> <ParentLocation href="/content/locations/1/5/73" /> <priority>0</priority> <hidden>false</hidden> <sortField>PATH</sortField> <sortOrder>ASC</sortOrder> </LocationCreate>
HTTP/1.1 201 Created Location: /content/locations/1/5/73/133 ETag: "2345563422" Accept-Patch: application/vnd.ez.api.LocationUpdate+xml Content-Type: application/vnd.ez.api.Location+xml Contnt-Length: xxx
<?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>0</priority> <hidden>false</hidden> <invisible>false</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-qwert567</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>PATH</sortField> <sortOrder>ASC</sortOrder> </Location>
3.2.6.2 Get locations for a content object
Resource: | /content/objects/<ID>/locations |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||||
Description: | loads all locations for the given content object |
||||||||||||
Headers: |
|
||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Content-Type: <depending on accept header> Content-Length: <length>
Location (locationListType)
Error Codes: |
|
---|
3.2.6.2.1 XML Example
GET /content/objects/23/locations HTTP/1.1 Accept: application/vnd.ez.api.LocationList+xml
HTTP/1.1 200 OK ETag: "<etag>" Content-Type: application/vnd.ez.api.LocationList+xml Content-Length: xxx
<?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>
3.2.6.3 Load locations by id
Resource: | /content/locations |
||||
---|---|---|---|---|---|
Method: | GET |
||||
Description: | loads the location for a given id (x)or remote id |
||||
Parameters: |
|
||||
Response: |
HTTP/1.1 307 Temporary Redirect Location: /content/locations/<path>
Error Codes: |
|
---|
3.2.6.4 Load location
Resource: | /content/locations/<path> |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||||
Description: | loads the location for the given path |
||||||||||||
Headers: |
|
||||||||||||
Response: |
HTTP/1.1 200 OK Location: /content/locations/<path> ETag: "<new etag>" Accept-Patch: application/vnd.ez.api.LocationUpdate+(json|xml) Content-Type: <depending on accept header> Content-Length: <length>
Location
Error Codes: |
|
---|
3.2.6.4.1 XML Example
GET /content/locations/1/4/73/133 HTTP/1.1 Host: api.example.net Accept: application/vnd.ez.api.Location+xml If-None-Match: "2345503255"
HTTP/1.1 200 OK ETag: "2345563422" Accept-Patch: application/vnd.ez.api.LocationUpdate+xml Content-Type: application/vnd.ez.api.Location+xml Contnt-Length: xxx
<?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>0</priority> <hidden>false</hidden> <invisible>false</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-qwert567</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>PATH</sortField> <sortOrder>ASC</sortOrder> </Location>
3.2.6.5 Update location
Resource: | /content/locations/<ID> |
||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | PATCH or POST with header: X-HTTP-Method-Override: PATCH |
||||||||||||||||||||||
Description: | updates the location, this method can also be used to hide/unhide a location via the hidden field in the LocationUpdate |
||||||||||||||||||||||
Headers: |
|
||||||||||||||||||||||
Response: |
HTTP/1.1 200 OK Location: /content/locations/<path> ETag: "<new etag>" Accept-Patch: application/vnd.ez.api.LocationUpdate+(json|xml) Content-Type: <depending on accept header> Content-Length: <length>
Location
Error Codes: |
|
---|
3.2.6.5.1 XML Example
POST /content/locations/1/5/73/133 HTTP/1.1 X-HTTP-Method-Override: PATCH Host: www.example.net If-Match: "12345678" Accept: application/vnd.ez.api.Location+xml Content-Type: :application/vnd.ez.api.LocationUpdate+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <LocationUpdate> <priority>3</priority> <hidden>true</hidden> <remoteId>remoteId-qwert999</remoteId> <sortField>CLASS</sortField> <sortOrder>DESC</sortOrder> </LocationUpdate>
HTTP/1.1 200 OK ETag: "2345563444" Accept-Patch: application/vnd.ez.api.LocationUpdate+xml Content-Type: application/vnd.ez.api.Location+xml Content-Length: xxx
<?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>
3.2.6.6 Get child locations
Resource: | /content/locations/<path>/children |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | loads all child locations for the given parent location |
||||||||||
Parameters: |
|
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
Location
Error Codes: |
|
---|
3.2.6.6.1 XML Example
GET /content/locations/1/2/54/children HTTP/1.1 Host: api.example.net Accept: application/vnd.ez.api.LocationList+xml
HTTP/1.1 200 OK Content-Type: application/vnd.ez.api.LocationList+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <LocationList href="/content/locations/1/2/54" media-type="application/vnd.ez.api.LocationList+xml"> <Location href="/content/locations/1/2/54/134" media-type="application/vnd.ez.api.Location+xml"/> <Location href="/content/locations/1/4/54/143" media-type="application/vnd.ez.api.Location+xml"/> </LocationList>
3.2.6.7 Move Subtree
Resource: | /content/locations/<path> |
||
---|---|---|---|
Method: | MOVE or POST with header X-HTTP-Method-Override: MOVE |
||
Description: | moves the location to another parent. The destination can also be /content/trash where the location is put into the trash. |
||
Headers: |
|
||
Response: |
HTTP/1.1 201 Created Location: /content/locations/<newPath>
or if destination is /content/trash
HTTP/1.1 201 Created Location: /content/trash/<ID>
Error Codes: |
|
---|
3.2.6.8 Copy Subtree
Resource: | /content/locations/<path> |
||
---|---|---|---|
Method: | COPY or POST with header X-HTTP-Method-Override: COPY |
||
Description: | copies the subtree to another parent |
||
Headers: |
|
||
Response: |
HTTP/1.1 201 Created Location: /content/locations/<newPath>
Error Codes: |
|
---|
3.2.6.9 Swap Location
Resource: | /content/locations/<ID> |
||
---|---|---|---|
Method: | SWAP or POST with header X-HTTP-Method-Override: SWAP |
||
Description: | Swaps the content of the location with the content of the given location |
||
Headers: |
|
||
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.6.10 Delete Subtree
Resource: | /content/locations/<path> |
---|---|
Method: | DELETE |
Description: | Deletes the complete subtree for the given path. Every content object is deleted which does not have any other location. Otherwise the deleted location is removed from the content object. The children a recursively deleted. |
Response: | 204 |
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.7 Views
3.2.7.1 Create View
Resource: | /content/views |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | POST |
||||||||||||||||||||
Description: | executes a query and returns view including the results The View input reflects the criteria model of the public API. |
||||||||||||||||||||
Headers: |
|
||||||||||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<new etag>" Content-Type: <depending on accept header> Content-Length: <length>
View
Error codes: |
|
---|
3.2.7.1.1 XML Example
Perform a query on articles with a specific title.
POST /content/views HTTP/1.1 Accept: application/vnd.ez.api.View+xml Content-Type: application/vnd.ez.api.ViewInput+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <ViewInput> <identifier>TitleView</identifier> <Query> <Criteria> <FullTextCritierion>Title</FieldCritierion> </Criteria> <limit>10</limit> <offset>0</offset> <SortClauses> <SortClause> <SortField>NAME</SortField> </SortClause> </SortClauses> <FacetBuilders> <contentTypeFacetBuilder/> </FacetBuilders> </Query> </ViewInput>
HTTP/1.1 201 Created Location: /content/views/view1234 Content-Type: application/vnd.ez.api.View+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <View href="/content/views/TitleView" media-type="application/vnd.ez.api.View+xml"> <identifier>TitleView</identifier> <User href="/user/users/14" media-type="vnd.ez.api.User+xml"/> <public>false</public> <Query> <Criteria> <FullTextCritierion>Title</FieldCritierion> </Criteria> <limit>10</limit> <offset>0</offset> <SortClauses> <SortClause> <SortField>NAME</SortField> </SortClause> </SortClauses> <FacetBuilders> <contentTypeFacetBuilder/> </FacetBuilders> </Query> <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> <Content href="/content/objects/23" id="23" media-type="application/vnd.ez.api.Content+xml" remoteId="qwert123" xmlns:p="http://ez.no/API/Values" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ez.no/API/Values Content.xsd "> <ContentType href="/content/types/10" media-type="application/vnd.ez.api.ContentType+xml" /> <Name>Name</Name> <Versions href="/content/objects/23/versions" media-type="application/vnd.ez.api.VersionList+xml" /> <CurrentVersion href="/content/objects/23/currentversion" media-type="application/vnd.ez.api.Version+xml"> <Version href="/content/objects/23/versions/2" media-type="application/vnd.ez.api.Version+xml"> <VersionInfo> <id>123</id> <versionNo>2</versionNo> <status>PUBLISHED</status> <modificationDate>2001-12-31T12:00:00</modificationDate> <creator href="/user/users/14" media-type="application/vnd.ez.api.User+xml" /> <creationDate>2001-12-31T12:00:00</creationDate> <initialLanguageCode>eng-UK</initialLanguageCode> <Content href="/content/objects/23" media-type="application/vnd.ez.api.ContentInfo+xml" /> </VersionInfo> <Fields> <field> <id>1234</id> <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier> <languageCode>eng-UK</languageCode> <fieldValue>Title</fieldValue> </field> <field> <id>1235</id> <fieldDefinitionIdentifier>summary </fieldDefinitionIdentifier> <languageCode>eng-UK</languageCode> <fieldValue>This is a summary</fieldValue> </field> </Fields> <Relations /> </Version> </CurrentVersion> <Section href="/content/objects/23/section" media-type="application/vnd.ez.api.Section+xml" /> <MainLocation href="/content/objects/23/mainlocation" media-type="application/vnd.ez.api.Location+xml" /> <Locations href="/content/objects/23/locations" media-type="application/vnd.ez.api.LocationList+xml" /> <Owner href="/user/users/14" media-type="application/vnd.ez.api.User+xml" /> <PublishDate>2001-12-31T12:00:00</PublishDate> <LastModificationDate>2001-12-31T12:00:00</LastModificationDate> <MainLanguageCode>eng-UK</MainLanguageCode> <AlwaysAvailable>true</AlwaysAvailable> </Content> </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>
3.2.7.2 List views
Resource: | /content/views |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | Returns a list of view uris. The list includes public view and private view of the authenticated user. |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
Common
3.2.7.3 Get View
Resource: | /content/views/<identifier> |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | Returns the view |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
View
Error Codes: |
|
---|
3.2.7.4 Get Results of existing View
Resource: | /content/views/<identifier>/results |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | Returns result of the view |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
View
Error Codes: |
|
---|
3.2.7.5 Delete View
Resource: | /content/views/<identifier> |
---|---|
Method: | DELETE |
Description: | the given view is deleted |
Parameters: | |
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.8 Managing Sections
3.2.8.1 Create a new Section
Resource: | /content/sections |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | POST |
||||||||||||||||||||
Description: | Creates a new section |
||||||||||||||||||||
Headers: |
|
||||||||||||||||||||
Response: |
HTTP/1.1 201 Created Location: /content/section/<ID> ETag: "<new etag>" Accept-Patch: application/vnd.ez.api.SectionInput+(json|xml) Content-Type: <depending on accept header> Content-Length: <length>
Section
Error Codes: |
|
---|
3.2.8.1.1 XML Example
POST /content/sections HTTP/1.1 Host: api.example.net Accept: application/vnd.ez.api.Section+xml Content-Type: application/vnd.ez.api.SectionInput+xml Content-Length: xxxx
<?xml version="1.0" encoding="UTF-8"?> <SectionInput> <identifier>restricted</identifier> <name>Restricted</name> </SectionInput>
HTTP/1.1 201 Created Location: /content/section/5 ETag: "4567867894564356" Accept-Patch: application/vnd.ez.api.SectionInput+(json|xml) Content-Type: application/vnd.ez.api.Section+xml Content-Length: xxxx
<?xml version="1.0" encoding="UTF-8"?> <Section href="/content/sections/5" media-type="application/vnd.ez.api.Section+xml"> <sectionId>5</sectionId> <identifier>restricted</identifier> <name>Restriced</name> </Section>
3.2.8.2 Get Sections
Resource: | /content/sections |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||||
Description: | Returns a list of all sections |
||||||||||||
Parameters: |
|
||||||||||||
Headers: |
|
||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Content-Type: <depending on accept header> Content-Length: <length>
Section (sectionListType)
Error Codes: |
|
---|
3.2.8.2.1 XML Example
GET /content/sections Host: api.example.net If-None-Match: "43450986749098765" Accept: application/vnd.ez.api.SectionList+xml
HTTP/1.1 200 OK ETag: "43450986743098576" Content-Type: application/vnd.ez.api.SectionList+xml Content-Length: xxx
<?xml version="1.0" encoding="UTF-8"?> <SectionList href="/content/sections" media-type="application/vnd.ez.api.SectionList+xml"> <Section href="/content/sections/1" media-type="application/vnd.ez.api.Section+xml"> <sectionId>1</sectionId> <identifier>standard</identifier> <name>Standard</name> </Section> <Section href="/content/sections/2" media-type="application/vnd.ez.api.Section+xml"> <sectionId>2</sectionId> <identifier>users</identifier> <name>Users</name> </Section> <Section href="/content/sections/3" media-type="application/vnd.ez.api.Section+xml"> <sectionId>3</sectionId> <identifier>media</identifier> <name>Media</name> </Section> <Section href="/content/sections/4" media-type="application/vnd.ez.api.Section+xml"> <sectionId>4</sectionId> <identifier>setup</identifier> <name>Setup</name> </Section> </SectionList>
3.2.8.3 Get Section
Resource: | /content/sections/<ID> |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||||
Description: | Returns the section given by id |
||||||||||||
Headers: |
|
||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Accept-Patch: application/vnd.ez.api.SectionInput+(xml|json) Content-Type: <depending on accept header> Content-Length: <length>
Section
ErrorCodes: |
|
---|
3.2.8.3.1 XML Example
GET /content/sections/3 HTTP/1.1 Host: api.example.net If-None-Match: "43450986749098765" Accept: application/vnd.ez.api.Section+xml
HTTP/1.1 200 OK ETag: "4567867894564356" Accept-Patch: application/vnd.ez.api.SectionInput+(json|xml) Content-Type: application/vnd.ez.api.Section+xml Content-Length: xxxx
<?xml version="1.0" encoding="UTF-8"?> <Section href="/content/sections/3" media-type="application/vnd.ez.api.Section+xml"> <sectionId>3</sectionId> <identifier>media</identifier> <name>Media</name> </Section>
3.2.8.4 Update a Section
Resource: | /content/sections/<ID> |
||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | PATCH or POST with header X-HTTP-Method-Override |
||||||||||||||||||||||
Description: | Updates a section |
||||||||||||||||||||||
Headers: |
|
||||||||||||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Accept-Patch: application/vnd.ez.api.SectionInput+(xml|json) Content-Type: <depending on accept header> Content-Length: <length>
Section (sectionListType)
Error Codes: | :400; If the Input does not match the input schema definition, In this case the response contains an ErrorMessage :401: If the user is not authorized to create this section :403: If a section with the given new identifier already exists :412: If the current ETag does not match with the provided one in the If-Match header |
---|
3.2.8.5 Delete Section
Resource: | /content/sections/<ID> |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | DELETE |
||||||||||
Description: | the given section is deleted |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.9 Managing Trash
3.2.9.1 List TrashItems
Resource: | /content/trash |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | Returns a list of all trash items |
||||||||||
Parameters: |
|
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
Trash
ErrorCodes: |
|
---|
3.2.9.2 Get TrashItem
Resource: | /content/trash/<ID> |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | Returns the trash item given by id |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
Trash
Error Codes: |
|
---|
3.2.9.3 Untrash Item
Resource: | /content/trash/<ID> |
||
---|---|---|---|
Method: | MOVE or POST with header X-HTTP-Method-Override: MOVE |
||
Description: | Restores a trashItem |
||
Headers: |
|
||
Response: |
HTTP/1.1 201 Created Location: /content/locations/<newPath>
Error Codes: |
|
---|
3.2.9.4 Empty Trash
Resource: | /content/trash |
---|---|
Method: | DELETE |
Description: | Empties the trash |
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.9.5 Delete TrashItem
Resource: | /content/trash/items/<ID> |
---|---|
Method: | DELETE |
Description: | Deletes the given trash item |
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.10 Object States
3.2.10.1 Create ObjectStateGroup
Resource: | /content/objectstategroups |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | POST |
||||||||||||||||||||
Description: | Creates a new objectstategroup |
||||||||||||||||||||
Headers: |
|
||||||||||||||||||||
Response: |
HTTP/1.1 201 Created Location: /content/objectstategroup/<ID> ETag: "<new etag>" Accept-Patch: application/vnd.ez.api.ObjectStateGroupInput+(json|xml) Content-Type: <depending on accept header> Content-Length: <length>
ObjectStateGroup
Error Codes: |
|
---|
3.2.10.2 List ObjectStateGroups
Resource: | /content/objectstategroups |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||||
Description: | Returns a list of all object state groups |
||||||||||||
Headers: |
|
||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Content-Type: <depending on accept header> Content-Length: <length>
ObjectStateGroup
Error Codes: |
|
---|
3.2.10.3 Get ObjectStateGroup
Resource: | /content/objectstategroups/<ID> |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||||
Description: | Returns the object state group given by id |
||||||||||||
Headers: |
|
||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Accept-Patch: application/vnd.ez.api.ObjectStateGroupUpdate+(xml|json) Content-Type: <depending on accept header> Content-Length: <length>
ObjectStateGroup
ErrorCodes: |
|
---|
3.2.10.4 Update ObjectStateGroup
Resource: | /content/objectstategroups/<ID> |
||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | PATCH or POST with header X-HTTP-Method-Override: PATCH |
||||||||||||||||||||||
Description: | Updates an object state group |
||||||||||||||||||||||
Headers: |
|
||||||||||||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Accept-Patch: application/vnd.ez.api.ObjectStateGroupUpdate+(xml|json) Content-Type: <depending on accept header> Content-Length: <length>
ObjectStateGroup
Error Codes: | :400; If the Input does not match the input schema definition, In this case the response contains an ErrorMessage :401: If the user is not authorized to update an object state group :403: If an object state group with the given new identifier already exists :412: If the current ETag does not match with the provided one in the If-Match header |
---|
3.2.10.5 Delete ObjectStateGroup
Resource: | /content/objectstategroups/<ID> |
---|---|
Method: | DELETE |
Description: | the given object state group including the object states is deleted |
Parameters: | |
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.10.6 Create ObjectState
Resource: | /content/objectstategroups/<ID>/objectstates |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | POST |
||||||||||||||||||||
Description: | Creates a new objectstate |
||||||||||||||||||||
Headers: |
|
||||||||||||||||||||
Response: |
HTTP/1.1 201 Created Location: /content/objectstategroup/<ID>/objectstate/<ID> ETag: "<new etag>" Accept-Patch: application/vnd.ez.api.ObjectStateUpdate+(json|xml) Content-Type: <depending on accept header> Content-Length: <length>
ObjectStateGroup
Error Codes: |
|
---|
3.2.10.7 List Objectstates
Resource: | /content/objectstategroups/<ID>/objectstates |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||||
Description: | Returns a list of all object states of the given group |
||||||||||||
Headers: |
|
||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Content-Type: <depending on accept header> Content-Length: <length>
ObjectStateGroup
Error Codes: |
|
---|
3.2.10.8 Get ObjectState
Resource: | /content/objectstategroups/<ID>/objectstates/<ID> |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||||
Description: | Returns the object state |
||||||||||||
Headers: |
|
||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Accept-Patch: application/vnd.ez.api.ObjectStateUpdate+(xml|json) Content-Type: <depending on accept header> Content-Length: <length>
ObjectStateGroup
ErrorCodes: |
|
---|
3.2.10.9 Update ObjectState
Resource: | /content/objectstategroups/<ID>/objectstates/<ID> |
||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | PATCH or POST with header X-HTTP-Method-Override: PATCH |
||||||||||||||||||||||
Description: | Updates an object state |
||||||||||||||||||||||
Headers: |
|
||||||||||||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Accept-Patch: application/vnd.ez.api.ObjectStateUpdate+(xml|json) Content-Type: <depending on accept header> Content-Length: <length>
ObjectStateGroup
Error Codes: | :400; If the Input does not match the input schema definition, In this case the response contains an ErrorMessage :401: If the user is not authorized to update an object state :403: If an object state with the given new identifier already exists in this group :412: If the current ETag does not match with the provided one in the If-Match header |
---|
3.2.10.10 Delete ObjectState
Resource: | /content/objectstategroups/<ID>/objectstates/<ID> |
---|---|
Method: | DELETE |
Description: | the given object state is deleted |
Parameters: | |
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.10.11 Get ObjectStates of Content
Resource: | /content/objects/<ID>/objectstates |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||||
Description: | Returns the object states of content |
||||||||||||
Headers: |
|
||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Accept-Patch: application/vnd.ez.api.ContentObjectStates+(xml|json) Content-Type: <depending on accept header> Content-Length: <length>
ContentObjectStates
ErrorCodes: |
|
---|
3.2.10.12 Set ObjectStates of Content
Resource: | /content/objects/<ID>/objectstates |
||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | PATCH or POST with header X-HTTP-Method-Override: PATCH |
||||||||||||||||||||||
Description: | Updates object states of content. An object state in the input overrides the state of the object state group. |
||||||||||||||||||||||
Headers: |
|
||||||||||||||||||||||
Response: |
HTTP/1.1 200 OK ETag: "<etag>" Accept-Patch: application/vnd.ez.api.ContentObjectStates+(xml|json) Content-Type: <depending on accept header> Content-Length: <length>
ContentObjectStates
Error Codes: | :400; If the Input does not match the input schema definition, In this case the response contains an ErrorMessage :401: If the user is not authorized to set an object state :403: If the input contains multiple object states of the same object state group :412: If the current ETag does not match with the provided one in the If-Match header |
---|
3.2.11 Url Alias
3.2.11.1 Create Url Alias
Resource: | /content/urlaliases |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | POST |
||||||||||||||||||||
Description: | Creates a new url alias |
||||||||||||||||||||
Headers: |
|
||||||||||||||||||||
Response: |
HTTP/1.1 201 Created Location: /content/urlaliases/<ID> ETag: "<new etag>" Content-Type: <depending on accept header> Content-Length: <length>
UrlAlias
Error Codes: |
|
---|
3.2.11.2 List UrlAliases for location
Resource: | /content/locations/<path>/urlaliases |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | Returns the list of url aliases for a location |
||||||||||
Parameters: |
|
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
UrlAlias
Error Codes: |
|
---|
3.2.11.3 List Global UrlAliases
Resource: | /content/urlaliases |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | Returns the list of url global aliases |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
UrlAlias
Error Codes: |
|
---|
3.2.11.4 Get UrlAlias
Resource: | /content/urlaliases/<ID> |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | Returns the urlalias with the given id |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
UrlAlias
ErrorCodes: |
|
---|
3.2.11.5 Delete UrlAlias
Resource: | /content/urlaliases/<ID> |
---|---|
Method: | DELETE |
Description: | the given url alias is deleted |
Parameters: | |
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|
3.2.12 Url Wildcards
3.2.12.1 Create Url Wildcard
Resource: | /content/urlwildcards |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method: | POST |
||||||||||||||||||||
Description: | Creates a new url wildcard |
||||||||||||||||||||
Headers: |
|
||||||||||||||||||||
Response: |
HTTP/1.1 201 Created Location: /content/urlwildcards/<ID> ETag: "<new etag>" Content-Type: <depending on accept header> Content-Length: <length>
UrlWildcard
Error Codes: |
|
---|
3.2.12.2 List UrlWildcards
Resource: | /content/urlwildcards |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | Returns a list of url wildcards |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
UrlWildcard
Error Codes: |
|
---|
3.2.12.3 Get UrlWildcard
Resource: | /content/urlwildcards/<ID> |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Method: | GET |
||||||||||
Description: | Returns the urlwildcard with the given id |
||||||||||
Headers: |
|
||||||||||
Response: |
HTTP/1.1 200 OK Content-Type: <depending on accept header> Content-Length: <length>
UrlWildcard
ErrorCodes: |
|
---|
3.2.12.4 Delete UrlWildcard
Resource: | /content/urlwildcards/<ID> |
---|---|
Method: | DELETE |
Description: | the given url wildcard is deleted |
Parameters: | |
Response: |
HTTP/1.1 204 No Content
Error Codes: |
|
---|