Skip to content
For AI agents: the complete documentation index is available at llms.txt; this page is also available as Markdown at index.md.
  • Documentation >
  • API >
  • REST API usage >
  • REST responses

REST Responses

Response code

The following list of available HTTP response status codes gives an overview of the meaning of each code. For code details per resource, see the REST API reference.

Code Message Description
200 OK The resource has been found.
201 Created The request to create a new item has succeeded. The response Location header indicates where you can find the created item.
204 No Content The request has succeeded and there is no additional information in the response header or body (for example when publishing or deleting).
301 Moved Permanently The resource shouldn't be accessed this way. The response Location header indicates the proper way.
307 Temporary Redirect The resource is available at another URL considered as its main. The response Location header indicates this main URL.
400 Bad Request The input (payload) doesn't have the proper schema for the resource.
401 Unauthorized The user doesn't have the permission to make this request.
403 Forbidden The user has the permission but action can't be performed because of Repository logic (for example, when trying to create an item with an already existing ID or identifier, when attempting to update a version in another state than draft).
404 Not Found The requested object (or a request data like the parent of a new item) hasn't been found.
405 Method Not Allowed The requested resource doesn't support the HTTP verb that was used.
406 Not Acceptable The request's Accept header isn't supported.
409 Conflict The request is in conflict with another part of the repository (for example, trying to create a new item with an identifier already used).
415 Unsupported Media Type The request payload media type doesn't match the media type specified in the request header.
500 Internal Server Error The server encountered an unexpected condition, usually an exception, which prevents it from fulfilling the request, like database down, permissions or configuration error.
501 Not Implemented Returned when the requested method hasn't yet been implemented. For Cohesivo, most of users, user groups, content items, locations and content types have been implemented. Some of their methods, and other features, may return a 501.

Response headers

A resource's response may contain metadata in its HTTP headers.

Note

For information about the Allow response header, see the OPTIONS method.

Content-Type header

When a response contains an actual HTTP body, the Content-Type header specifies what the body contains. The Content-Type header's value is a media type, like with the request Accept and Content-Type headers.

For example, the first following request without an Accept header returns a default format indicated in the response Content-Type header, while the second request shows that the response is in the requested format.

1
GET /content/objects/52 HTTP/1.1

1
2
HTTP/1.1 200 OK
Content-Type: application/vnd.ibexa.api.ContentInfo+xml

1
2
GET /content/objects/52 HTTP/1.1
Accept: application/vnd.ibexa.api.Content+json

1
2
HTTP/1.1 200 OK
Content-Type: application/vnd.ibexa.api.Content+json

Accept-Patch header

When available, the Accept-Patch tells how the received item could be modified with PATCH.

The following examples also shows that the format (XML or JSON) is adapted:

1
GET /content/objects/52 HTTP/1.1

1
2
3
HTTP/1.1 200 OK
Content-Type: application/vnd.ibexa.api.ContentInfo+xml
Accept-Patch: application/vnd.ibexa.api.ContentUpdate+xml

1
2
GET /content/objects/52 HTTP/1.1
Accept: application/vnd.ibexa.api.Content+json

1
2
3
HTTP/1.1 200 OK
Content-Type: application/vnd.ibexa.api.Content+json
Accept-Patch: application/vnd.ibexa.api.ContentUpdate+json

Those example Accept-Patch headers above indicate that the content could be modified by sending a ContentUpdateStruct in XML or JSON.

Location header

For example, creating content and getting a content item's current version both send a Location header to provide you with the requested resource's ID.

Those particular headers generally match a specific list of HTTP response codes. Location is mainly sent alongside 201 Created, 301 Moved permanently, 307 Temporary redirect responses.

In the following example, the content item's remote ID 34720ff636e1d4ce512f762dc638e4ac corresponds to the ID 52:

1
GET /content/objects?remoteId=34720ff636e1d4ce512f762dc638e4ac" HTTP/1.1

1
2
HTTP/1.1 307 Temporary Redirect
Location: /content/objects/52

In the following example, an erroneous slash has been added to demonstrate the 301 case:

1
GET /content/objects?remoteId=34720ff636e1d4ce512f762dc638e4ac" HTTP/1.1

1
2
HTTP/1.1 301 Moved Permanently
Location: /content/objects?remoteId=34720ff636e1d4ce512f762dc638e4ac

cURL can follow those redirections. On CLI, there is the --location option (or its shorthand -L). The following command-line example follows the two redirections above and the Accept header is propagated:

1
curl --head --location --header "Accept: application/vnd.ibexa.api.Content+json" "https://api.example.com/api/ibexa/v2/content/objects/?remoteId=34720ff636e1d4ce512f762dc638e4ac"

1
2
HTTP/1.1 200 OK
Content-Type: application/vnd.ibexa.api.Content+json

Response body

The response body (both JSON and XML) contain two types of nodes:

  • final nodes that fully give an information as a scalar value
  • reference nodes which link to href where a new resource of a given media-type can be explored if you need to know more
1
curl https://api.example.com/content/objects/52 --header 'Accept: application/vnd.ibexa.api.ContentInfo+xml';

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
<?xml version="1.0" encoding="UTF-8"?>
<Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/52" remoteId="34720ff636e1d4ce512f762dc638e4ac" id="52">
  <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42"/>
  <Name>Ibexa Digital Experience Platform</Name>
  <TranslatedName>Ibexa Digital Experience Platform</TranslatedName>
  <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/52/versions"/>
  <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/52/currentversion"/>
  <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/>
  <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"/>
  <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/52/locations"/>
  <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
  <lastModificationDate>2015-09-17T09:22:23+00:00</lastModificationDate>
  <publishedDate>2015-09-17T09:22:23+00:00</publishedDate>
  <mainLanguageCode>eng-GB</mainLanguageCode>
  <currentVersionNo>1</currentVersionNo>
  <alwaysAvailable>true</alwaysAvailable>
  <isHidden>false</isHidden>
  <status>PUBLISHED</status>
  <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/52/objectstates"/>
</Content>
View as Markdown View on GitHub