Ibexa Developer Documentation Ibexa User Documentation
Ibexa
search

Root resources

/

List of root resources

GET /

Lists the root resources of the Ibexa Platform installation.

Header parameters

Accept

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

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

Types
Type Description
Root This class represents a root.
RootWrapper JSON object with only a Root property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Root media-type="application/vnd.ibexa.api.Root+xml">
    <content media-type="" href="/api/ibexa/v2/content/objects"/>
    <contentByRemoteId media-type="" href="/api/ibexa/v2/content/objects{?remoteId}"/>
    <contentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/types"/>
    <contentTypeByIdentifier media-type="" href="/api/ibexa/v2/content/types{?identifier}"/>
    <contentTypeGroups media-type="application/vnd.ibexa.api.ContentTypeGroupList+xml" href="/api/ibexa/v2/content/typegroups"/>
    <contentTypeGroupByIdentifier media-type="" href="/api/ibexa/v2/content/typegroups{?identifier}"/>
    <users media-type="application/vnd.ibexa.api.UserRefList+xml" href="/api/ibexa/v2/user/users"/>
    <roles media-type="application/vnd.ibexa.api.RoleList+xml" href="/api/ibexa/v2/user/roles"/>
    <rootLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"/
View more

file_copy 

                                {
    "Root": {
        "_media-type": "application/vnd.ibexa.api.Root+json",
        "content": {
            "_href": "/api/ibexa/v2/content/objects",
            "_media-type": ""
        },
        "contentByRemoteId": {
            "_href": "/api/ibexa/v2/content/objects{?remoteId}",
            "_media-type": ""
        },
        "contentTypeByIdentifier": {
            "_href": "/api/ibexa/v2/content/types{?identifier}",
            "_media-type": ""
        },
        "contentTypeGroupByIdentifier": {
            "_href": "/api/ibexa/v2/content/typegroups{?identifier}",
            "_media-type": ""
        },
        "contentTypeGroups": {
            "_href": "/api/ibexa/v2/content/typegroups",
            "_media-type": "application/vnd.ibexa.api.ContentTypeGroupList+json"
        },
        "contentTypes": {
            "_href": "/api/ibexa/v2/content/types",
            "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json"
        },
        "createSession":
View more

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.ibexa.api.BookmarkList+xml application/vnd.ibexa.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.
BookmarkListWrapper JSON object with only a BookmarkList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<BookmarkList media-type="application/vnd.ibexa.api.BookmarkList+xml">
    <count>3</count>
    <Bookmark media-type="application/vnd.ibexa.api.Bookmark+xml" _href="/api/ibexa/v2/bookmark/65">
        <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/57/65">
            <id>65</id>
            <priority>0</priority>
            <hidden>false</hidden>
            <invisible>false</invisible>
            <explicitlyHidden>false</explicitlyHidden>
            <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/57"/>
            <pathString>/1/2/57/65/</pathString>
            <depth>3</depth>
            <childCount>0</childCount>
            <remoteId>aa538e305aea472eb221ce23d1cc4b50</remoteId>
            <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/57/65/children"/>
View more

file_copy 

                                {
    "BookmarkList": {
        "_media-type": "application/vnd.ibexa.api.BookmarkList+json",
        "count": 3,
        "items": [
            {
                "_media-type": "application/vnd.ibexa.api.Bookmark+json",
                "__href": "/api/ibexa/v2/bookmark/65",
                "Location": {
                    "_media-type": "application/vnd.ibexa.api.Location+json",
                    "_href": "/api/ibexa/v2/content/locations/1/2/57/65",
                    "id": 65,
                    "priority": 0,
                    "hidden": false,
                    "invisible": false,
                    "explicitlyHidden": false,
                    "ParentLocation": {
                        "_media-type": "application/vnd.ibexa.api.Location+json",
                        "_href": "/api/ibexa/v2/content/locations/1/2/57"
                    },
                    "pathString": "/1/2/57/65/",
                    "depth": 3,
                    "childCount": 0,
View more

/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.ibexa.api.Content+xml application/vnd.ibexa.api.Content+json application/vnd.ibexa.api.ContentInfo+xml application/vnd.ibexa.api.ContentInfo+json

Content-Type

The ContentCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ContentCreate+xml application/vnd.ibexa.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.
ContentCreateWrapper JSON object with only a ContentCreate property.
Content Content ID matcher class.
ContentWrapper JSON object with only a Content property.
ContentInfoWrapper JSON object with only a ContentInfo property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentCreate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContentType href="/api/ibexa/v2/content/types/2"/>
  <mainLanguageCode>eng-GB</mainLanguageCode>
  <LocationCreate>
    <ParentLocation href="/api/ibexa/v2/content/locations/1/2"/>
    <priority>0</priority>
    <hidden>false</hidden>
    <sortField>PATH</sortField>
    <sortOrder>ASC</sortOrder>
  </LocationCreate>
  <Section href="/api/ibexa/v2/content/sections/1"/>
  <alwaysAvailable>true</alwaysAvailable>
  <remoteId></remoteId>
  <fields>
    <field>
      <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier>
      <languageCode>eng-GB</languageCode>
      <fieldValue>draft article</fieldValue>
    </field>
    <field>
      <fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier>
      <languageCode>eng-GB</languageCode>
      <fieldValue>
        <value key="xml"><![CDATA[<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></
View more

file_copy 

                                {
  "ContentCreate": {
    "ContentType": {
      "_href": "/api/ibexa/v2/content/types/2"
      },
    "mainLanguageCode": "eng-GB",
    "LocationCreate": {
      "ParentLocation": {
        "_href": "/api/ibexa/v2/content/locations/1/2"
       },
      "priority": "0",
      "hidden": "false",
      "sortField": "PATH",
      "sortOrder": "ASC"
    },
    "Section": {
      "_href": "/api/ibexa/v2/content/sections/1"
    },
    "alwaysAvailable": "true",
    "fields": {
      "field": [
        {
          "fieldDefinitionIdentifier": "title",
          "languageCode": "eng-GB",
          "fieldTypeIdentifier": "ezstring",
          "fieldValue": "draft article"
        },
        {
          "fieldDefinitionIdentifier": "intro",
          "languageCode": "eng-GB",
          "fieldTypeIdentifier": "ezrichtext",
          "fieldValue":
           {
                "xml": "<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"><p>draft draft</p></section>"
            }
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/108" remoteId="25c5c35ab9d18e88bd2ee77991b730e2" id="108">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/>
    <Name>draft article</Name>
    <TranslatedName>draft article</TranslatedName>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/108/versions"/>
    <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/108/currentversion">
        <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/108/versions/1">
            <VersionInfo>
                <id>586</id>
                <versionNo>1</versionNo>
                <status>DRAFT</status>
                <modificationDate>2023-05-24T06:24:46+00:00</modificationDate>
                <Creator medi
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/110" remoteId="59258c7a8c545db8a641742138d11d82" id="110">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/>
    <Name>draft article</Name>
    <TranslatedName>draft article</TranslatedName>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/110/versions"/>
    <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/110/currentversion"/>
    <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/>
    <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/110/locations"/>
    <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <mainLanguageCode>eng-GB</mai
View more

file_copy 

                                {
    "Content": {
        "_media-type": "application/vnd.ibexa.api.Content+json",
        "_href": "/api/ibexa/v2/content/objects/109",
        "_remoteId": "8716f007ba15f6f35139acb55e39b811",
        "_id": 109,
        "ContentType": {
            "_media-type": "application/vnd.ibexa.api.ContentType+json",
            "_href": "/api/ibexa/v2/content/types/2"
        },
        "Name": "draft article",
        "TranslatedName": "draft article",
        "Versions": {
            "_media-type": "application/vnd.ibexa.api.VersionList+json",
            "_href": "/api/ibexa/v2/content/objects/109/versions"
        },
        "CurrentVersion": {
            "_media-type": "application/vnd.ibexa.api.Version+json",
            "_href": "/api/ibexa/v2/content/objects/109/currentversion",
            "Version": {
                "_media-type": "application/vnd.ibexa.api.Version+json",
                "_href": "/api/ibexa/v2/content/objects/109/versions/1",
                "VersionInfo": {
View more
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.ibexa.api.Content+xml application/vnd.ibexa.api.Content+json application/vnd.ibexa.api.ContentInfo+xml application/vnd.ibexa.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.
ContentWrapper JSON object with only a Content property.
ContentInfo This class provides all version independent information of the content item.
ContentInfoWrapper JSON object with only a ContentInfo property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/54" remoteId="9e863fbb0fb835ce050032b4f00de61d" id="54">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/>
    <Name>Forms</Name>
    <TranslatedName>Forms</TranslatedName>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/54/versions"/>
    <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/54/currentversion">
        <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/54/versions/1">
            <VersionInfo>
                <id>514</id>
                <versionNo>1</versionNo>
                <status>PUBLISHED</status>
                <modificationDate>2018-09-17T06:48:13+00:00</modificationDate>
                <Creator media-type="applicati
View more

file_copy 

                                {
    "Content": {
        "_media-type": "application/vnd.ibexa.api.Content+json",
        "_href": "/api/ibexa/v2/content/objects/54",
        "_remoteId": "9e863fbb0fb835ce050032b4f00de61d",
        "_id": 54,
        "ContentType": {
            "_media-type": "application/vnd.ibexa.api.ContentType+json",
            "_href": "/api/ibexa/v2/content/types/1"
        },
        "Name": "Forms",
        "TranslatedName": "Forms",
        "Versions": {
            "_media-type": "application/vnd.ibexa.api.VersionList+json",
            "_href": "/api/ibexa/v2/content/objects/54/versions"
        },
        "CurrentVersion": {
            "_media-type": "application/vnd.ibexa.api.Version+json",
            "_href": "/api/ibexa/v2/content/objects/54/currentversion",
            "Version": {
                "_media-type": "application/vnd.ibexa.api.Version+json",
                "_href": "/api/ibexa/v2/content/objects/54/versions/1",
                "VersionInfo": {
                    "i
View more
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.ibexa.api.ContentInfo+xml application/vnd.ibexa.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.ibexa.api.ContentUpdate+xml application/vnd.ibexa.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.
ContentInfoWrapper JSON object with only a ContentInfo property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentUpdate>
  <mainLanguageCode>eng-GB</mainLanguageCode>
  <Section href="/api/ibexa/v2/content/sections/1"/>
  <MainLocation href="/api/ibexa/v2/content/locations/2/63/66"/>
  <Owner href="/api/ibexa/v2/user/users/11"/>
  <alwaysAvailable>false</alwaysAvailable>
  <remoteId>69848aeb86164c35e5c98202eebe9e05</remoteId>
</ContentUpdate>
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/80" remoteId="69848aeb86164c35e5c98202eebe9e05" id="80">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/>
    <Name>article1</Name>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/80/versions"/>
    <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/80/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/63/66"/>
    <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/80/locations"/>
    <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api
View more
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.
VersionWrapper JSON object with only a Version property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/2">
    <VersionInfo>
        <id>578</id>
        <versionNo>2</versionNo>
        <status>PUBLISHED</status>
        <modificationDate>2023-05-24T05:59:09+00:00</modificationDate>
        <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
        <creationDate>2023-05-24T05:59:02+00:00</creationDate>
        <initialLanguageCode>eng-GB</initialLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml">
            <Language>
                <languageCode>eng-GB</languageCode>
            </Language>
        </VersionTranslationInfo>
        <names>
            <value languageCode="eng-GB">Features</value>
        </names>
        <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="
View more

file_copy 

                                {
    "Version": {
        "_media-type": "application/vnd.ibexa.api.Version+json",
        "_href": "/api/ibexa/v2/content/objects/107/versions/2",
        "VersionInfo": {
            "id": 578,
            "versionNo": 2,
            "status": "PUBLISHED",
            "modificationDate": "2023-05-24T05:59:09+00:00",
            "Creator": {
                "_media-type": "application/vnd.ibexa.api.User+json",
                "_href": "/api/ibexa/v2/user/users/14"
            },
            "creationDate": "2023-05-24T05:59:02+00:00",
            "initialLanguageCode": "eng-GB",
            "languageCodes": "eng-GB",
            "VersionTranslationInfo": {
                "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
                "Language": [
                    {
                        "languageCode": "eng-GB"
                    }
                ]
            },
            "names": {
                "value": [
                    {
View more
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.ibexa.api.Version+xml application/vnd.ibexa.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.
VersionWrapper JSON object with only a Version property.
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/4">
    <VersionInfo>
        <id>580</id>
        <versionNo>4</versionNo>
        <status>DRAFT</status>
        <modificationDate>2023-05-24T06:08:47+00:00</modificationDate>
        <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
        <creationDate>2023-05-24T06:08:47+00:00</creationDate>
        <initialLanguageCode>eng-GB</initialLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml">
            <Language>
                <languageCode>eng-GB</languageCode>
            </Language>
        </VersionTranslationInfo>
        <names>
            <value languageCode="eng-GB">Features</value>
        </names>
        <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api
View more

file_copy 

                                {
    "Version": {
        "_media-type": "application/vnd.ibexa.api.Version+json",
        "_href": "/api/ibexa/v2/content/objects/107/versions/5",
        "VersionInfo": {
            "id": 581,
            "versionNo": 5,
            "status": "DRAFT",
            "modificationDate": "2023-05-24T06:09:49+00:00",
            "Creator": {
                "_media-type": "application/vnd.ibexa.api.User+json",
                "_href": "/api/ibexa/v2/user/users/14"
            },
            "creationDate": "2023-05-24T06:09:49+00:00",
            "initialLanguageCode": "eng-GB",
            "languageCodes": "eng-GB",
            "VersionTranslationInfo": {
                "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
                "Language": [
                    {
                        "languageCode": "eng-GB"
                    }
                ]
            },
            "names": {
                "value": [
                    {
View more

/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.ibexa.api.VersionList+xml application/vnd.ibexa.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.
VersionListWrapper JSON object with only a VersionList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<VersionList media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/61/versions">
    <VersionItem>
        <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/61/versions/1"/>
        <VersionInfo>
            <id>521</id>
            <versionNo>1</versionNo>
            <status>PUBLISHED</status>
            <modificationDate>2021-06-28T11:33:49+00:00</modificationDate>
            <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
            <creationDate>2021-06-28T11:33:31+00:00</creationDate>
            <initialLanguageCode>eng-GB</initialLanguageCode>
            <languageCodes>eng-GB</languageCodes>
            <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml">
                <Language>
                    <languageCode>eng-GB</languageCode>
                </Language>
View more

file_copy 

                                {
    "VersionList": {
        "_media-type": "application/vnd.ibexa.api.VersionList+json",
        "_href": "/api/ibexa/v2/content/objects/61/versions",
        "VersionItem": [
            {
                "Version": {
                    "_media-type": "application/vnd.ibexa.api.Version+json",
                    "_href": "/api/ibexa/v2/content/objects/61/versions/1"
                },
                "VersionInfo": {
                    "id": 521,
                    "versionNo": 1,
                    "status": "PUBLISHED",
                    "modificationDate": "2021-06-28T11:33:49+00:00",
                    "Creator": {
                        "_media-type": "application/vnd.ibexa.api.User+json",
                        "_href": "/api/ibexa/v2/user/users/14"
                    },
                    "creationDate": "2021-06-28T11:33:31+00:00",
                    "initialLanguageCode": "eng-GB",
                    "languageCodes": "eng-GB",
                    "VersionTrans
View more

/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.ibexa.api.Version+xml application/vnd.ibexa.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.
VersionWrapper JSON object with only a Version property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/5">
    <VersionInfo>
        <id>581</id>
        <versionNo>5</versionNo>
        <status>ARCHIVED</status>
        <modificationDate>2023-05-24T06:11:50+00:00</modificationDate>
        <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
        <creationDate>2023-05-24T06:09:49+00:00</creationDate>
        <initialLanguageCode>eng-GB</initialLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml">
            <Language>
                <languageCode>eng-GB</languageCode>
            </Language>
        </VersionTranslationInfo>
        <names>
            <value languageCode="eng-GB">Features</value>
        </names>
        <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/
View more

file_copy 

                                {
    "Version": {
        "_media-type": "application/vnd.ibexa.api.Version+json",
        "_href": "/api/ibexa/v2/content/objects/107/versions/5",
        "VersionInfo": {
            "id": 581,
            "versionNo": 5,
            "status": "ARCHIVED",
            "modificationDate": "2023-05-24T06:11:50+00:00",
            "Creator": {
                "_media-type": "application/vnd.ibexa.api.User+json",
                "_href": "/api/ibexa/v2/user/users/14"
            },
            "creationDate": "2023-05-24T06:09:49+00:00",
            "initialLanguageCode": "eng-GB",
            "languageCodes": "eng-GB",
            "VersionTranslationInfo": {
                "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
                "Language": [
                    {
                        "languageCode": "eng-GB"
                    }
                ]
            },
            "names": {
                "value": [
                    {
View more
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.ibexa.api.Version+xml application/vnd.ibexa.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.ibexa.api.VersionUpdate+xml application/vnd.ibexa.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 This class is used to update a content version.
VersionUpdateWrapper JSON object with only a VersionUpdate property.
Version Returns the VersionInfo for this version.
VersionWrapper JSON object with only a Version property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<VersionUpdate xmlns:p="http://ibexa.co/API/Values"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://ibexa.co/API/Values ../VersionUpdate.xsd ">
  <modificationDate>2012-02-20T12: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 neuse Zusammenfassungy</fieldValue>
    </field>
  </fields>
</VersionUpdate>
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Version href="/content/objects/23/versions/4" media-type="application/vnd.ibexa.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.ibexa.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.ibexa.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>
      <language
View more
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.ibexa.api.Version+xml application/vnd.ibexa.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.
VersionWrapper JSON object with only a Version property.
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/7">
    <VersionInfo>
        <id>583</id>
        <versionNo>7</versionNo>
        <status>DRAFT</status>
        <modificationDate>2023-05-24T06:13:50+00:00</modificationDate>
        <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
        <creationDate>2023-05-24T06:13:50+00:00</creationDate>
        <initialLanguageCode>eng-GB</initialLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml">
            <Language>
                <languageCode>eng-GB</languageCode>
            </Language>
        </VersionTranslationInfo>
        <names>
            <value languageCode="eng-GB">Features</value>
        </names>
        <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api
View more

file_copy 

                                {
    "Version": {
        "_media-type": "application/vnd.ibexa.api.Version+json",
        "_href": "/api/ibexa/v2/content/objects/107/versions/8",
        "VersionInfo": {
            "id": 584,
            "versionNo": 8,
            "status": "DRAFT",
            "modificationDate": "2023-05-24T06:14:07+00:00",
            "Creator": {
                "_media-type": "application/vnd.ibexa.api.User+json",
                "_href": "/api/ibexa/v2/user/users/14"
            },
            "creationDate": "2023-05-24T06:14:07+00:00",
            "initialLanguageCode": "eng-GB",
            "languageCodes": "eng-GB",
            "VersionTranslationInfo": {
                "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
                "Language": [
                    {
                        "languageCode": "eng-GB"
                    }
                ]
            },
            "names": {
                "value": [
                    {
View more
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.ibexa.api.RelationList+xml application/vnd.ibexa.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.
RelationListWrapper JSON object with only a Relations property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/107/versions/9/relations">
    <Relation media-type="application/vnd.ibexa.api.Relation+xml" href="/api/ibexa/v2/content/objects/107/versions/9/relations/7">
        <SourceContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/107"/>
        <DestinationContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/52"/>
        <RelationType>LINK</RelationType>
    </Relation>
</Relations>
View more

file_copy 

                                {
    "Relations": {
        "_media-type": "application/vnd.ibexa.api.RelationList+json",
        "_href": "/api/ibexa/v2/content/objects/107/versions/9/relations",
        "Relation": [
            {
                "_media-type": "application/vnd.ibexa.api.Relation+json",
                "_href": "/api/ibexa/v2/content/objects/107/versions/9/relations/7",
                "SourceContent": {
                    "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
                    "_href": "/api/ibexa/v2/content/objects/107"
                },
                "DestinationContent": {
                    "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
                    "_href": "/api/ibexa/v2/content/objects/52"
                },
                "RelationType": "LINK"
            }
        ]
    }
}
View more
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.ibexa.api.Relation+xml application/vnd.ibexa.api.Relation+json

Content-Type

The RelationCreate schema encoded in XML or JSON format.

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

Types
Type Description
RelationCreate
RelationCreateWrapper JSON object with only a RelationCreate property.
Relation Class representing a relation between content.
RelationWrapper JSON object with only a Relation property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RelationCreate>
  <Destination href="/api/ibexa/v2/content/objects/59"/>
</RelationCreate>
View more

file_copy 

                                {
    "RelationCreate": {
        "Destination": {
            "_href": "/api/ibexa/v2/content/objects/59"
        }
    }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Relation media-type="application/vnd.ibexa.api.Relation+xml" href="/api/ibexa/v2/content/objects/59/versions/2/relations/40">
    <SourceContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/59"/>
    <DestinationContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/59"/>
    <RelationType>COMMON</RelationType>
</Relation>
View more

file_copy 

                                {
    "Relation": {
        "_media-type": "application/vnd.ibexa.api.Relation+json",
        "_href": "/api/ibexa/v2/content/objects/59/versions/2/relations/38",
        "SourceContent": {
            "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
            "_href": "/api/ibexa/v2/content/objects/59"
        },
        "DestinationContent": {
            "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
            "_href": "/api/ibexa/v2/content/objects/59"
        },
        "RelationType": "COMMON"
    }
}
View more

/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.ibexa.api.Relation+xml application/vnd.ibexa.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.
RelationWrapper JSON object with only a Relation property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Relation media-type="application/vnd.ibexa.api.Relation+xml" href="/api/ibexa/v2/content/objects/86/versions/1/relations/1">
    <SourceContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/86"/>
    <DestinationContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/86"/>
    <RelationType>COMMON</RelationType>
</Relation>
View more
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.ibexa.api.Location+xml application/vnd.ibexa.api.Location+json

Content-Type

The LocationCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.LocationCreate+json application/vnd.ibexa.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
LocationCreateWrapper JSON object with only a LocationCreate property.
Location This class represents a Location in the Repository.
LocationWrapper JSON object with only a Location property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<LocationCreate>
  <ParentLocation href="/api/ibexa/v2/content/locations/1/42" />
  <priority>0</priority>
  <hidden>false</hidden>
  <sortField>PATH</sortField>
  <sortOrder>ASC</sortOrder>
</LocationCreate>
View more

file_copy 

                                {
    "LocationCreate": {
        "ParentLocation": {
            "_href": "/api/ibexa/v2/content/locations/1/59"
        },
        "priority": "0",
        "hidden": false,
        "sortField": "PATH",
        "sortOrder": "ASC"
    }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/42/96">
    <id>96</id>
    <priority>0</priority>
    <hidden>false</hidden>
    <invisible>true</invisible>
    <explicitlyHidden>false</explicitlyHidden>
    <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/42"/>
    <pathString>/1/2/42/96/</pathString>
    <depth>3</depth>
    <childCount>0</childCount>
    <remoteId>58133c8c75230e5debe362a28b92d27a</remoteId>
    <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/42/96/children"/>
    <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/63"/>
    <sortField>PATH</sortField>
    <sortOrder>ASC</sortOrder>
    <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/42/96/urlalia
View more

file_copy 

                                {
    "Location": {
        "_media-type": "application/vnd.ibexa.api.Location+json",
        "_href": "/api/ibexa/v2/content/locations/1/2/59/114",
        "id": 114,
        "priority": 0,
        "hidden": false,
        "invisible": false,
        "explicitlyHidden": false,
        "ParentLocation": {
            "_media-type": "application/vnd.ibexa.api.Location+json",
            "_href": "/api/ibexa/v2/content/locations/1/2/59"
        },
        "pathString": "/1/2/59/114/",
        "depth": 3,
        "childCount": 0,
        "remoteId": "47a1e4ee082fb64e93a822dcfe3a5614",
        "Children": {
            "_media-type": "application/vnd.ibexa.api.LocationList+json",
            "_href": "/api/ibexa/v2/content/locations/1/2/59/114/children"
        },
        "Content": {
            "_media-type": "application/vnd.ibexa.api.Content+json",
            "_href": "/api/ibexa/v2/content/objects/59"
        },
        "sortField": "PATH",
        "sortOrder": "ASC",
        "UrlAli
View more
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.ibexa.api.LocationList+xml application/vnd.ibexa.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).
LocationListWrapper JSON object with only a LocationList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<LocationList media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/63/locations">
    <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/57/65"/>
</LocationList>
View more

file_copy 

                                {
    "LocationList": {
        "_media-type": "application/vnd.ibexa.api.LocationList+json",
        "_href": "/api/ibexa/v2/content/objects/63/locations",
        "Location": [
            {
                "_media-type": "application/vnd.ibexa.api.Location+json",
                "_href": "/api/ibexa/v2/content/locations/1/2/57/65"
            }
        ]
    }
}
View more

/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.ibexa.api.ContentObjectStates+xml application/vnd.ibexa.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 Represents a list of object states.
ContentObjectStatesWrapper JSON object with only a ContentObjectStates property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml">
    <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/1"/>
    <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/3/objectstates/3"/>
    <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/7/objectstates/7"/>
    <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/8/objectstates/8"/>
</ContentObjectStates>
View more

file_copy 

                                {
    "ContentObjectStates": {
        "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
        "ObjectState": [
            {
                "_media-type": "application/vnd.ibexa.api.ObjectState+json",
                "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/1"
            },
            {
                "_media-type": "application/vnd.ibexa.api.ObjectState+json",
                "_href": "/api/ibexa/v2/content/objectstategroups/3/objectstates/3"
            },
            {
                "_media-type": "application/vnd.ibexa.api.ObjectState+json",
                "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates/7"
            },
            {
                "_media-type": "application/vnd.ibexa.api.ObjectState+json",
                "_href": "/api/ibexa/v2/content/objectstategroups/8/objectstates/8"
            }
        ]
    }
}
View more
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.ibexa.api.ContentObjectStates+xml application/vnd.ibexa.api.ContentObjectStates+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.ContentObjectStates+xml application/vnd.ibexa.api.ContentObjectStates+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
ContentObjectStates Represents a list of object states.
ContentObjectStatesWrapper JSON object with only a ContentObjectStates property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentObjectStates>
    <ObjectState href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2" />
</ContentObjectStates>
View more

file_copy 

                                {
    "ContentObjectStates": {
        "ObjectState": [
            {
                "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/2"
            }
        ]
    }
}
View more
Code: 204

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml">
 <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2"/>
</ContentObjectStates>
View more

file_copy 

                                {
    "ContentObjectStates": {
        "_media-type": "application\/vnd.ibexa.api.ContentObjectStates+json",
        "ObjectState": [
            {
                "_media-type": "application\/vnd.ibexa.api.ObjectState+json",
                "_href": "\/api\/ibexa\/v2\/content\/objectstategroups\/2\/objectstates\/2"
            }
        ]
    }
}
View more

/content/objects/{contentId}/hide

Hide content item

POST /content/objects/{contentId}/hide

Makes or keep the content item invisible

Possible responses
Code Description
204

OK - Object item is hidden.
401

Error - The user has no permission to change Object item visibility.
404

Error - The content item was not found.

/content/objects/{contentId}/reveal

Reveal content item

POST /content/objects/{contentId}/reveal

Makes or keep the content item visible

Possible responses
Code Description
204

OK - Object item is revealed.
401

Error - The user has no permission to change Object item visibility.
404

Error - The content item was not found.

/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.ibexa.api.ObjectStateGroupList+xml application/vnd.ibexa.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.
ObjectStateGroupListWrapper JSON object with only a ObjectStateGroupList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateGroupList media-type="application/vnd.ibexa.api.ObjectStateGroupList+xml" href="/api/ibexa/v2/content/objectstategroups">
    <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/2">
        <id>2</id>
        <identifier>ez_lock</identifier>
        <defaultLanguageCode>eng-GB</defaultLanguageCode>
        <languageCodes>eng-GB</languageCodes>
        <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/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.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/3">
        <id>3</id>
        <identifier>accessi
View more

file_copy 

                                {
    "ObjectStateGroupList": {
        "_media-type": "application/vnd.ibexa.api.ObjectStateGroupList+json",
        "_href": "/api/ibexa/v2/content/objectstategroups",
        "ObjectStateGroup": [
            {
                "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json",
                "_href": "/api/ibexa/v2/content/objectstategroups/2",
                "id": 2,
                "identifier": "ez_lock",
                "defaultLanguageCode": "eng-GB",
                "languageCodes": "eng-GB",
                "ObjectStates": {
                    "_media-type": "application/vnd.ibexa.api.ObjectStateList+json",
                    "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates"
                },
                "names": {
                    "value": [
                        {
                            "_languageCode": "eng-GB",
                            "#text": "Lock"
                        }
                    ]
                },
View more
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.ibexa.api.ObjectStateGroup+xml application/vnd.ibexa.api.ObjectStateGroup+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.ObjectStateGroupCreate+json application/vnd.ibexa.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 This class represents a value for creating Object state groups.
ObjectStateGroupCreateWrapper JSON object with only a ObjectStateGroupCreate property.
ObjectStateGroup This class represents an Object state group value.
ObjectStateGroupWrapper JSON object with only a ObjectStateGroup property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateGroupCreate>
    <identifier>custom</identifier>
    <defaultLanguageCode>eng-GB</defaultLanguageCode>
    <names>
        <value languageCode="eng-GB">Custom State</value>
    </names>
    <descriptions>
        <value languageCode="eng-GB">Custom Object state</value>
    </descriptions>
</ObjectStateGroupCreate>
View more

file_copy 

                                {
    "ObjectStateGroupCreate": {
        "identifier": "custom-states",
        "defaultLanguageCode": "eng-GB",
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Custom State"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Custom Object state"
                }
            ]
        }
    }
}
View more
Code: 201

file_copy 

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

file_copy 

                                {
    "ObjectStateGroup": {
        "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json",
        "_href": "/api/ibexa/v2/content/objectstategroups/7",
        "id": 7,
        "identifier": "custom-states",
        "defaultLanguageCode": "eng-GB",
        "languageCodes": "eng-GB",
        "ObjectStates": {
            "_media-type": "application/vnd.ibexa.api.ObjectStateList+json",
            "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates"
        },
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Custom State"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Custom Object state"
                }
            ]
        }
    }
}
View more

/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.ibexa.api.ObjectStateGroup+xml application/vnd.ibexa.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.
ObjectStateGroupWrapper JSON object with only a ObjectStateGroup property.
Code: 200

file_copy 

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

file_copy 

                                {
    "ObjectStateGroup": {
        "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json",
        "_href": "/api/ibexa/v2/content/objectstategroups/7",
        "id": 7,
        "identifier": "custom-states",
        "defaultLanguageCode": "eng-GB",
        "languageCodes": "eng-GB",
        "ObjectStates": {
            "_media-type": "application/vnd.ibexa.api.ObjectStateList+json",
            "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates"
        },
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Custom State"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Custom Object state"
                }
            ]
        }
    }
}
View more
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.ibexa.api.ObjectStateGroup+xml application/vnd.ibexa.api.ObjectStateGroup+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.ObjectStateGroupUpdate+json application/vnd.ibexa.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 This class represents a value for updating Object state groups.
ObjectStateGroupUpdateWrapper JSON object with only a ObjectStateGroupUpdate property.
ObjectStateGroup This class represents an Object state group value.
ObjectStateGroupWrapper JSON object with only a ObjectStateGroup property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateGroupUpdate>
    <names>
        <value languageCode="eng-GB">New Custom State name</value>
    </names>
</ObjectStateGroupUpdate>
View more

file_copy 

                                {
    "ObjectStateGroupUpdate": {
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "New Custom State name"
                }
            ]
        }
    }
}
View more
Code: 200

file_copy 

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

file_copy 

                                {
    "ObjectStateGroup": {
        "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json",
        "_href": "/api/ibexa/v2/content/objectstategroups/7",
        "id": 7,
        "identifier": "custom-states",
        "defaultLanguageCode": "eng-GB",
        "languageCodes": "eng-GB",
        "ObjectStates": {
            "_media-type": "application/vnd.ibexa.api.ObjectStateList+json",
            "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates"
        },
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "New Custom State name"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Custom Object state"
                }
            ]
        }
    }
}
View more
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/{objectStateGroupId}/objectstates

List Object states

GET /content/objectstategroups/{objectStateGroupId}/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.ibexa.api.ObjectStateList+xml application/vnd.ibexa.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.
ObjectStateListWrapper JSON object with only a ObjectStateList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateList media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates">
    <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/1">
        <id>1</id>
        <identifier>not_locked</identifier>
        <priority>0</priority>
        <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/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.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2">
View more

file_copy 

                                {
    "ObjectStateList": {
        "_media-type": "application/vnd.ibexa.api.ObjectStateList+json",
        "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates",
        "ObjectState": [
            {
                "_media-type": "application/vnd.ibexa.api.ObjectState+json",
                "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/1",
                "id": 1,
                "identifier": "not_locked",
                "priority": 0,
                "ObjectStateGroup": {
                    "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json",
                    "_href": "/api/ibexa/v2/content/objectstategroups/2"
                },
                "defaultLanguageCode": "eng-GB",
                "languageCodes": "eng-GB",
                "names": {
                    "value": [
                        {
                            "_languageCode": "eng-GB",
                            "#text": "Not locked"
                        }
View more
Create Object state

POST /content/objectstategroups/{objectStateGroupId}/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.ibexa.api.ObjectState+xml application/vnd.ibexa.api.ObjectState+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.ObjectStateCreate+json application/vnd.ibexa.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 This class represents a value for creating Object states.
ObjectStateCreateWrapper JSON object with only a ObjectStateCreate property.
ObjectState This class represents a Object state value.
ObjectStateWrapper JSON object with only a ObjectState property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateCreate>
  <identifier>new-state</identifier>
  <priority>1</priority>
  <defaultLanguageCode>eng-GB</defaultLanguageCode>
  <names>
    <value languageCode="eng-GB">New State</value>
  </names>
  <descriptions>
    <value languageCode="eng-GB">New Object State</value>
  </descriptions>
</ObjectStateCreate>
View more

file_copy 

                                {
    "ObjectStateCreate": {
        "identifier": "new-state",
        "priority": "1",
        "defaultLanguageCode": "eng-GB",
        "languageCodes": "eng-GB",
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "New State"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "New Object State"
                }
            ]
        }
    }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/7/objectstates/5">
    <id>5</id>
    <identifier>new-state</identifier>
    <priority>0</priority>
    <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/7"/>
    <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>
View more

file_copy 

                                {
    "ObjectState": {
        "_media-type": "application/vnd.ibexa.api.ObjectState+json",
        "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates/7",
        "id": 7,
        "identifier": "new-state",
        "priority": 0,
        "ObjectStateGroup": {
            "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json",
            "_href": "/api/ibexa/v2/content/objectstategroups/7"
        },
        "defaultLanguageCode": "eng-GB",
        "languageCodes": "eng-GB",
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "New State"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "New Object State"
                }
            ]
        }
    }
}
View more

/content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}

Get Object state

GET /content/objectstategroups/{objectStateGroupId}/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.ibexa.api.ObjectState+xml application/vnd.ibexa.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.
ObjectStateWrapper JSON object with only a ObjectState property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/6/objectstates/2">
<id>2</id>
<identifier>locked</identifier>
<priority>1</priority>
<ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/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>
View more

file_copy 

                                {
    "ObjectState": {
        "_media-type": "application/vnd.ibexa.api.ObjectState+json",
        "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/2",
        "id": 2,
        "identifier": "locked",
        "priority": 1,
        "ObjectStateGroup": {
            "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json",
            "_href": "/api/ibexa/v2/content/objectstategroups/2"
        },
        "defaultLanguageCode": "eng-GB",
        "languageCodes": "eng-GB",
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Locked"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": ""
                }
            ]
        }
    }
}
View more
Update Object state

PATCH /content/objectstategroups/{objectStateGroupId}/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.ibexa.api.ObjectState+xml application/vnd.ibexa.api.ObjectState+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.ObjectStateUpdate+json application/vnd.ibexa.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 This class represents a value for updating Object states.
ObjectStateUpdateWrapper JSON object with only a ObjectStateUpdate property.
ObjectState This class represents a Object state value.
ObjectStateWrapper JSON object with only a ObjectState property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ObjectStateUpdate>
  <priority>3</priority>
  <defaultLanguageCode>eng-GB</defaultLanguageCode>
  <names>
    <value languageCode="eng-GB">New Object State name</value>
  </names>
</ObjectStateUpdate>
View more

file_copy 

                                {
    "ObjectStateUpdate": {
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "New Object State name"
                }
            ]
        }
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2">
    <id>2</id>
    <identifier>locked</identifier>
    <priority>1</priority>
    <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/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>
View more

file_copy 

                                {
    "ObjectState": {
        "_media-type": "application/vnd.ibexa.api.ObjectState+json",
        "_href": "/api/ibexa/v2/content/objectstategroups/6/objectstates/9",
        "id": 9,
        "identifier": "closed",
        "priority": 1,
        "ObjectStateGroup": {
            "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json",
            "_href": "/api/ibexa/v2/content/objectstategroups/6"
        },
        "defaultLanguageCode": "eng-GB",
        "languageCodes": "eng-GB",
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "New Object State name"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": ""
                }
            ]
        }
    }
}
View more
Delete Object state

DELETE /content/objectstategroups/{objectStateGroupId}/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.

Header parameters

Accept

Property Value
Type string
Examples application/vnd.ibexa.api.LocationList+xml application/vnd.ibexa.api.LocationList+json
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.
LocationWrapper JSON object with only a Location property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/58">
    <id>58</id>
    <priority>0</priority>
    <hidden>false</hidden>
    <invisible>false</invisible>
    <explicitlyHidden>false</explicitlyHidden>
    <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"/>
    <pathString>/1/2/58/</pathString>
    <depth>2</depth>
    <childCount>3</childCount>
    <remoteId>0cfe62f27753448d79aaa8acd8d01699</remoteId>
    <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/58/children"/>
    <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/>
    <sortField>PATH</sortField>
    <sortOrder>ASC</sortOrder>
    <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/58/urlaliases"/>
    <Co
View more

file_copy 

                                {
    "Location": {
        "_media-type": "application/vnd.ibexa.api.Location+json",
        "_href": "/api/ibexa/v2/content/locations/1/2/58",
        "id": 58,
        "priority": 0,
        "hidden": false,
        "invisible": false,
        "explicitlyHidden": false,
        "ParentLocation": {
            "_media-type": "application/vnd.ibexa.api.Location+json",
            "_href": "/api/ibexa/v2/content/locations/1/2"
        },
        "pathString": "/1/2/58/",
        "depth": 2,
        "childCount": 3,
        "remoteId": "0cfe62f27753448d79aaa8acd8d01699",
        "Children": {
            "_media-type": "application/vnd.ibexa.api.LocationList+json",
            "_href": "/api/ibexa/v2/content/locations/1/2/58/children"
        },
        "Content": {
            "_media-type": "application/vnd.ibexa.api.Content+json",
            "_href": "/api/ibexa/v2/content/objects/57"
        },
        "sortField": "PATH",
        "sortOrder": "ASC",
        "UrlAliases": {
View more

/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.ibexa.api.Location+xml application/vnd.ibexa.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.
LocationWrapper JSON object with only a Location property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/61">
    <id>61</id>
    <priority>0</priority>
    <hidden>false</hidden>
    <invisible>false</invisible>
    <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"/>
    <pathString>/1/2/61/</pathString>
    <depth>2</depth>
    <childCount>0</childCount>
    <remoteId>2cfa66027e3806b113d994c9c26d3a66</remoteId>
    <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/61/children"/>
    <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/60"/>
    <sortField>NAME</sortField>
    <sortOrder>ASC</sortOrder>
    <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/61/urlaliases"/>
    <ContentInfo media-type="application/vnd.ibexa.api
View more

file_copy 

                                {
    "Location": {
        "_media-type": "application/vnd.ibexa.api.Location+json",
        "_href": "/api/ibexa/v2/content/locations/1/2/58",
        "id": 58,
        "priority": 0,
        "hidden": false,
        "invisible": false,
        "explicitlyHidden": false,
        "ParentLocation": {
            "_media-type": "application/vnd.ibexa.api.Location+json",
            "_href": "/api/ibexa/v2/content/locations/1/2"
        },
        "pathString": "/1/2/58/",
        "depth": 2,
        "childCount": 3,
        "remoteId": "0cfe62f27753448d79aaa8acd8d01699",
        "Children": {
            "_media-type": "application/vnd.ibexa.api.LocationList+json",
            "_href": "/api/ibexa/v2/content/locations/1/2/58/children"
        },
        "Content": {
            "_media-type": "application/vnd.ibexa.api.Content+json",
            "_href": "/api/ibexa/v2/content/objects/57"
        },
        "sortField": "PATH",
        "sortOrder": "ASC",
        "UrlAliases": {
View more
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/ibexa/v2/content/locations/1/63'.

Property Value
Type string
Possible responses
Code Description
201

Created. If destination is '/api/ibexa/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/ibexa/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/ibexa/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.
Update Location

PATCH /content/locations/{path}

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.ibexa.api.Location+xml application/vnd.ibexa.api.Location+json

Content-Type

The LocationUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.LocationUpdate+xml application/vnd.ibexa.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
LocationUpdate This class is used for updating Location meta data.
LocationUpdateWrapper JSON object with only a LocationUpdate property.
Location This class represents a Location in the Repository.
LocationWrapper JSON object with only a Location property.

file_copy 

                                <?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>
View more

file_copy 

                                {
    "LocationUpdate": {
        "priority": "3",
        "hidden": true,
        "remoteId": "remoteId-qwert999",
        "sortField": "NAME",
        "sortOrder": "DESC"
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/58">
    <id>58</id>
    <priority>0</priority>
    <hidden>false</hidden>
    <invisible>false</invisible>
    <explicitlyHidden>false</explicitlyHidden>
    <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"/>
    <pathString>/1/2/58/</pathString>
    <depth>2</depth>
    <childCount>3</childCount>
    <remoteId>0cfe62f27753448d79aaa8acd8d01699</remoteId>
    <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/58/children"/>
    <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/>
    <sortField>PATH</sortField>
    <sortOrder>ASC</sortOrder>
    <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/58/urlaliases"/>
    <Co
View more

file_copy 

                                {
    "Location": {
        "_media-type": "application/vnd.ibexa.api.Location+json",
        "_href": "/api/ibexa/v2/content/locations/1/2/59",
        "id": 59,
        "priority": 3,
        "hidden": true,
        "invisible": true,
        "explicitlyHidden": true,
        "ParentLocation": {
            "_media-type": "application/vnd.ibexa.api.Location+json",
            "_href": "/api/ibexa/v2/content/locations/1/2"
        },
        "pathString": "/1/2/59/",
        "depth": 2,
        "childCount": 5,
        "remoteId": "remoteId-qwert999",
        "Children": {
            "_media-type": "application/vnd.ibexa.api.LocationList+json",
            "_href": "/api/ibexa/v2/content/locations/1/2/59/children"
        },
        "Content": {
            "_media-type": "application/vnd.ibexa.api.Content+json",
            "_href": "/api/ibexa/v2/content/objects/58"
        },
        "sortField": "NAME",
        "sortOrder": "DESC",
        "UrlAliases": {
            "_media-type
View more
Swap Location

SWAP /content/locations/{path}

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/ibexa/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/locations/{path}/children

Get child Locations.

GET /content/locations/{path}/children

Loads all child Locations for the given parent Location.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.LocationList+xml application/vnd.ibexa.api.LocationList+json
Query parameters
Property Type Value
offset integer

The offset of the result set.
limit integer

The number of Locations returned.
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.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/63/children">
    <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/60"/>
    <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/61"/>
    <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/62"/>
    <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/67"/>
</LocationList>
View more

/content/locations/{path}/urlaliases

List URL aliases for Location

GET /content/locations/{path}/urlaliases

Returns the list of URL aliases for a Location.

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.ibexa.api.UrlAliasRefList+xml application/vnd.ibexa.api.UrlAliasRefList+json
Query parameters
Property Type Value
custom boolean

Indicates whether autogenerated (false) or manual URL aliases (true) should be returned (default true).
Possible responses
Code Description
200

OK - returns the list of URL aliases.
400

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

Error - The Location was not found.
Types
Type Description
UrlAliasRefList List of URL alias in the Repository.
UrlAliasRefListWrapper JSON object with only a UrlAliasRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UrlAliasRefList media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/59/urlaliases">
    <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-deca3dadca45c3dff7861274b8e67ed7"/>
    <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-e1511fd04f57162341c2950fa1375867"/>
</UrlAliasRefList>
View more

/content/views

/content/views

Create View (deprecated)

POST /content/views

Executes a query and returns View including the results. The View input reflects the criteria model of the public PHP API. Deprecated as of eZ Platform 1.0 and will respond 301, use POST /views instead.

Header parameters

Accept

The View in XML or JSON format.

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

Content-Type

The View input in XML or JSON format.

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

Moved permanently.
400

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

/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.ibexa.api.Section+xml application/vnd.ibexa.api.Section+json

Content-Type

The Section input schema encoded in XML or JSON format.

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

Types
Type Description
SectionInput
SectionInputWrapper JSON object with only a SectionInput property.
Section This class represents a Section.
SectionWrapper JSON object with only a Section property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SectionInput>
  <identifier>restricted</identifier>
  <name>Restricted</name>
</SectionInput>
View more

file_copy 

                                {
    "SectionInput": {
        "identifier": "restricted",
        "name": "Restricted"
    }
}
View more
Code: 201

file_copy 

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

file_copy 

                                {
    "Section": {
        "_media-type": "application/vnd.ibexa.api.Section+json",
        "_href": "/api/ibexa/v2/content/sections/13",
        "sectionId": 13,
        "identifier": "restricted",
        "name": "Restricted"
    }
}
View more
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.ibexa.api.SectionList+xml application/vnd.ibexa.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.
SectionListWrapper JSON object with only a SectionList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SectionList media-type="application/vnd.ibexa.api.SectionList+xml" href="/api/ibexa/v2/content/sections">
    <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1">
        <sectionId>1</sectionId>
        <identifier>standard</identifier>
        <name>Standard</name>
    </Section>
    <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2">
        <sectionId>2</sectionId>
        <identifier>users</identifier>
        <name>Users</name>
    </Section>
    <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/3">
        <sectionId>3</sectionId>
        <identifier>media</identifier>
        <name>Media</name>
    </Section>
    <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/6">
        <sectionId>6</sectionId>
        <identifier>form</identifier>
        <name>F
View more

file_copy 

                                {
    "SectionList": {
        "_media-type": "application/vnd.ibexa.api.SectionList+json",
        "_href": "/api/ibexa/v2/content/sections",
        "Section": [
            {
                "_media-type": "application/vnd.ibexa.api.Section+json",
                "_href": "/api/ibexa/v2/content/sections/1",
                "sectionId": 1,
                "identifier": "standard",
                "name": "Standard"
            },
            {
                "_media-type": "application/vnd.ibexa.api.Section+json",
                "_href": "/api/ibexa/v2/content/sections/2",
                "sectionId": 2,
                "identifier": "users",
                "name": "Users"
            },
            {
                "_media-type": "application/vnd.ibexa.api.Section+json",
                "_href": "/api/ibexa/v2/content/sections/3",
                "sectionId": 3,
                "identifier": "media",
                "name": "Media"
            },
            {
                "_
View more

/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.ibexa.api.Section+xml application/vnd.ibexa.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.
SectionWrapper JSON object with only a Section property.
Code: 200

file_copy 

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

file_copy 

                                {
    "Section": {
        "_media-type": "application/vnd.ibexa.api.Section+json",
        "_href": "/api/ibexa/v2/content/sections/10",
        "sectionId": 10,
        "identifier": "design",
        "name": "Design"
    }
}
View more
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.ibexa.api.Section+xml application/vnd.ibexa.api.Section+json

Content-Type

The Section input schema encoded in XML or JSON.

Property Value
Type string
Examples application/vnd.ibexa.api.SectionInput+xml application/vnd.ibexa.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
SectionInputWrapper JSON object with only a SectionInput property.
Section This class represents a Section.
SectionWrapper JSON object with only a Section property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SectionInput>
  <identifier>template</identifier>
  <name>Template</name>
</SectionInput>
View more

file_copy 

                                {
  "SectionInput": {
    "identifier": "template",
    "name": "Template"
  }
}
View more
Code: 200

file_copy 

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

file_copy 

                                {
    "Section": {
        "_media-type": "application/vnd.ibexa.api.Section+json",
        "_href": "/api/ibexa/v2/content/sections/7",
        "sectionId": 7,
        "identifier": "template",
        "name": "Template"
    }
}
View more
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.ibexa.api.Trash+xml application/vnd.ibexa.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
TrashWrapper JSON object with only a Trash property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Trash media-type="application/vnd.ibexa.api.Trash+xml" href="/api/ibexa/v2/content/trash">
    <TrashItem media-type="application/vnd.ibexa.api.TrashItem+xml" href="/api/ibexa/v2/content/trash/58">
        <id>58</id>
        <priority>0</priority>
        <hidden>false</hidden>
        <invisible>false</invisible>
        <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/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.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/52"/>
        <sortField>PATH</sortField>
        <sortOrder>ASC</sortOrder>
        <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/52">
            <Content media-type="application/vnd.ibexa
View more

file_copy 

                                {
    "Trash": {
        "_media-type": "application/vnd.ibexa.api.Trash+json",
        "_href": "/api/ibexa/v2/content/trash",
        "TrashItem": [
            {
                "_media-type": "application/vnd.ibexa.api.TrashItem+json",
                "_href": "/api/ibexa/v2/content/trash/87",
                "id": 87,
                "priority": 0,
                "hidden": false,
                "invisible": false,
                "ParentLocation": {
                    "_media-type": "application/vnd.ibexa.api.Location+json",
                    "_href": "/api/ibexa/v2/content/locations/1/2/57"
                },
                "pathString": "/1/2/57/87/",
                "depth": 3,
                "childCount": 0,
                "remoteId": "7cc6565354858f39a794bf64aa2c2761",
                "Content": {
                    "_media-type": "application/vnd.ibexa.api.Content+json",
                    "_href": "/api/ibexa/v2/content/objects/91"
                },
View more
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.ibexa.api.TrashItem+xml application/vnd.ibexa.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.
TrashItemWrapper JSON object with only a TrashItem property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<TrashItem media-type="application/vnd.ibexa.api.TrashItem+xml" href="/api/ibexa/v2/content/trash/81">
    <id>81</id>
    <priority>0</priority>
    <hidden>false</hidden>
    <invisible>false</invisible>
    <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/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.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/99"/>
    <sortField>PATH</sortField>
    <sortOrder>ASC</sortOrder>
    <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/99">
        <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/99" remoteId="ae2b4568c0d2e7a4a9bca9495e73591a" id="99">
            <ContentType media-type="
View more

file_copy 

                                {
    "TrashItem": {
        "_media-type": "application/vnd.ibexa.api.TrashItem+json",
        "_href": "/api/ibexa/v2/content/trash/87",
        "id": 87,
        "priority": 0,
        "hidden": false,
        "invisible": false,
        "ParentLocation": {
            "_media-type": "application/vnd.ibexa.api.Location+json",
            "_href": "/api/ibexa/v2/content/locations/1/2/57"
        },
        "pathString": "/1/2/57/87/",
        "depth": 3,
        "childCount": 0,
        "remoteId": "7cc6565354858f39a794bf64aa2c2761",
        "Content": {
            "_media-type": "application/vnd.ibexa.api.Content+json",
            "_href": "/api/ibexa/v2/content/objects/91"
        },
        "sortField": "PATH",
        "sortOrder": "ASC",
        "ContentInfo": {
            "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
            "_href": "/api/ibexa/v2/content/objects/91",
            "Content": {
                "_media-type": "application/vnd.ibexa.api.Conten
View more
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.ibexa.api.UrlAliasRefList+xml application/vnd.ibexa.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.
UrlAliasRefListWrapper JSON object with only a UrlAliasRefList property.
Code: 200

file_copy 

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

file_copy 

                                {
    "UrlAliasRefList": {
        "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json",
        "_href": "/api/ibexa/v2/content/urlaliases",
        "UrlAlias": [
            {
                "_media-type": "application/vnd.ibexa.api.UrlAlias+json",
                "_href": "/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36"
            }
        ]
    }
}
View more
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.ibexa.api.UrlAlias+xml application/vnd.ibexa.api.UrlAlias+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.UrlAliasCreate+xml application/vnd.ibexa.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
UrlAliasCreateWrapper JSON object with only a UrlAliasCreate property.
UrlAlias This class represents a URL alias in the Repository.
UrlAliasWrapper JSON object with only a UrlAlias property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UrlAliasCreate type="LOCATION">
  <location href='/api/ibexa/v2/content/locations/1/2/59' />
  <path>example-global</path>
  <languageCode>eng-GB</languageCode>
  <alwaysAvailable>true</alwaysAvailable>
  <forward>true</forward>
</UrlAliasCreate>
View more

file_copy 

                                {
  "UrlAliasCreate": {
    "_type": "GLOBAL",
    "resource": "module:content/view/full",
    "path": "example-global",
    "languageCode": "eng-GB",
    "alwaysAvailable": "true",
    "forward": "true"
  }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-deca3dadca45c3dff7861274b8e67ed7" id="0-deca3dadca45c3dff7861274b8e67ed7" type="LOCATION">
    <location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/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>
View more

file_copy 

                                {
    "UrlAlias": {
        "_media-type": "application/vnd.ibexa.api.UrlAlias+json",
        "_href": "/api/ibexa/v2/content/urlaliases/0-f530173ad554787c1fe30dc929d98360",
        "_id": "0-f530173ad554787c1fe30dc929d98360",
        "_type": "RESOURCE",
        "resource": "content/view/full",
        "path": "/example-global",
        "languageCodes": "eng-GB",
        "alwaysAvailable": true,
        "isHistory": false,
        "forward": true,
        "custom": true
    }
}
View more

/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.ibexa.api.UrlAlias+xml application/vnd.ibexa.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.
UrlAliasWrapper JSON object with only a UrlAlias property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/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>
View more

file_copy 

                                {
    "UrlAlias": {
        "_media-type": "application/vnd.ibexa.api.UrlAlias+json",
        "_href": "/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36",
        "_id": "0-2cecdff5f90b8595d76b68c417b09f36",
        "_type": "RESOURCE",
        "resource": "content/view/full",
        "path": "/example-global",
        "languageCodes": "eng-GB",
        "alwaysAvailable": true,
        "isHistory": false,
        "forward": true,
        "custom": true
    }
}
View more
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.ibexa.api.UrlWildcardList+xml application/vnd.ibexa.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.
UrlWildcardListWrapper JSON object with only a UrlWildcardList property.
Code: 200

file_copy 

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

file_copy 

                                {
    "UrlWildcardList": {
        "_media-type": "application/vnd.ibexa.api.UrlWildcardList+json",
        "_href": "/api/ibexa/v2/content/urlwildcards",
        "UrlWildcard": [
            {
                "_media-type": "application/vnd.ibexa.api.UrlWildcard+json",
                "_href": "/api/ibexa/v2/content/urlwildcards/1",
                "_id": 1,
                "sourceUrl": "/api/ibexa/v2/content/location/2",
                "destinationUrl": "/api/ibexa/v2/content/location/59",
                "forward": true
            }
        ]
    }
}
View more
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.ibexa.api.UrlWildcard+xml application/vnd.ibexa.api.UrlWildcard+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.UrlWildcardCreate+xml application/vnd.ibexa.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 Creates a new URL wildcard.
UrlWildcardCreateWrapper JSON object with only a URLWildcardCreate property.
UrlWildcard This class represents a URL alias in the Repository.
UrlWildcardWrapper JSON object with only a UrlWildcard property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
    <UrlWildcardCreate>
    	<sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl>
    	<destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl>
    	<forward>true</forward>
</UrlWildcardCreate>
View more

file_copy 

                                {
    "URLWildcardCreate": {
        "sourceUrl": "/api/ibexa/v2/content/location/2",
        "destinationUrl": "/api/ibexa/v2/content/location/59",
        "forward": true
    }
}
View more
Code: 201

file_copy 

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

file_copy 

                                {
    "UrlWildcard": {
        "_media-type": "application/vnd.ibexa.api.UrlWildcard+json",
        "_href": "/api/ibexa/v2/content/urlwildcards/6",
        "_id": 6,
        "sourceUrl": "/api/ibexa/v2/content/location/2",
        "destinationUrl": "/api/ibexa/v2/content/location/59",
        "forward": true
    }
}
View more

/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.ibexa.api.UrlWildcard+xml application/vnd.ibexa.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.
UrlWildcardWrapper JSON object with only a UrlWildcard property.
Code: 200

file_copy 

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

file_copy 

                                {
    "UrlWildcard": {
        "_media-type": "application/vnd.ibexa.api.UrlWildcard+json",
        "_href": "/api/ibexa/v2/content/urlwildcards/4",
        "_id": 4,
        "sourceUrl": "/api/ibexa/v2/content/location/2",
        "destinationUrl": "/api/ibexa/v2/content/location/59",
        "forward": true
    }
}
View more
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.ibexa.api.ContentTypeGroupList+xml application/vnd.ibexa.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.
ContentTypeGroupListWrapper JSON object with only a ContentTypeGroupList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroupList media-type="application/vnd.ibexa.api.ContentTypeGroupList+xml" href="/api/ibexa/v2/content/typegroups">
    <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/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.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
        <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types"/>
    </ContentTypeGroup>
    <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2">
        <id>2</id>
        <identifier>Users</identi
View more

file_copy 

                                {
    "ContentTypeGroupList": {
        "_media-type": "application/vnd.ibexa.api.ContentTypeGroupList+json",
        "_href": "/api/ibexa/v2/content/typegroups",
        "ContentTypeGroup": [
            {
                "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json",
                "_href": "/api/ibexa/v2/content/typegroups/1",
                "id": 1,
                "identifier": "Content",
                "created": "2002-09-05T09:08:48+00:00",
                "modified": "2002-10-06T16:35:06+00:00",
                "Creator": {
                    "_media-type": "application/vnd.ibexa.api.User+json",
                    "_href": "/api/ibexa/v2/user/users/14"
                },
                "Modifier": {
                    "_media-type": "application/vnd.ibexa.api.User+json",
                    "_href": "/api/ibexa/v2/user/users/14"
                },
                "ContentTypes": {
                    "_media-type": "application/vnd.ibexa.api.ContentTyp
View more
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.ibexa.api.ContentTypeGroup+xml application/vnd.ibexa.api.ContentTypeGroup+json

Content-Type

The content type group input schema encoded in XML or JSON.

Property Value
Type string
Examples application/vnd.ibexa.api.ContentTypeGroupInput+xml application/vnd.ibexa.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
ContentTypeGroupInputWrapper JSON object with only a ContentTypeGroupInput property.
ContentTypeGroup This class represents a content type group value.
ContentTypeGroupWrapper JSON object with only a ContentTypeGroup property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroupInput>
    <identifier>newContentTypeGroup</identifier>
</ContentTypeGroupInput>
View more

file_copy 

                                {
  "ContentTypeGroupInput": {
    "identifier": "newContentTypeGroup"
  }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroup href="/content/typesgroups/7" media-type="application/vnd.ibexa.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.ibexa.api.User+xml"/>
    <Modifier href="/user/users/13" media-type="application/vnd.ibexa.api.User+xml"/>
    <ContentTypes href="/content/typegroups/7/types" media-type="application/vnd.ibexa.api.ContentTypeList+xml"/>
</ContentTypeGroup>
View more

file_copy 

                                {
    "ContentTypeGroup": {
        "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json",
        "_href": "/api/ibexa/v2/content/typegroups/6",
        "id": 6,
        "identifier": "newContentTypeGroup",
        "created": "2021-08-11T09:44:18+00:00",
        "modified": "2021-08-11T09:44:18+00:00",
        "Creator": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "Modifier": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "ContentTypes": {
            "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json",
            "_href": "/api/ibexa/v2/content/typegroups/6/types"
        }
    }
}
View more

/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.ibexa.api.ContentTypeGroup+xml application/vnd.ibexa.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
ContentTypeList List of content types.
ContentTypeListWrapper JSON object with only a ContentTypeList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types">
 <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2">
  <id>2</id>
  <status>DEFINED</status>
  <identifier>article</identifier>
  <names>
   <value languageCode="eng-GB">Article</value>
  </names>
  <descriptions>
   <value languageCode="eng-GB"></value>
  </descriptions>
  <creationDate>2002-06-18T09:21:38+00:00</creationDate>
  <modificationDate>2021-06-28T11:31:22+00:00</modificationDate>
  <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
  <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
  <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/>
  <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/
View more

file_copy 

                                {
    "ContentTypeList": {
        "_media-type": "application/vnd.ibexa.api.ContentTypeList+json",
        "_href": "/api/ibexa/v2/content/typegroups/1/types",
        "ContentType": [
            {
                "_media-type": "application/vnd.ibexa.api.ContentType+json",
                "_href": "/api/ibexa/v2/content/types/2",
                "id": 2,
                "status": "DEFINED",
                "identifier": "article",
                "names": {
                    "value": [
                        {
                            "_languageCode": "eng-GB",
                            "#text": "Article"
                        }
                    ]
                },
                "descriptions": {
                    "value": [
                        {
                            "_languageCode": "eng-GB",
                            "#text": null
                        }
                    ]
                },
                "creationDate": "2002-06-18T09:21:38+0
View more
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.ibexa.api.ContentTypeGroup+xml application/vnd.ibexa.api.ContentTypeGroup+json

Content-Type

The content type group input schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ContentTypeGroupInput+xml application/vnd.ibexa.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
ContentTypeGroupInputWrapper JSON object with only a ContentTypeGroupInput property.
ContentTypeGroup This class represents a content type group value.
ContentTypeGroupWrapper JSON object with only a ContentTypeGroup property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroupInput>
    <identifier>updatedIdentifer</identifier>
</ContentTypeGroupInput>
View more

file_copy 

                                {
  "ContentTypeGroupInput": {
    "identifier": "updatedIdentifer"
  }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/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.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types"/>
</ContentTypeGroup>
View more

file_copy 

                                {
    "ContentTypeGroup": {
        "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json",
        "_href": "/api/ibexa/v2/content/typegroups/4",
        "id": 4,
        "identifier": "updatedIdentifer",
        "created": "2021-08-11T09:44:18+00:00",
        "modified": "2021-08-11T10:10:04+00:00",
        "Creator": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "Modifier": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "ContentTypes": {
            "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json",
            "_href": "/api/ibexa/v2/content/typegroups/6/types"
        }
    }
}
View more
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.ibexa.api.ContentTypeInfoList+xml application/vnd.ibexa.api.ContentTypeInfoList+json application/vnd.ibexa.api.ContentTypeList+xml application/vnd.ibexa.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.
ContentTypeInfoListWrapper JSON object with only a ContentTypeInfoList property.
ContentTypeList List of content types.
ContentTypeListWrapper JSON object with only a ContentTypeList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeInfoList media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types">
    <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/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.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
        <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/>
        <Draft media-type="applicat
View more

file_copy 

                                {
    "ContentTypeList": {
        "_media-type": "application/vnd.ibexa.api.ContentTypeList+json",
        "_href": "/api/ibexa/v2/content/types",
        "ContentType": [
            {
                "_media-type": "application/vnd.ibexa.api.ContentType+json",
                "_href": "/api/ibexa/v2/content/types/2",
                "id": 2,
                "status": "DEFINED",
                "identifier": "article",
                "names": {
                    "value": [
                        {
                            "_languageCode": "eng-GB",
                            "#text": "Article"
                        }
                    ]
                },
                "descriptions": {
                    "value": [
                        {
                            "_languageCode": "eng-GB",
                            "#text": null
                        }
                    ]
                },
                "creationDate": "2002-06-18T09:21:38+00:00",
View more
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.ibexa.api.ContentType+xml application/vnd.ibexa.api.ContentType+json

Content-Type

The content type Create schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ContentTypeCreate+xml application/vnd.ibexa.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
Type Description
ContentTypeCreate This class is used to create a content type.
ContentTypeCreateWrapper JSON object with only a ContentTypeCreate property.
ContentType This class represents a content type.
ContentTypeWrapper JSON object with only a ContentType property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeCreate>
  <identifier>newContentType</identifier>
  <names>
    <value languageCode="eng-US">New content type</value>
  </names>
  <descriptions>
    <value languageCode="eng-US">This is a description</value>
  </descriptions>
  <remoteId>remoteId-qwert548</remoteId>
  <urlAliasSchema>&lt;title&gt;</urlAliasSchema>
  <nameSchema>&lt;title&gt;</nameSchema>
  <isContainer>true</isContainer>
  <mainLanguageCode>eng-US</mainLanguageCode>
  <defaultAlwaysAvailable>true</defaultAlwaysAvailable>
  <defaultSortField>PATH</defaultSortField>
  <defaultSortOrder>ASC</defaultSortOrder>
  <FieldDefinitions>
    <FieldDefinition>
      <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>
      <isS
View more

file_copy 

                                {
  "ContentTypeCreate": {
    "identifier": "new_content_type",
    "names": {
      "value": [
        {
          "_languageCode": "eng-GB",
          "#text": "New content type"
        }
      ]
    },
    "descriptions": {
      "value": [
        {
          "_languageCode": "eng-GB",
          "#text": "This is a description"
        }
      ]
    },
    "remoteId": "remoteId-qwerty548",
    "urlAliasSchema": "<title>",
    "nameSchema": "<title>",
    "isContainer": true,
    "mainLanguageCode": "eng-GB",
    "defaultAlwaysAvailable": true,
    "defaultSortField": "PATH",
    "defaultSortOrder": "ASC",
    "FieldDefinitions": {
      "FieldDefinition": [
        {
          "identifier": "title",
          "fieldType": "ezstring",
          "fieldGroup": "content",
          "position": 1,
          "isTranslatable": true,
          "isRequired": true,
          "isInfoCollector": false,
          "defaultValue": "New Title",
          "isSearchable": true,
          "names":
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/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.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/20/groups"/>
    <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/20/draft"/>
    <re
View more

/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.ibexa.api.ContentTypeInfoList+xml application/vnd.ibexa.api.ContentTypeInfoList+json application/vnd.ibexa.api.ContentTypeList+xml application/vnd.ibexa.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.
ContentTypeInfoListWrapper JSON object with only a ContentTypeInfoList property.
ContentTypeList List of content types.
ContentTypeListWrapper JSON object with only a ContentTypeList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/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-18T09:21:38+00:00</creationDate>
        <modificationDate>2004-04-20T09:56:29+00:00</modificationDate>
        <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
        <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
        <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/>
        <Draft media-type="application/vnd.ibexa.ap
View more

file_copy 

                                {
    "ContentTypeList": {
        "_media-type": "application/vnd.ibexa.api.ContentTypeList+json",
        "_href": "/api/ibexa/v2/content/typegroups/1/types",
        "ContentType": [
            {
                "_media-type": "application/vnd.ibexa.api.ContentType+json",
                "_href": "/api/ibexa/v2/content/types/2",
                "id": 2,
                "status": "DEFINED",
                "identifier": "article",
                "names": {
                    "value": [
                        {
                            "_languageCode": "eng-GB",
                            "#text": "Article"
                        }
                    ]
                },
                "descriptions": {
                    "value": []
                },
                "creationDate": "2002-06-18T09:21:38+00:00",
                "modificationDate": "2004-04-20T09:56:29+00:00",
                "Creator": {
                    "_media-type": "application/vnd.ibexa.api.User+js
View more

/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.ibexa.api.ContentType+xml application/vnd.ibexa.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 This class represents a content type.
ContentTypeWrapper JSON object with only a ContentType property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/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.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/>
    <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/>
    <remoteId>c15b600eb9198b1924063b5a68758232</remoteId>
    <urlAliasSchema></urlAliasSchema>
    <nameSchema>&lt;s
View more

file_copy 

                                {
    "ContentType": {
        "_media-type": "application/vnd.ibexa.api.ContentType+json",
        "_href": "/api/ibexa/v2/content/types/2",
        "id": 2,
        "status": "DEFINED",
        "identifier": "article",
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Article"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": null
                }
            ]
        },
        "creationDate": "2002-06-18T09:21:38+00:00",
        "modificationDate": "2021-06-28T11:31:22+00:00",
        "Creator": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "Modifier": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
View more
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.ibexa.api.ContentTypeInfo+xml application/vnd.ibexa.api.ContentTypeInfo+json

Content-Type

The content type Update schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ContentTypeUpdate+xml application/vnd.ibexa.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 This class is used to update a content type.
ContentTypeUpdateWrapper JSON object with only a ContentTypeUpdate property.
ContentTypeInfo This class stores content type information.
ContentTypeInfoWrapper JSON object with only a ContentTypeInfo property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeUpdate>
    <defaultAlwaysAvailable>true</defaultAlwaysAvailable>
</ContentTypeUpdate>
View more

file_copy 

                                {
  "ContentTypeUpdate": {
    "defaultAlwaysAvailable": "true"
  }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/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.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/3/groups"/>
    <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3/draft"/>
    <remoteId>25b4268cdcd01921b808a0d854b877ef</remoteId>
    <urlAliasSchema></urlAliasSchema>
View more

file_copy 

                                {
    "ContentTypeInfo": {
        "_media-type": "application/vnd.ibexa.api.ContentTypeInfo+json",
        "_href": "/api/ibexa/v2/content/types/1/draft",
        "id": 1,
        "status": "DRAFT",
        "identifier": "folder",
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Folder"
                }
            ]
        },
        "descriptions": {
            "value": []
        },
        "creationDate": "2002-06-18T09:21:38+00:00",
        "modificationDate": "2021-08-11T11:17:58+00:00",
        "Creator": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "Modifier": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "Groups": {
            "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json",
View more
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}/fieldDefinitions

Get Field definition list

GET /content/types/{contentTypeId}/fieldDefinitions

Returns all Field definitions of the provided content type.

Header parameters

Accept

If set, the Field definitions are returned in XML or JSON format.

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

OK - return a list of Field definitions.
404

Error - The content type does not exist.
Types
Type Description
FieldDefinitions
FieldDefinitionsWrapper JSON object with only a FieldDefinitions property.

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

Get Field definition

GET /content/types/{contentTypeId}/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.ibexa.api.FieldDefinition+xml application/vnd.ibexa.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.
FieldDefinitionWrapper JSON object with only a FieldDefinition property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/195">
    <id>195</id>
    <identifier>image</identifier>
    <fieldType>ezimageasset</fieldType>
    <fieldGroup>content</fieldGroup>
    <position>7</position>
    <isTranslatable>false</isTranslatable>
    <isRequired>false</isRequired>
    <isInfoCollector>false</isInfoCollector>
    <defaultValue>
        <value key="destinationContentId"/>
        <value key="alternativeText"/>
        <value key="source"/>
    </defaultValue>
    <isSearchable>false</isSearchable>
    <names>
        <value languageCode="eng-GB">Image</value>
    </names>
    <descriptions>
        <value languageCode="eng-GB"></value>
    </descriptions>
    <fieldSettings/>
    <validatorConfiguration/>
</FieldDefinition>
View more

file_copy 

                                {
    "FieldDefinition": {
        "_media-type": "application/vnd.ibexa.api.FieldDefinition+json",
        "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/195",
        "id": 195,
        "identifier": "image",
        "fieldType": "ezimageasset",
        "fieldGroup": "content",
        "position": 7,
        "isTranslatable": false,
        "isRequired": false,
        "isInfoCollector": false,
        "defaultValue": {
            "destinationContentId": null,
            "alternativeText": null,
            "source": null
        },
        "isSearchable": false,
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Image"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": null
                }
            ]
        },
        "fieldSettings": [],
        "
View more

/content/types/{contentTypeId}/draft

Get content type draft

GET /content/types/{contentTypeId}/draft

Returns the draft of 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.ibexa.api.ContentType+xml application/vnd.ibexa.api.ContentType+json
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 or does not have a draft.
Types
Type Description
ContentType This class represents a content type.
ContentTypeWrapper JSON object with only a ContentType property.
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.ibexa.api.ContentTypeInfo+xml application/vnd.ibexa.api.ContentTypeInfo+json

Content-Type

The content type update schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ContentTypeUpdate+xml application/vnd.ibexa.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 This class is used to update a content type.
ContentTypeUpdateWrapper JSON object with only a ContentTypeUpdate property.
ContentTypeInfo This class stores content type information.
ContentTypeInfoWrapper JSON object with only a ContentTypeInfo property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeUpdate>
    <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>
</ContentTypeUpdate>
View more

file_copy 

                                {
  "ContentTypeUpdate": {
    "names": {
      "value": [
        {
          "_languageCode": "eng-GB",
          "#text": "Updated content type name"
        }
      ]
    },
    "descriptions": {
      "value": [
        {
          "_languageCode": "eng-GB",
          "#text": "This is an updated content type description"
        }
      ]
    }
  }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/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.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/14/groups"/>
    <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/i
View more

file_copy 

                                {
    "ContentTypeInfo": {
        "_media-type": "application/vnd.ibexa.api.ContentTypeInfo+json",
        "_href": "/api/ibexa/v2/content/types/2/draft",
        "id": 2,
        "status": "DRAFT",
        "identifier": "article",
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Updated content type name"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "This is an updated content type description"
                }
            ]
        },
        "creationDate": "2002-06-18T09:21:38+00:00",
        "modificationDate": "2021-08-11T11:58:24+00:00",
        "Creator": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "Modifier": {
            "_media-type": "application/vnd.ibe
View more
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 This class represents a content type.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/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.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/14/groups"/>
    <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/co
View more
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

Get Draft Field definition list

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

Returns all Field definitions of the provided content type Draft.

Header parameters

Accept

If set, the Field definitions are returned in XML or JSON format.

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

OK - return a list of Field definitions.
404

Error - The content type draft does not exist.
Types
Type Description
FieldDefinitions
FieldDefinitionsWrapper JSON object with only a FieldDefinitions property.
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.ibexa.api.FieldDefinition+xml application/vnd.ibexa.api.FieldDefinition+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.FieldDefinitionCreate+xml application/vnd.ibexa.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
FieldDefinitionCreateWrapper JSON object with only a FieldDefinitionCreate property.
FieldDefinition This class represents a Field definition.
FieldDefinitionWrapper JSON object with only a FieldDefinition property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<FieldDefinitionCreate>
    <identifier>name</identifier>
    <fieldType>ezstring</fieldType>
    <isRequired>true</isRequired>
    <validatorConfiguration>
    <value key="StringLengthValidator">
        <value key="maxStringLength">32</value>
        <value key="minStringLength">8</value>
    </value>
</validatorConfiguration>
</FieldDefinitionCreate>
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/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>
View more

/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.ibexa.api.FieldDefinition+xml application/vnd.ibexa.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.
FieldDefinitionWrapper JSON object with only a FieldDefinition property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/195">
    <id>195</id>
    <identifier>image</identifier>
    <fieldType>ezimageasset</fieldType>
    <fieldGroup>content</fieldGroup>
    <position>7</position>
    <isTranslatable>false</isTranslatable>
    <isRequired>false</isRequired>
    <isInfoCollector>false</isInfoCollector>
    <defaultValue>
        <value key="destinationContentId"/>
        <value key="alternativeText"/>
        <value key="source"/>
    </defaultValue>
    <isSearchable>false</isSearchable>
    <names>
        <value languageCode="eng-GB">Image</value>
    </names>
    <descriptions>
        <value languageCode="eng-GB"></value>
    </descriptions>
    <fieldSettings/>
    <validatorConfiguration/>
</FieldDefinition>
View more

file_copy 

                                {
    "FieldDefinition": {
        "_media-type": "application/vnd.ibexa.api.FieldDefinition+json",
        "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/195",
        "id": 195,
        "identifier": "image",
        "fieldType": "ezimageasset",
        "fieldGroup": "content",
        "position": 7,
        "isTranslatable": false,
        "isRequired": false,
        "isInfoCollector": false,
        "defaultValue": {
            "destinationContentId": null,
            "alternativeText": null,
            "source": null
        },
        "isSearchable": false,
        "names": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": "Image"
                }
            ]
        },
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-GB",
                    "#text": null
                }
            ]
        },
        "fieldSettings": [],
        "
View more
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.ibexa.api.FieldDefinition+xml application/vnd.ibexa.api.FieldDefinition+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.FieldDefinitionUpdate+xml application/vnd.ibexa.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
FieldDefinitionUpdateWrapper JSON object with only a FieldDefinitionUpdate property.
FieldDefinition This class represents a Field definition.
FieldDefinitionWrapper JSON object with only a FieldDefinition property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<FieldDefinitionUpdate>
    <fieldGroup>new_field_group</fieldGroup>
    <position>10</position>
</FieldDefinitionUpdate>
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/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>
View more
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.ibexa.api.ContentTypeGroupRefList+xml application/vnd.ibexa.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.
ContentTypeGroupRefListWrapper JSON object with only a ContentTypeGroupRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/2/types">
    <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"/>
</ContentTypeGroupRefList>
View more

file_copy 

                                {
    "ContentTypeGroupRefList": {
        "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json",
        "_href": "/api/ibexa/v2/content/typegroups/2/types",
        "ContentTypeGroupRef": [
            {
                "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json",
                "_href": "/api/ibexa/v2/content/typegroups/1"
            }
        ]
    }
}
View more
Link group to content type

POST /content/types/{contentTypeId}/groups

Links a content type group to the content type and returns the updated group list.

Header parameters

Accept

If set, the updated content type group list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ContentTypeGroupRefList+xml application/vnd.ibexa.api.ContentTypeGroupRefList+json
Query parameters
Property Type Value
group string

The URI of the group to which the content type should be linked to.
Possible responses
Code Description
200

400

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

Error - The user is not authorized to add a group.
403

Error - The content type is already assigned to the group.
Types
Type Description
ContentTypeGroupRefList List of content type groups references.
ContentTypeGroupRefListWrapper JSON object with only a ContentTypeGroupRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/15/types">
    <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1">
        <unlink href="/api/ibexa/v2/content/types/15/groups/1" method="DELETE"/>
    </ContentTypeGroupRef>
    <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/3">
        <unlink href="/api/ibexa/v2/content/types/15/groups/3" method="DELETE"/>
    </ContentTypeGroupRef>
    <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2">
        <unlink href="/api/ibexa/v2/content/types/15/groups/2" method="DELETE"/>
    </ContentTypeGroupRef>
</ContentTypeGroupRefList>
View more

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

Unlink group from content type

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

Removes the given group from the content type and returns the updated group list.

Header parameters

Accept

If set, the updated content type group list is returned in XML or JSON format.

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

401

Error - The user is not authorized to delete this content type.
403

Error - content type cannot be unlinked from the only remaining group.
404

Error - The resource does not exist.
Types
Type Description
ContentTypeGroupRefList List of content type groups references.
ContentTypeGroupRefListWrapper JSON object with only a ContentTypeGroupRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/15/types">
    <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1">
        <unlink href="/api/ibexa/v2/content/types/15/groups/1" method="DELETE"/>
    </ContentTypeGroupRef>
    <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2">
        <unlink href="/api/ibexa/v2/content/types/15/groups/2" method="DELETE"/>
    </ContentTypeGroupRef>
</ContentTypeGroupRefList>
View more

file_copy 

                                {
    "ContentTypeGroupRefList": {
        "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json",
        "_href": "/api/ibexa/v2/content/typegroups/2/types",
        "ContentTypeGroupRef": [
            {
                "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json",
                "_href": "/api/ibexa/v2/content/typegroups/1",
                "unlink": {
                    "_href": "/api/ibexa/v2/content/types/2/groups/1",
                    "_method": "DELETE"
                }
            },
            {
                "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json",
                "_href": "/api/ibexa/v2/content/typegroups/2",
                "unlink": {
                    "_href": "/api/ibexa/v2/content/types/2/groups/2",
                    "_method": "DELETE"
                }
            }
        ]
    }
}
View more

Searching content

/views

Search content

POST /views

Executes a query and returns a View including the results.

View input reflects the criteria model of the public PHP API.

Refer to Search Criteria Reference

Header parameters

Accept

The view in XML or JSON format.

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

Content-Type

The view input in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ViewInput+xml application/vnd.ibexa.api.ViewInput+json application/vnd.ibexa.api.ViewInput+xml; version=1.1 application/vnd.ibexa.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 This class represents a View input.
ViewInputWrapper JSON object with only a ViewInput property.
View View.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ViewInput>
  <identifier>TitleView</identifier>
  <Query>
    <Filter>
      <ContentTypeIdentifierCriterion>image</ContentTypeIdentifierCriterion>
      <SectionIdentifierCriterion>media</SectionIdentifierCriterion>
      <DateMetadataCriterion>
        <Target>modified</Target>
        <Value>1675681020</Value>
        <Operator>gte</Operator>
      </DateMetadataCriterion>
    </Filter>
    <limit>10</limit>
    <offset>0</offset>
    <SortClauses>
      <ContentName>ascending</ContentName>
    </SortClauses>
    <Aggregations>
      <Aggregation>
        <ContentTypeTermAggregation>
          <name>some name</name>
        </ContentTypeTermAggregation>
      </Aggregation>
    </Aggregations>
  </Query>
</ViewInput>
View more

file_copy 

                                {
    "ViewInput": {
        "identifier": "TitleView",
        "Query": {
            "Filter": {
                "ContentTypeIdentifierCriterion": "image",
                "SectionIdentifierCriterion": "media",
                "DateMetadataCriterion": {
                    "Target": "modified",
                    "Value": 1675681020,
                    "Operator": "gte"
                }
            },
            "limit": 10,
            "offset": 0,
            "SortClauses": {
                "ContentName": "ascending"
            },
            "Aggregations": [
                {
                    "ContentTypeTermAggregation": {
                        "name": "some name"
                    }
                }
            ]
        }
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<View href="/views/TitleView" media-type="application/vnd.ibexa.api.View+xml; version=1.1">
  <identifier>TitleView</identifier>
  <User href="/user/users/14" media-type="vnd.ibexa.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.ibexa.api.ViewResult+xml" count="34" time="31" maxScore="1.0">
    <searchHits>
      <searchHit score="1.0" index="installid1234567890">
        <hightlight/>
        <value>
          <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2">
            <id>2</id>
            <prio
View more

Calendar

/calendar/event

Calendar list

GET /calendar/event

Calendar event list.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.EventList+xml application/vnd.ibexa.api.EventList+json
Query parameters
Property Type Value
start datetime

Query start date.
end datetime

Query end date.
types string

The types of events that are displayed.
languages string

Language code. Restricts the output of translatable Fields to the given languages.
count string

Number of parameters that are returned in the list.
cursor string

Starting point of calendar event list. It should be taken from the URL.
Possible responses
Code Description
200

Types
Type Description
EventList List of calendar events.
EventListWrapper JSON object with only a EventList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<EventList media-type="application/vnd.ibexa.api.EventList+xml" currentPage="/api/ibexa/v2/calendar/event?start=1597104000&amp;end=1598745600&amp;count=10">
    <totalCount>5</totalCount>
</EventList>
View more

file_copy 

                                {
    "EventList": {
        "_media-type": "application/vnd.ibexa.api.EventList+json",
        "_currentPage": "/api/ibexa/v2/calendar/event?start=1597104000&end=1598745600&count=10",
        "totalCount": 5,
        "events": []
    }
}
View more

/calendar/event/grouped-by-day

Calendar list grouped by day

GET /calendar/event/grouped-by-day

Calendar event list grouped by day.

Header parameters

Accept

If set, the calendar event list grouped by day is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.EventGroupList+xml application/vnd.ibexa.api.EventGroupList+json
Query parameters
Property Type Value
start integer

Query start date.
end integer

Query end date.
types string

The types of events that are displayed.
languages string

Language code. Restricts the output of event list to the given languages.
count integer

Number of parameters that are returned in the list.
cursor string

Starting point of calendar event list. It should be taken from the URL.
Possible responses
Code Description
200

Types
Type Description
EventGroupList Grouped calendar event list.
EventGroupListWrapper JSON object with only a EventGroupList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<EventGroupList media-type="application/vnd.ibexa.api.EventGroupList+xml">
    <EventGroup media-type="application/vnd.ibexa.api.EventGroup+xml" currentPage="/api/ibexa/v2/calendar/event?start=1597104000&amp;end=1597190400&amp;count=10">
        <DateRange media-type="application/vnd.ibexa.api.DateRange+xml">
            <startDate>1597104000</startDate>
            <endDate>1597190400</endDate>
        </DateRange>
        <totalCount>0</totalCount>
    </EventGroup>
    <EventGroup media-type="application/vnd.ibexa.api.EventGroup+xml" currentPage="/api/ibexa/v2/calendar/event?start=1597190400&amp;end=1597276800&amp;count=10">
        <DateRange media-type="application/vnd.ibexa.api.DateRange+xml">
            <startDate>1597190400</startDate>
            <endDate>1597276800</endDate>
        </DateRange>
        <totalCount>0</totalCount>
    </EventGroup>
    <EventGroup media-type="application/vnd.ibexa.api.EventGroup+xml" currentPage="/api/ib
View more

file_copy 

                                {
    "EventGroupList": {
        "_media-type": "application/vnd.ibexa.api.EventGroupList+json",
        "groups": [
            {
                "_media-type": "application/vnd.ibexa.api.EventGroup+json",
                "_currentPage": "/api/ibexa/v2/calendar/event?start=1597104000&end=1597190400&count=10",
                "DateRange": {
                    "_media-type": "application/vnd.ibexa.api.DateRange+json",
                    "startDate": "1597104000",
                    "endDate": "1597190400"
                },
                "totalCount": 0,
                "events": []
            },
            {
                "_media-type": "application/vnd.ibexa.api.EventGroup+json",
                "_currentPage": "/api/ibexa/v2/calendar/event?start=1597190400&end=1597276800&count=10",
                "DateRange": {
                    "_media-type": "application/vnd.ibexa.api.DateRange+json",
                    "startDate": "1597190400",
                    "endDate": "159727
View more

/calendar/event/{eventType}

Calendar action

POST /calendar/event/{eventType}

A calendar action that e.g. reschedules or unschedules calendar events. The event type should always be copied from an event.

Header parameters

Content-Type

Property Value
Type string
Examples application/vnd.ibexa.api.calendar.future_publication.UnscheduleAction+json application/vnd.ibexa.api.calendar.future_hide.UnscheduleAction+json
Possible responses
Code Description
204

No Content - the action has been unscheduled.
Types
Type Description
UnscheduleActionWrapper JSON object with only a UnscheduleAction property.

file_copy 

                                {
  "UnscheduleAction": {
    "events": [
      "future_publication:2"
    ]
  }
}
View more

Managing users

/user/current

/user/current

Load current User

GET /user/current

Loads the current user.

Header parameters

Accept

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

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

OK - the User with the given ID.
401

Error - the user has no permission to read Users. For example, Anonymous user can't load oneself.
Types
Type Description
UserList This class represents a list of users.
UserListWrapper JSON object with only a UserList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users">
    <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13">
        <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/>
        <name>Jose Vargas</name>
        <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/>
        <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/>
        <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/>
        <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/>
        <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api
View more

file_copy 

                                {
    "UserList": {
        "_media-type": "application/vnd.ibexa.api.UserList+json",
        "_href": "/api/ibexa/v2/user/users",
        "User": [
            {
                "_media-type": "application/vnd.ibexa.api.User+json",
                "_href": "/api/ibexa/v2/user/users/79",
                "_id": 79,
                "_remoteId": "bcf0764b417f05af21852a1f03fb1f13",
                "ContentType": {
                    "_media-type": "application/vnd.ibexa.api.ContentType+json",
                    "_href": "/api/ibexa/v2/content/types/4"
                },
                "name": "Jose Vargas",
                "Versions": {
                    "_media-type": "application/vnd.ibexa.api.VersionList+json",
                    "_href": "/api/ibexa/v2/content/objects/79/versions"
                },
                "Section": {
                    "_media-type": "application/vnd.ibexa.api.Section+json",
                    "_href": "/api/ibexa/v2/content/sections/2"
View more

/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.ibexa.api.UserGroupList+xml application/vnd.ibexa.api.UserGroupList+json application/vnd.ibexa.api.UserGroupRefList+xml application/vnd.ibexa.api.UserGroupRefList+json
Query parameters
Property Type Value
roleId string

Lists User Groups assigned to the given Role (e.g. GET /user/groups?roleId=1).
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 This class represents a User Group list.
UserGroupListWrapper JSON object with only a UserGroupList property.
UserGroupRefList Returns a list of the sub groups.
UserGroupRefListWrapper JSON object with only a UserGroupRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroupList media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups">
    <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13/15" id="14" remoteId="1bb4fe25487f05527efa8bfd394cecc7">
        <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/>
        <name>Administrator User</name>
        <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/14/versions"/>
        <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/>
        <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/13/15"/>
        <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/14/locations"/>
        <Owner media-type="application/vnd.ibexa.a
View more

file_copy 

                                {
    "UserGroupList": {
        "_media-type": "application/vnd.ibexa.api.UserGroupList+json",
        "_href": "/api/ibexa/v2/user/groups",
        "UserGroup": [
            {
                "_media-type": "application/vnd.ibexa.api.UserGroup+json",
                "_href": "/api/ibexa/v2/user/groups/1/5/13/15",
                "_id": 14,
                "_remoteId": "1bb4fe25487f05527efa8bfd394cecc7",
                "ContentType": {
                    "_media-type": "application/vnd.ibexa.api.ContentType+json",
                    "_href": "/api/ibexa/v2/content/types/4"
                },
                "name": "Administrator User",
                "Versions": {
                    "_media-type": "application/vnd.ibexa.api.VersionList+json",
                    "_href": "/api/ibexa/v2/content/objects/14/versions"
                },
                "Section": {
                    "_media-type": "application/vnd.ibexa.api.Section+json",
                    "_href": "/api/ibexa/
View more

/user/groups/root

Get root User Group

GET /user/groups/root

Redirects to the root User Group.

Possible responses
Code Description
301

Moved permanently.

/user/groups/subgroups

Create a top level User Group

POST /user/groups/subgroups

Creates a top level User Group under the root. To create a child group under a parent group use '/user/groups/{path}/subgroups'.

Header parameters

Accept

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

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

Content-Type

The UserGroupCreate schema encoded in XML or JSON format.

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

Created - the User Group has been created
400

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

Error - the user is not authorized to create this User Group.
Types
Type Description
UserGroupCreate This class is used to create a User Group.
UserGroupCreateWrapper JSON object with only a UserGroupCreate property.
UserGroup Content ID matcher class.
UserGroupWrapper JSON object with only a UserGroup property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroupCreate>
  <mainLanguageCode>eng-GB</mainLanguageCode>
  <remoteId>remoteId-qwert098</remoteId>
  <fields>
    <field>
      <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>
      <languageCode>eng-GB</languageCode>
      <fieldValue>UserGroup</fieldValue>
    </field>
    <field>
      <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier>
      <languageCode>eng-GB</languageCode>
      <fieldValue>This is the description of the user group</fieldValue>
    </field>
  </fields>
</UserGroupCreate>
View more

file_copy 

                                {
  "UserGroupCreate": {
    "mainLanguageCode": "eng-GB",
    "remoteId": "remoteId-qwert098",
    "fields": {
      "field": [
        {
          "fieldDefinitionIdentifier": "name",
          "languageCode": "eng-GB",
          "fieldValue": "UserGroup2"
        },
        {
          "fieldDefinitionIdentifier": "description",
          "languageCode": "eng-GB",
          "fieldValue": "This is the description of the user group"
        }
      ]
    }
  }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/>
    <name>UserGroup2</name>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/>
    <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/>
    <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/>
    <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/>
    <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <publishDate>2021-08-09T09:03:35+00:00</publishDate>
    <lastModificationDate>2021-08-09T09:03:35+00:00</lastMod
View more

file_copy 

                                {
    "UserGroup": {
        "_media-type": "application/vnd.ibexa.api.UserGroup+json",
        "_href": "/api/ibexa/v2/user/groups/1/5/81",
        "_id": 87,
        "_remoteId": "remoteId-qwert098",
        "ContentType": {
            "_media-type": "application/vnd.ibexa.api.ContentType+json",
            "_href": "/api/ibexa/v2/content/types/3"
        },
        "name": "UserGroup2",
        "Versions": {
            "_media-type": "application/vnd.ibexa.api.VersionList+json",
            "_href": "/api/ibexa/v2/content/objects/87/versions"
        },
        "Section": {
            "_media-type": "application/vnd.ibexa.api.Section+json",
            "_href": "/api/ibexa/v2/content/sections/2"
        },
        "MainLocation": {
            "_media-type": "application/vnd.ibexa.api.Location+json",
            "_href": "/api/ibexa/v2/content/locations/1/5/81"
        },
        "Locations": {
            "_media-type": "application/vnd.ibexa.api.LocationList+json",
View more

/user/groups/{path}

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.ibexa.api.UserGroup+xml application/vnd.ibexa.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 Content ID matcher class.
UserGroupWrapper JSON object with only a UserGroup property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13" id="12" remoteId="9b47a45624b023b1a76c73b74d704acf">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/>
    <name>Administrator users</name>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/12/versions"/>
    <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/>
    <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/13"/>
    <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/12/locations"/>
    <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <publishDate>2002-10-06T16:12:55+00:00</publishDate>
    <lastModificationDate>2002-10-06
View more

file_copy 

                                {
    "UserGroup": {
        "_media-type": "application/vnd.ibexa.api.UserGroup+json",
        "_href": "/api/ibexa/v2/user/groups/1/5/13",
        "_id": 12,
        "_remoteId": "9b47a45624b023b1a76c73b74d704acf",
        "ContentType": {
            "_media-type": "application/vnd.ibexa.api.ContentType+json",
            "_href": "/api/ibexa/v2/content/types/3"
        },
        "name": "Administrator users",
        "Versions": {
            "_media-type": "application/vnd.ibexa.api.VersionList+json",
            "_href": "/api/ibexa/v2/content/objects/12/versions"
        },
        "Section": {
            "_media-type": "application/vnd.ibexa.api.Section+json",
            "_href": "/api/ibexa/v2/content/sections/2"
        },
        "MainLocation": {
            "_media-type": "application/vnd.ibexa.api.Location+json",
            "_href": "/api/ibexa/v2/content/locations/1/5/13"
        },
        "Locations": {
            "_media-type": "application/vnd.ibexa.api.Location
View more
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.ibexa.api.UserGroup+xml application/vnd.ibexa.api.UserGroup+json

Content-Type

The UserGroupUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.UserGroupUpdate+json application/vnd.ibexa.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 This class is used to update a User group in the Repository.
UserGroupUpdateWrapper JSON object with only a UserGroupUpdate property.
UserGroup Content ID matcher class.
UserGroupWrapper JSON object with only a UserGroup property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroupUpdate>
	<Section href="/api/ibexa/v2/content/sections/2" />
</UserGroupUpdate>
View more

file_copy 

                                {
    "UserGroupUpdate":{
        "Section": {
            "_href": "/api/ibexa/v2/content/sections/2"
        }
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13" id="12" remoteId="9b47a45624b023b1a76c73b74d704acf">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/>
    <name>Administrator users</name>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/12/versions"/>
    <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/>
    <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/13"/>
    <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/12/locations"/>
    <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <publishDate>2002-10-06T16:12:55+00:00</publishDate>
    <lastModificationDate>2002-10-06
View more

file_copy 

                                {
    "UserGroup": {
        "_media-type": "application/vnd.ibexa.api.UserGroup+json",
        "_href": "/api/ibexa/v2/user/groups/1/5/13",
        "_id": 12,
        "_remoteId": "9b47a45624b023b1a76c73b74d704acf",
        "ContentType": {
            "_media-type": "application/vnd.ibexa.api.ContentType+json",
            "_href": "/api/ibexa/v2/content/types/3"
        },
        "name": "Administrator users",
        "Versions": {
            "_media-type": "application/vnd.ibexa.api.VersionList+json",
            "_href": "/api/ibexa/v2/content/objects/12/versions"
        },
        "Section": {
            "_media-type": "application/vnd.ibexa.api.Section+json",
            "_href": "/api/ibexa/v2/content/sections/2"
        },
        "MainLocation": {
            "_media-type": "application/vnd.ibexa.api.Location+json",
            "_href": "/api/ibexa/v2/content/locations/1/5/13"
        },
        "Locations": {
            "_media-type": "application/vnd.ibexa.api.Location
View more
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

Load Users of Group

GET /user/groups/{path}/users

Loads the Users of the Group with the given ID.

Header parameters

Accept

UserList - If set, the User list returned in XML or JSON format. UserRefList - If set, the link list of Users returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.UserList+xml application/vnd.ibexa.api.UserList+json application/vnd.ibexa.api.UserRefList+xml application/vnd.ibexa.api.UserRefList+json
Query parameters
Property Type Value
limit string

Only 'limit' items will be returned started by offset.
offset string

Offset of the result set.
Possible responses
Code Description
200

OK - the Users of the Group with the given ID.
401

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

Error - the User Group does not exist.
Types
Type Description
UserList This class represents a list of users.
UserRefList Returns a list of the users.
UserRefListWrapper JSON object with only a UserRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserRefList media-type="application/vnd.ibexa.api.UserRefList+xml" href="/api/ibexa/v2/user/groups/13/users">
    <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/113"/>
    <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
</UserRefList>
View more

file_copy 

                                {
    "UserRefList": {
        "_media-type": "application/vnd.ibexa.api.UserRefList+json",
        "_href": "/api/ibexa/v2/user/groups/13/users",
        "User": [
            {
                "_media-type": "application/vnd.ibexa.api.User+json",
                "_href": "/api/ibexa/v2/user/users/113"
            },
            {
                "_media-type": "application/vnd.ibexa.api.User+json",
                "_href": "/api/ibexa/v2/user/users/14"
            }
        ]
    }
}
View more
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.ibexa.api.User+xml application/vnd.ibexa.api.User+json

Content-Type

The UserCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.UserCreate+json application/vnd.ibexa.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 This class is used to create a User.
UserCreateWrapper JSON object with only a UserCreate property.
User This class represents a User value.
UserWrapper JSON object with only a User property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserCreate>
  <mainLanguageCode>eng-GB</mainLanguageCode>
  <remoteId>remoteId-23456789</remoteId>
  <login>johnsmith</login>
  <email>[email protected]</email>
  <password>Secrepassword5!</password>
    <fields>
      <field>
        <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>
        <languageCode>eng-GB</languageCode>
        <fieldValue>John</fieldValue>
      </field>
      <field>
        <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>
        <languageCode>eng-GB</languageCode>
        <fieldValue>Smith</fieldValue>
      </field>
      <field>
        <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier>
        <languageCode>eng-GB</languageCode>
        <fieldValue>
          <value key="hasStoredLogin">true</value>
          <value key="contentId">14</value>
          <value key="login">johnsmith</value>
          <value key="email">[email protected]</value>
          <value key=
View more

file_copy 

                                {
  "UserCreate": {
    "mainLanguageCode": "eng-GB",
    "remoteId": "remoteId-23456789",
    "login": "johnsmith2",
    "email": "[email protected]",
    "password": "Secrepassword5!",
    "fields": {
      "field": [
        {
          "fieldDefinitionIdentifier": "first_name",
          "languageCode": "eng-GB",
          "fieldValue": "John"
        },
        {
          "fieldDefinitionIdentifier": "last_name",
          "languageCode": "eng-GB",
          "fieldValue": "Smith"
        },
        {
          "fieldDefinitionIdentifier": "user_account",
          "languageCode": "eng-GB",
          "fieldValue": {
            "hasStoredLogin": true,
            "contentId": 14,
            "login": "johnsmith",
            "email": "[email protected]",
            "enabled": true,
            "maxLogin": 10
			}
        }
      ]
    }
  }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/59" id="59" remoteId="remoteId-qwert426">
<ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/>
<name>Yura Rajzer</name>
<Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/59/versions"/>
<Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/>
<MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/65/67"/>
<Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/59/locations"/>
<Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/59/groups"/>
<Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
<publishDate>2019-02-27T11:23:42+01:00</publ
View more

file_copy 

                                {
    "User": {
        "_media-type": "application/vnd.ibexa.api.User+json",
        "_href": "/api/ibexa/v2/user/users/57",
        "_id": 57,
        "_remoteId": "remoteId-qwert426",
        "ContentType": {
            "_media-type": "application/vnd.ibexa.api.ContentType+json",
            "_href": "/api/ibexa/v2/content/types/4"
        },
        "name": "Yura Rajzer",
        "Versions": {
            "_media-type": "application/vnd.ibexa.api.VersionList+json",
            "_href": "/api/ibexa/v2/content/objects/57/versions"
        },
        "Section": {
            "_media-type": "application/vnd.ibexa.api.Section+json",
            "_href": "/api/ibexa/v2/content/sections/2"
        },
        "MainLocation": {
            "_media-type": "application/vnd.ibexa.api.Location+json",
            "_href": "/api/ibexa/v2/content/locations/1/5/13/58"
        },
        "Locations": {
            "_media-type": "application/vnd.ibexa.api.LocationList+json",
            "_href": "/
View more

/user/groups/{path}/subgroups

Load subgroups

GET /user/groups/{path}/subgroups

Returns a list of the subgroups.

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 Groups is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.UserGroupList+xml application/vnd.ibexa.api.UserGroupList+json application/vnd.ibexa.api.UserGroupRefList+xml application/vnd.ibexa.api.UserGroupRefList+json
Query parameters
Property Type Value
limit string

The number of Locations returned.
offset string

The offset of the result set.
Possible responses
Code Description
200

OK - list of the subgroups.
401

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

Error - the User Group does not exist.
Types
Type Description
UserGroupList This class represents a User Group list.
UserGroupListWrapper JSON object with only a UserGroupList property.
UserGroupRefList Returns a list of the sub groups.
UserGroupRefListWrapper JSON object with only a UserGroupRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/groups/13/subgroups">
    <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13/112"/>
</UserGroupRefList>
View more

file_copy 

                                {
    "UserGroupRefList": {
        "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json",
        "_href": "/api/ibexa/v2/user/groups/13/subgroups",
        "UserGroup": [
            {
                "_media-type": "application/vnd.ibexa.api.UserGroup+json",
                "_href": "/api/ibexa/v2/user/groups/1/5/13/112"
            }
        ]
    }
}
View more
Create User Group

POST /user/groups/{path}/subgroups

Creates a new User Group under the given parent. To create a top level group use '/user/groups/subgroups'.

Header parameters

Accept

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

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

Content-Type

The UserGroupCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.UserGroupCreate+json application/vnd.ibexa.api.UserGroupCreate+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 Group.
Types
Type Description
UserGroupCreate This class is used to create a User Group.
UserGroupCreateWrapper JSON object with only a UserGroupCreate property.
UserGroup Content ID matcher class.
UserGroupWrapper JSON object with only a UserGroup property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroupCreate>
  <mainLanguageCode>eng-GB</mainLanguageCode>
  <remoteId>remoteId-qwert098</remoteId>
  <fields>
    <field>
      <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>
      <languageCode>eng-GB</languageCode>
      <fieldValue>UserGroup</fieldValue>
    </field>
    <field>
      <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier>
      <languageCode>eng-GB</languageCode>
      <fieldValue>This is the description of the user group</fieldValue>
    </field>
  </fields>
</UserGroupCreate>
View more

file_copy 

                                {
  "UserGroupCreate": {
    "mainLanguageCode": "eng-GB",
    "remoteId": "remoteId-qwert098",
    "fields": {
      "field": [
        {
          "fieldDefinitionIdentifier": "name",
          "languageCode": "eng-GB",
          "fieldValue": "UserGroup2"
        },
        {
          "fieldDefinitionIdentifier": "description",
          "languageCode": "eng-GB",
          "fieldValue": "This is the description of the user group"
        }
      ]
    }
  }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/>
    <name>UserGroup2</name>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/>
    <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/>
    <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/>
    <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/>
    <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <publishDate>2021-08-09T09:03:35+00:00</publishDate>
    <lastModificationDate>2021-08-09T09:03:35+00:00</lastMod
View more

file_copy 

                                {
    "UserGroup": {
        "_media-type": "application/vnd.ibexa.api.UserGroup+json",
        "_href": "/api/ibexa/v2/user/groups/1/5/81",
        "_id": 87,
        "_remoteId": "remoteId-qwert098",
        "ContentType": {
            "_media-type": "application/vnd.ibexa.api.ContentType+json",
            "_href": "/api/ibexa/v2/content/types/3"
        },
        "name": "UserGroup2",
        "Versions": {
            "_media-type": "application/vnd.ibexa.api.VersionList+json",
            "_href": "/api/ibexa/v2/content/objects/87/versions"
        },
        "Section": {
            "_media-type": "application/vnd.ibexa.api.Section+json",
            "_href": "/api/ibexa/v2/content/sections/2"
        },
        "MainLocation": {
            "_media-type": "application/vnd.ibexa.api.Location+json",
            "_href": "/api/ibexa/v2/content/locations/1/5/81"
        },
        "Locations": {
            "_media-type": "application/vnd.ibexa.api.LocationList+json",
View more

/user/groups/{path}/roles

Load Roles for User Group

GET /user/groups/{path}/roles

Returns a list of all Roles assigned to the given User Group.

Header parameters

Accept

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

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

400

Error - the user has no permission to read Roles.
Types
Type Description
RoleAssignmentList This value object represents a list of assignments of a User or User group to a role including a limitation.
RoleAssignmentListWrapper JSON object with only a RoleAssignmentList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/42/44/roles/1">
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1"/>
</RoleAssignment>
View more
Assign Role to User Group

POST /user/groups/{path}/roles

Assigns a Role to a User Group.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.RoleAssignmentList+xml application/vnd.ibexa.api.RoleAssignmentList+json

Content-Type

The RoleAssignInput schema encoded in XML or JSON format.

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

400

Error - validation of limitation in RoleAssignInput fails.
401

Error - the user is not authorized to assign this Role.
Types
Type Description
RoleAssignInput This class represents a Role assign input.
RoleAssignInputWrapper JSON object with only a RoleAssignInput property.
RoleAssignmentList This value object represents a list of assignments of a User or User group to a role including a limitation.
RoleAssignmentListWrapper JSON object with only a RoleAssignmentList property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleAssignInput>
  <Role href="/api/ibexa/v2/user/roles/10" media-type="application/vnd.ibexa.api.RoleAssignInput+xml"/>
  <limitation identifier="Section">
      <values>
          <ref href="/api/ibexa/v2/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" />
          <ref href="/api/ibexa/v2/content/sections/4" media-type="application/vnd.ibexa.api.Section+xml" />
      </values>
  </limitation>
</RoleAssignInput>
View more

file_copy 

                                {
  "RoleAssignInput": {
    "Role": {
      "_href": "/api/ibexa/v2/user/roles/2"
    },
    "limitation": {
      "_identifier": "Section",
      "values": {
        "ref": [
          {
            "_href": "/api/ibexa/v2/content/sections/1",
            "_media-type": "application/vnd.ibexa.api.Section+json"
          },
          {
            "_href": "/api/ibexa/v2/content/sections/4",
            "_media-type": "application/vnd.ibexa.api.Section+json"
          }
        ]
      }
    }
  }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles">
<RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/3">
    <limitation identifier="Section">
        <values>
            <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/>
        </values>
    </limitation>
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/>
</RoleAssignment>
<RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/10">
    <limitation identifier="Section">
        <values>
            <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/>
        </values>
    </limitation>
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/10"/>
</RoleAssignment>
<RoleAssignment media-type="
View more

file_copy 

                                {
    "RoleAssignmentList": {
        "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json",
        "_href": "/api/ibexa/v2/user/groups/1/12/2/roles",
        "RoleAssignment": [
            {
                "_media-type": "application/vnd.ibexa.api.RoleAssignment+json",
                "_href": "/api/ibexa/v2/user/groups/1/12/2/roles/2",
                "Role": {
                    "_media-type": "application/vnd.ibexa.api.Role+json",
                    "_href": "/api/ibexa/v2/user/roles/2"
                }
            }
        ]
    }
}
View more

/user/groups/{path}/roles/{roleId}

Load User Group Role Assignment

GET /user/groups/{path}/roles/{roleId}

Returns a Role assignment of the given User Group.

Header parameters

Accept

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

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

OK - returns a Role assignment of the given User Group.
401

Error - the user has no permission to read Roles.
Types
Type Description
RoleAssignment This value object represents an assignment of a User or User group to a role including a limitation.
RoleAssignmentWrapper JSON object with only a RoleAssignment property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/11/12/roles/1">
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1"/>
</RoleAssignment>
View more

file_copy 

                                {
    "RoleAssignment": {
        "_media-type": "application/vnd.ibexa.api.RoleAssignment+json",
        "_href": "/api/ibexa/v2/user/groups/1/11/12/roles/1",
        "Role": {
            "_media-type": "application/vnd.ibexa.api.Role+json",
            "_href": "/api/ibexa/v2/user/roles/1"
        }
    }
}
View more
Unassign Role from User Group

DELETE /user/groups/{path}/roles/{roleId}

The given Role is removed from the User or User Group.

Header parameters

Accept

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

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

401

Error - the user is not authorized to delete this Role assignment.
Types
Type Description
RoleAssignmentList This value object represents a list of assignments of a User or User group to a role including a limitation.
RoleAssignmentListWrapper JSON object with only a RoleAssignmentList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles">
<RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/3">
    <limitation identifier="Section">
        <values>
            <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/>
        </values>
    </limitation>
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/>
</RoleAssignment>
</RoleAssignmentList>
View more

file_copy 

                                {
    "RoleAssignmentList": {
        "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json",
        "_href": "/api/ibexa/v2/user/groups/1/57/58/roles",
        "RoleAssignment": [
            {
                "_media-type": "application/vnd.ibexa.api.RoleAssignment+json",
                "_href": "/api/ibexa/v2/user/groups/1/57/58/roles/3",
                "limitation": {
                    "_identifier": "Section",
                    "values": {
                        "ref": [
                            {
                                "_media-type": "application/vnd.ibexa.api.ref+json",
                                "_href": "1"
                            }
                        ]
                    }
                },
                "Role": {
                    "_media-type": "application/vnd.ibexa.api.Role+json",
                    "_href": "/api/ibexa/v2/user/roles/3"
                }
            }
        ]
    }
}
View more

/user/users

/user/users

List Users

GET /user/users

Load Users either for a given remote ID or Role.

Header parameters

Accept

UserList - If set, the User list is returned in XML or JSON format. UserRefList - If set, the link list of Users is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.UserList+xml application/vnd.ibexa.api.UserList+json application/vnd.ibexa.api.UserRefList+xml application/vnd.ibexa.api.UserRefList+json
Query parameters
Property Type Value
roleId string

Lists Users assigned to the given Role (e.g. GET /user/users?roleId=/user/roles/1).
remoteId string

Retrieves the User for the given remote ID (e.g. GET /user/users?remoteId=55dd9713db75145f374bbd0b4f60ad29).
login string

Retrieves the User for the given login (e.g. GET /user/users?login=editor).
email string

Lists Users with the given email (e.g. GET /user/users?email=[email protected]).
Possible responses
Code Description
200

OK - Loads Users either for a given remote ID or Role.
404

If there are no visible Users matching the filter.
Types
Type Description
UserList This class represents a list of users.
UserListWrapper JSON object with only a UserList property.
UserRefList Returns a list of the users.
UserRefListWrapper JSON object with only a UserRefList property.
Code: 200

file_copy 

                                {
    "UserList": {
        "_media-type": "application/vnd.ibexa.api.UserList+json",
        "_href": "/api/ibexa/v2/user/users",
        "User": [
            {
                "_media-type": "application/vnd.ibexa.api.User+json",
                "_href": "/api/ibexa/v2/user/users/14",
                "_id": 14,
                "_remoteId": "1bb4fe25487f05527efa8bfd394cecc7",
                "ContentType": {
                    "_media-type": "application/vnd.ibexa.api.ContentType+json",
                    "_href": "/api/ibexa/v2/content/types/4"
                },
                "name": "Administrator User",
                "Versions": {
                    "_media-type": "application/vnd.ibexa.api.VersionList+json",
                    "_href": "/api/ibexa/v2/content/objects/14/versions"
                },
                "Section": {
                    "_media-type": "application/vnd.ibexa.api.Section+json",
                    "_href": "/api/ibexa/v2/content/sections/2"
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserRefList media-type="application/vnd.ibexa.api.UserRefList+xml" href="/api/ibexa/v2/user/users">
    <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
</UserRefList>
View more
Verify Users

HEAD /user/users

Verifies if there are Users matching given filter.

Query parameters
Property Type Value
roleId string

Checks if there are Users directly assigned to the given Role (e.g. HEAD /user/users?roleId=/user/roles/1).
remoteId string

Checks if there is a User for the given remote ID (e.g. HEAD /user/users?remoteId=55dd9713db75145f374bbd0b4f60ad29).
login string

Checks if there is a User for the given login (e.g. HEAD /user/users?login=editor).
email string

Checks if there is a User with the given email (e.g. HEAD /user/users?email=[email protected]).
Possible responses
Code Description
200

OK - verifies if there are Users matching the given filter.
404

Error - there are no visible Users matching the filter.

/user/users/current

Load current User

GET /user/users/current

Redirects to current User, if available.

Header parameters

Accept

If set, the User is returned in XML or JSON format (after redirection).

Property Value
Type string
Examples application/vnd.ibexa.api.User+xml application/vnd.ibexa.api.User+json
Possible responses
Code Description
307

OK.
401

User is not currently logged in.

/user/users/{userId}

Load User

GET /user/users/{userId}

Loads User with the given ID.

Header parameters

Accept

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

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

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - the User with the given ID.
401

Error - the user has no permission to read Users.
404

Error - the User does not exist.
Types
Type Description
UserList This class represents a list of users.
UserListWrapper JSON object with only a UserList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users">
    <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13">
        <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/>
        <name>Jose Vargas</name>
        <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/>
        <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/>
        <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/>
        <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/>
        <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api
View more

file_copy 

                                {
    "UserList": {
        "_media-type": "application/vnd.ibexa.api.UserList+json",
        "_href": "/api/ibexa/v2/user/users",
        "User": [
            {
                "_media-type": "application/vnd.ibexa.api.User+json",
                "_href": "/api/ibexa/v2/user/users/79",
                "_id": 79,
                "_remoteId": "bcf0764b417f05af21852a1f03fb1f13",
                "ContentType": {
                    "_media-type": "application/vnd.ibexa.api.ContentType+json",
                    "_href": "/api/ibexa/v2/content/types/4"
                },
                "name": "Jose Vargas",
                "Versions": {
                    "_media-type": "application/vnd.ibexa.api.VersionList+json",
                    "_href": "/api/ibexa/v2/content/objects/79/versions"
                },
                "Section": {
                    "_media-type": "application/vnd.ibexa.api.Section+json",
                    "_href": "/api/ibexa/v2/content/sections/2"
View more
Update User

PATCH /user/users/{userId}

Updates a User.

Header parameters

Accept

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

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

Content-Type

The UserUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.UserUpdate+json application/vnd.ibexa.api.UserUpdate+xml

If-Match

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

Property Value
Type string
Examples ETag
Possible responses
Code Description
200

OK - User updated.
400

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

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

Error - the User does not exist.
412

Error - the current ETag does not match with the provided one in the If-Match header.
Types
Type Description
UserUpdate This class is used to update a User.
UserUpdateWrapper JSON object with only a UserUpdate property.
User This class represents a User value.
UserWrapper JSON object with only a User property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserUpdate>
  <login>josevargas</login>
  <enabled>false</enabled>
</UserUpdate>
View more

file_copy 

                                {
    "UserUpdate": {
        "login": "josevargas",
        "enabled": false
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/>
    <name>Jose Vargas</name>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/>
    <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/>
    <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/>
    <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/>
    <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/>
    <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"
View more

file_copy 

                                {
    "User": {
        "_media-type": "application/vnd.ibexa.api.User+json",
        "_href": "/api/ibexa/v2/user/users/79",
        "_id": 79,
        "_remoteId": "bcf0764b417f05af21852a1f03fb1f13",
        "ContentType": {
            "_media-type": "application/vnd.ibexa.api.ContentType+json",
            "_href": "/api/ibexa/v2/content/types/4"
        },
        "name": "Jose Vargas",
        "Versions": {
            "_media-type": "application/vnd.ibexa.api.VersionList+json",
            "_href": "/api/ibexa/v2/content/objects/79/versions"
        },
        "Section": {
            "_media-type": "application/vnd.ibexa.api.Section+json",
            "_href": "/api/ibexa/v2/content/sections/2"
        },
        "MainLocation": {
            "_media-type": "application/vnd.ibexa.api.Location+json",
            "_href": "/api/ibexa/v2/content/locations/1/5/12/79"
        },
        "Locations": {
            "_media-type": "application/vnd.ibexa.api.LocationList+json",
View more
Delete User

DELETE /user/users/{userId}

Deletes the given User.

Possible responses
Code Description
204

No Content.
401

Error - the user is not authorized to delete this User.
403

Error - the user is the same as the authenticated User.
404

Error - the User does not exist.

/user/users/{userId}/groups

Load Groups of User

GET /user/users/{userId}/groups

Returns a list of User Groups the User belongs to. The returned list includes the resources for unassigning a User Group if the User is in multiple groups.

Header parameters

Accept

If set, the link list of User Groups is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.UserGroupRefList+xml application/vnd.ibexa.api.UserGroupRefList+json
Query parameters
Property Type Value
offset integer

The offset of the result set.
limit integer

The number of Locations returned.
Possible responses
Code Description
200

401

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

Error - the user does not exist.
Types
Type Description
UserGroupRefList Returns a list of the sub groups.
UserGroupRefListWrapper JSON object with only a UserGroupRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/55/groups">
    <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12">
        <unassign href="/api/ibexa/v2/user/users/55/groups/12" method="DELETE"/>
    </UserGroup>
    <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/14">
        <unassign href="/api/ibexa/v2/user/users/55/groups/14" method="DELETE"/>
    </UserGroup>
</UserGroupRefList>
View more
Assign User Group

POST /user/users/{userId}/groups

Assigns the User to a User Group.

Header parameters

Accept

If set, the link list of User Groups is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.UserGroupRefList+xml application/vnd.ibexa.api.UserGroupRefList+json
Query parameters
Property Type Value
group string

The new parent group resource of the User.
Possible responses
Code Description
200

401

Error - the user is not authorized to assign User Groups.
403

Error - the new User Group does not exist or the User is already in this group.
404

Error - the User does not exist.
Types
Type Description
UserGroupRefList Returns a list of the sub groups.
UserGroupRefListWrapper JSON object with only a UserGroupRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups">
    <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12">
        <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/>
    </UserGroup>
    <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13">
        <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/>
    </UserGroup>
</UserGroupRefList>
View more

file_copy 

                                {
    "UserGroupRefList": {
        "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json",
        "_href": "/api/ibexa/v2/user/users/115/groups",
        "UserGroup": [
            {
                "_media-type": "application/vnd.ibexa.api.UserGroup+json",
                "_href": "/api/ibexa/v2/user/groups/1/5/12",
                "unassign": {
                    "_href": "/api/ibexa/v2/user/users/115/groups/12",
                    "_method": "DELETE"
                }
            },
            {
                "_media-type": "application/vnd.ibexa.api.UserGroup+json",
                "_href": "/api/ibexa/v2/user/groups/1/5/13",
                "unassign": {
                    "_href": "/api/ibexa/v2/user/users/115/groups/13",
                    "_method": "DELETE"
                }
            }
        ]
    }
}
View more

/user/users/{userId}/groups/{groupId}

Unassign User Group

DELETE /user/users/{userId}/groups/{groupId}

Unassigns the User from a User Group.

Header parameters

Accept

If set, the link list of User Groups is returned in XML or JSON format.

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

401

Error - the user is not authorized to unassign User Groups.
403

Error - the User is not in the given group.
404

Error - the User does not exist.
Types
Type Description
UserGroupRefList Returns a list of the sub groups.
UserGroupRefListWrapper JSON object with only a UserGroupRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserGroupRefList href="/user/users/45/groups"
  media-type="application/vnd.ibexa.api.UserGroupRefList">
  <UserGroup href="/user/groups/1/5/34" media-type="application/vnd.ibexa.api.UserGroup">
    <unassign href="/user/users/45/groups/34" method="DELETE" />
  </UserGroup>
  <UserGroup href="/user/groups/1/5/88" media-type="application/vnd.ibexa.api.UserGroup">
    <unassign href="/user/users/45/groups/88" method="DELETE" />
  </UserGroup>
</UserGroupRefList>
View more

/user/users/{userId}/roles

Load Roles for User

GET /user/users/{userId}/roles

Returns a list of all Roles assigned to the given User.

Header parameters

Accept

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

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

400

Error - the user has no permission to read Roles.
Types
Type Description
RoleAssignmentList This value object represents a list of assignments of a User or User group to a role including a limitation.
RoleAssignmentListWrapper JSON object with only a RoleAssignmentList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/115/roles">
    <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2">
        <limitation identifier="Section">
            <values>
                <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/>
            </values>
        </limitation>
        <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/>
    </RoleAssignment>
</RoleAssignmentList>
View more

file_copy 

                                {
    "RoleAssignmentList": {
        "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json",
        "_href": "/api/ibexa/v2/user/users/115/roles",
        "RoleAssignment": [
            {
                "_media-type": "application/vnd.ibexa.api.RoleAssignment+json",
                "_href": "/api/ibexa/v2/user/users/115/roles/2",
                "limitation": {
                    "_identifier": "Section",
                    "values": {
                        "ref": [
                            {
                                "_media-type": "application/vnd.ibexa.api.ref+json",
                                "_href": "1"
                            }
                        ]
                    }
                },
                "Role": {
                    "_media-type": "application/vnd.ibexa.api.Role+json",
                    "_href": "/api/ibexa/v2/user/roles/2"
                }
            }
        ]
    }
}
View more
Assign Role to User

POST /user/users/{userId}/roles

Assigns a Role to a user.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.RoleAssignmentList+xml application/vnd.ibexa.api.RoleAssignmentList+json

Content-Type

The RoleAssignInput schema encoded in XML or JSON format.

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

400

Error - validation of limitation in RoleAssignInput fails.
401

Error - the user is not authorized to assign this Role.
Types
Type Description
RoleAssignInput This class represents a Role assign input.
RoleAssignInputWrapper JSON object with only a RoleAssignInput property.
RoleAssignmentList This value object represents a list of assignments of a User or User group to a role including a limitation.
RoleAssignmentListWrapper JSON object with only a RoleAssignmentList property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleAssignInput>
    <Role href="/api/ibexa/v2/user/roles/2" media-type="application/vnd.ibexa.api.RoleAssignInput+xml"/>
    <limitation identifier="Section">
        <values>
            <ref href="/api/ibexa/v2/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" />
            <ref href="/api/ibexa/v2/content/sections/2" media-type="application/vnd.ibexa.api.Section+xml" />
        </values>
    </limitation>
</RoleAssignInput>
View more

file_copy 

                                {
  "RoleAssignInput": {
    "Role": {
      "_href": "/api/ibexa/v2/user/roles/2"
    },
    "limitation": {
      "_identifier": "Section",
      "values": {
        "ref": [
          {
            "_href": "/api/ibexa/v2/content/sections/1"
          },
          {
            "_href": "/api/ibexa/v2/content/sections/2"
          }
        ]
      }
    }
  }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/115/roles">
    <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2">
        <limitation identifier="Section">
            <values>
                <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/>
            </values>
        </limitation>
        <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/>
    </RoleAssignment>
    <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2">
        <limitation identifier="Section">
            <values>
                <ref media-type="application/vnd.ibexa.api.ref+xml" href="2"/>
            </values>
        </limitation>
        <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/>
View more

file_copy 

                                {
    "RoleAssignmentList": {
        "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json",
        "_href": "/api/ibexa/v2/user/users/115/roles",
        "RoleAssignment": [
            {
                "_media-type": "application/vnd.ibexa.api.RoleAssignment+json",
                "_href": "/api/ibexa/v2/user/users/115/roles/2",
                "limitation": {
                    "_identifier": "Section",
                    "values": {
                        "ref": [
                            {
                                "_media-type": "application/vnd.ibexa.api.ref+json",
                                "_href": "2"
                            }
                        ]
                    }
                },
                "Role": {
                    "_media-type": "application/vnd.ibexa.api.Role+json",
                    "_href": "/api/ibexa/v2/user/roles/2"
                }
            },
            {
                "_media-type": "application/vnd
View more

/user/users/{userId}/roles/{roleId}

Load User Role Assignment

GET /user/users/{userId}/roles/{roleId}

Returns a Role assignment to the given User.

Header parameters

Accept

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

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

OK - Role assignment to the given User Group.
401

Error - the user has no permission to read Roles.
Types
Type Description
RoleAssignment This value object represents an assignment of a User or User group to a role including a limitation.
RoleAssignmentWrapper JSON object with only a RoleAssignment property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/113/roles/3">
    <limitation identifier="Section">
        <values>
            <ref media-type="application/vnd.ibexa.api.ref+xml" href="6"/>
        </values>
    </limitation>
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/>
</RoleAssignment>
View more

file_copy 

                                {
    "RoleAssignment": {
        "_media-type": "application/vnd.ibexa.api.RoleAssignment+json",
        "_href": "/api/ibexa/v2/user/users/113/roles/3",
        "limitation": {
            "_identifier": "Section",
            "values": {
                "ref": [
                    {
                        "_media-type": "application/vnd.ibexa.api.ref+json",
                        "_href": "6"
                    }
                ]
            }
        },
        "Role": {
            "_media-type": "application/vnd.ibexa.api.Role+json",
            "_href": "/api/ibexa/v2/user/roles/3"
        }
    }
}
View more
Unassign Role from User

DELETE /user/users/{userId}/roles/{roleId}

The given Role is removed from the user.

Header parameters

Accept

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

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

401

Error - the user is not authorized to delete this content type.
Types
Type Description
RoleAssignmentList This value object represents a list of assignments of a User or User group to a role including a limitation.
RoleAssignmentListWrapper JSON object with only a RoleAssignmentList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleAssignmentList href="/user/groups/1/5/65/roles" media-type="application/vnd.ibexa.api.RoleAssignmentList+xml">
  <RoleAssignment href="/user/groups/1/5/65/roles/5" media-type="application/vnd.ibexa.api.RoleAssignment+xml">
    <Role href="/user/roles/5" media-type="application/vnd.ibexa.api.Role+xml"/>
  </RoleAssignment>
  <RoleAssignment href="/user/groups/1/5/65/roles/11" media-type="application/vnd.ibexa.api.RoleAssignment+xml">
    <limitation identifier="Section">
      <values>
          <ref href="/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" />
          <ref href="/content/sections/4" media-type="application/vnd.ibexa.api.Section+xml" />
      </values>
    </limitation>
    <Role href="/user/roles/11" media-type="application/vnd.ibexa.api.Role+xml"/>
  </RoleAssignment>
</RoleAssignmentList>
View more

file_copy 

                                {
    "RoleAssignmentList": {
        "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json",
        "_href": "/api/ibexa/v2/user/users/57/roles",
        "RoleAssignment": [
            {
                "_media-type": "application/vnd.ibexa.api.RoleAssignment+json",
                "_href": "/api/ibexa/v2/user/users/57/roles/1",
                "Role": {
                    "_media-type": "application/vnd.ibexa.api.Role+json",
                    "_href": "/api/ibexa/v2/user/roles/1"
                }
            },
            {
                "_media-type": "application/vnd.ibexa.api.RoleAssignment+json",
                "_href": "/api/ibexa/v2/user/users/57/roles/2",
                "Role": {
                    "_media-type": "application/vnd.ibexa.api.Role+json",
                    "_href": "/api/ibexa/v2/user/roles/2"
                }
            }
        ]
    }
}
View more

/user/users/{userId}/segments

View user segments

GET /user/users/{userId}/segments

Return user's segment list.

Header parameters

Accept

If set, the user's segment list is returned in XML or JSON format.

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

404

Error - the user doesn't exist.
Types
Type Description
UserSegmentList This class lists segment assignements.
UserSegmentListWrapper JSON object with only a UserSegmentList property
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<UserSegmentList media-type="application/vnd.ibexa.api.UserSegmentList+xml" href="/api/ibexa/v2/user/users/14/segments">
 <UserSegment media-type="application/vnd.ibexa.api.UserSegment+xml">
  <id>1</id>
  <identifier>corporate_account</identifier>
  <name>Corporate Account</name>
  <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/>
  <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
 </UserSegment>
</UserSegmentList>
View more

file_copy 

                                {
    "UserSegmentList": {
        "_media-type": "application\/vnd.ibexa.api.UserSegmentList+json",
        "_href": "\/api\/ibexa\/v2\/user\/users\/14\/segments",
        "UserSegment": [
            {
                "_media-type": "application\/vnd.ibexa.api.UserSegment+json",
                "id": 1,
                "identifier": "corporate_account",
                "name": "Corporate Account",
                "SegmentGroup": {
                    "_media-type": "application\/vnd.ibexa.api.SegmentGroup+json",
                    "_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts"
                },
                "User": {
                    "_media-type": "application\/vnd.ibexa.api.User+json",
                    "_href": "\/api\/ibexa\/v2\/user\/users\/14"
                }
            }
        ]
    }
}
View more
Assign Segments to User

POST /user/users/{userId}/segments

Assigns Segments from payload to User given by ID.

Header parameters

Content-Type

The UserSegmentAssignInput schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.UserSegmentAssignInput+xml application/vnd.ibexa.api.UserSegmentAssignInput+json
Possible responses
Code Description
204

No Content - segments assigned to user.
401

Error - the requesting user is not authorized to assign this segment to the given user.
404

Error - the user doesn't exist.
Types
Type Description
UserSegmentAssignInput This class represents a segment assignment input.
UserSegmentAssignInputWrapper JSON object with only a UserSegmentAssignInput property.

file_copy 

                                <UserSegmentAssignInput>
    <segments>corporate_account</segments>
</UserSegmentAssignInput>
View more

file_copy 

                                {
    "UserSegmentAssignInput": {
        "segments": ["corporate_account"]
    }
}
View more

/user/users/{userId}/segments/{segmentIdentifier}

Unassign Segment from User

DELETE /user/users/{userId}/segments/{segmentIdentifier}

The Segment designated by its identifier is unassigned from the User given by ID.

Possible responses
Code Description
204

No Content - segments unassigned from user.
401

Error - the requesting user is not authorized to unassign this segment from the given user.
404

Error - the segment or the user doesn't exist.

/user/users/{userId}/drafts

Load user drafts

GET /user/users/{userId}/drafts

Loads user's drafts

Header parameters

Accept

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

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

OK - List the draft versions
401

Error - the current user is not authorized to list the drafts of the given user.
Types
Type Description
VersionList List of all versions of the content.
VersionListWrapper JSON object with only a VersionList property.

/user/roles

/user/roles

Load Roles

GET /user/roles

Returns a list of all Roles.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.RoleList+xml application/vnd.ibexa.api.RoleList+json
Query parameters
Property Type Value
identifier string

Restricts the result to a list containing the Role with the given identifier. If the Role is not found an empty list is returned.
offset integer

The offset of the result set.
limit integer

Only limit items will be returned started by offset.
Possible responses
Code Description
200

OK - list of all Roles.
401

Error - the user has no permission to read Roles.
Types
Type Description
RoleList This class represents a list roles.
RoleListWrapper JSON object with only a RoleList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleList media-type="application/vnd.ibexa.api.RoleList+xml" href="/api/ibexa/v2/user/roles">
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1">
        <identifier>Anonymous</identifier>
        <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/1/policies"/>
    </Role>
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2">
        <identifier>Administrator</identifier>
        <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/2/policies"/>
    </Role>
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3">
        <identifier>Editor</identifier>
        <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/3/policies"/>
    </Role>
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/i
View more

file_copy 

                                {
    "RoleList": {
        "_media-type": "application/vnd.ibexa.api.RoleList+json",
        "_href": "/api/ibexa/v2/user/roles",
        "Role": [
            {
                "_media-type": "application/vnd.ibexa.api.Role+json",
                "_href": "/api/ibexa/v2/user/roles/1",
                "identifier": "Anonymous",
                "Policies": {
                    "_media-type": "application/vnd.ibexa.api.PolicyList+json",
                    "_href": "/api/ibexa/v2/user/roles/1/policies"
                }
            },
            {
                "_media-type": "application/vnd.ibexa.api.Role+json",
                "_href": "/api/ibexa/v2/user/roles/2",
                "identifier": "Administrator",
                "Policies": {
                    "_media-type": "application/vnd.ibexa.api.PolicyList+json",
                    "_href": "/api/ibexa/v2/user/roles/2/policies"
                }
            },
            {
                "_media-type": "application/vnd.i
View more
Create Role or Role draft

POST /user/roles

Creates a new Role or Role draft.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Role+xml application/vnd.ibexa.api.Role+json application/vnd.ibexa.api.RoleDraft+xml application/vnd.ibexa.api.RoleDraft+json

Content-Type

The RoleInput schema encoded in XML or JSON.

Property Value
Type string
Examples application/vnd.ibexa.api.RoleInput+json application/vnd.ibexa.api.RoleInput+xml
Query parameters
Property Type Value
publish boolean

If true the Role is published after creation.
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 a Role or a Role draft.
Types
Type Description
RoleInput This class represents a Role input.
RoleInputWrapper JSON object with only a RoleInput property.
Role This class represents a role.
RoleWrapper JSON object with only a Role property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleInput>
    <identifier>NewRole</identifier>
</RoleInput>
View more

file_copy 

                                {
    "RoleInput": {
        "identifier": "NewRole"
    }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/19">
    <identifier>NewRole</identifier>
    <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/19/policies"/>
</Role>
View more

file_copy 

                                {
    "Role": {
        "_media-type": "application/vnd.ibexa.api.Role+json",
        "_href": "/api/ibexa/v2/user/roles/21",
        "identifier": "NewRole",
        "Policies": {
            "_media-type": "application/vnd.ibexa.api.PolicyList+json",
            "_href": "/api/ibexa/v2/user/roles/21/policies"
        }
    }
}
View more

/user/roles/{id}

Load Role

GET /user/roles/{id}

Loads a Role for the given ID.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Role+xml application/vnd.ibexa.api.Role+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - Role for the given ID.
401

Error - the user has no permission to read Roles.
404

Error - the Role does not exist.
Types
Type Description
Role This class represents a role.
RoleWrapper JSON object with only a Role property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/21">
    <identifier>NewRole</identifier>
    <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/21/policies"/>
</Role>
View more

file_copy 

                                {
    "Role": {
        "_media-type": "application/vnd.ibexa.api.Role+json",
        "_href": "/api/ibexa/v2/user/roles/21",
        "identifier": "NewRole",
        "Policies": {
            "_media-type": "application/vnd.ibexa.api.PolicyList+json",
            "_href": "/api/ibexa/v2/user/roles/21/policies"
        }
    }
}
View more
Create Role Draft

POST /user/roles/{id}

Creates a new Role draft from an existing Role.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Role+xml application/vnd.ibexa.api.Role+json

Content-Type

The RoleInput schema encoded in XML or JSON.

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

401

Error - the user is not authorized to create a Role or a Role draft
Types
Type Description
RoleDraft This class represents a draft of a role, extends Role.
RoleDraftWrapper JSON object with only a Role property.
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Role href="/user/roles/11" media-type="application/vnd.ibexa.api.RoleDraft+xml">
  <identifier>MyRole</identifier>
  <Policies href="/user/roles/11/policies" media-type="application/vnd.ibexa.api.PolicyList+xml"/>
</Role>
View more

file_copy 

                                {
    "Role": {
        "_media-type": "application/vnd.ibexa.api.Role+json",
        "_href": "/api/ibexa/v2/user/roles/6",
        "identifier": "Editor",
        "Policies": {
            "_media-type": "application/vnd.ibexa.api.PolicyList+json",
            "_href": "/api/ibexa/v2/user/roles/6/policies"
        }
    }
}
View more
Update Role

PATCH /user/roles/{id}

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

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Role+xml application/vnd.ibexa.api.Role+json

Content-Type

The RoleInput schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.RoleInput+json application/vnd.ibexa.api.RoleInput+xml

If-Match

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

Property Value
Type string
Possible responses
Code Description
200

OK - Role updated
400

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

Error - the user is not authorized to update the Role.
412

Error - the current ETag does not match with the provided one in the If-Match header.
Types
Type Description
RoleInput This class represents a Role input.
RoleInputWrapper JSON object with only a RoleInput property.
Role This class represents a role.
RoleWrapper JSON object with only a Role property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleInput>
    <identifier>NewIdentifier</identifier>
</RoleInput>
View more

file_copy 

                                {
    "RoleInput": {
        "identifier": "NewIdentifier"
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/5">
    <identifier>NewIdentifier</identifier>
    <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/5/policies"/>
</Role>
View more

file_copy 

                                {
    "Role": {
        "_media-type": "application/vnd.ibexa.api.Role+json",
        "_href": "/api/ibexa/v2/user/roles/21",
        "identifier": "NewIdentifier",
        "Policies": {
            "_media-type": "application/vnd.ibexa.api.PolicyList+json",
            "_href": "/api/ibexa/v2/user/roles/21/policies"
        }
    }
}
View more
Delete Role

DELETE /user/roles/{id}

The given Role and all assignments to Users or User Groups are deleted.

Possible responses
Code Description
204

No Content.
401

Error - the User is not authorized to delete this Role.

/user/roles/{id}/draft

Load Role draft

GET /user/roles/{id}/draft

Loads a Role draft by original Role ID.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Role+xml application/vnd.ibexa.api.Role+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - Role draft by original Role ID.
401

Error - the user has no permission to read Roles.
404

Error - there is no draft or Role with the given ID.
Types
Type Description
Role This class represents a role.
RoleWrapper JSON object with only a Role property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/27">
    <identifier>Anonymous</identifier>
    <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/27/policies"/>
</Role>
View more

file_copy 

                                {
    "Role": {
        "_media-type": "application/vnd.ibexa.api.Role+json",
        "_href": "/api/ibexa/v2/user/roles/27",
        "identifier": "Anonymous",
        "Policies": {
            "_media-type": "application/vnd.ibexa.api.PolicyList+json",
            "_href": "/api/ibexa/v2/user/roles/27/policies"
        }
    }
}
View more
Update Role draft

PATCH /user/roles/{id}/draft

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

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Role+xml application/vnd.ibexa.api.Role+json

Content-Type

The RoleInput schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.RoleInput+json application/vnd.ibexa.api.RoleInput+xml

If-Match

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

Property Value
Type string
Possible responses
Code Description
200

OK - Role draft updated.
400

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

Error - the user is not authorized to update the Role.
404

Error - there is no draft or Role with the given ID.
412

Error - the current ETag does not match with the one provided in the If-Match header.
Types
Type Description
RoleInput This class represents a Role input.
RoleInputWrapper JSON object with only a RoleInput property.
Role This class represents a role.
RoleWrapper JSON object with only a Role property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RoleInput>
    <identifier>UpdatedIdentifier</identifier>
</RoleInput>
View more

file_copy 

                                {
    "RoleInput": {
        "identifier": "UpdatedIdentifier"
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/9">
    <identifier>UpdatedIdentifier</identifier>
    <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/9/policies"/>
</Role>
View more

file_copy 

                                {
    "Role": {
        "_media-type": "application/vnd.ibexa.api.Role+json",
        "_href": "/api/ibexa/v2/user/roles/6",
        "identifier": "UpdatedIdentifier",
        "Policies": {
            "_media-type": "application/vnd.ibexa.api.PolicyList+json",
            "_href": "/api/ibexa/v2/user/roles/6/policies"
        }
    }
}
View more
Publish Role draft

PUBLISH /user/roles/{id}/draft

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

Possible responses
Code Description
204

No Content.
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 - there is no draft or Role with the given ID.
Delete Role draft

DELETE /user/roles/{id}/draft

The given Role draft is deleted.

Possible responses
Code Description
204

No Content.
401

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

/user/roles/{id}/policies

Load Policies

GET /user/roles/{id}/policies

Loads Policies for the given Role.

Header parameters

Accept

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

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

401

Error - the user has no permission to read Roles.
404

Error - the Role does not exist.
Types
Type Description
PolicyList List of policies.
PolicyListWrapper JSON object with only a PolicyList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<PolicyList media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/1/policies">
    <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/349">
        <id>349</id>
        <module>content</module>
        <function>read</function>
        <limitations>
            <limitation identifier="Section">
                <values>
                    <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/>
                    <ref media-type="application/vnd.ibexa.api.ref+xml" href="3"/>
                    <ref media-type="application/vnd.ibexa.api.ref+xml" href="6"/>
                </values>
            </limitation>
        </limitations>
    </Policy>
    <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/350">
        <id>350</id>
        <module>user</module>
        <function>login</function>
        <limitations>
View more

file_copy 

                                {
    "PolicyList": {
        "_media-type": "application/vnd.ibexa.api.PolicyList+json",
        "_href": "/api/ibexa/v2/user/roles/1/policies",
        "Policy": [
            {
                "_media-type": "application/vnd.ibexa.api.Policy+json",
                "_href": "/api/ibexa/v2/user/roles/1/policies/349",
                "id": 349,
                "module": "content",
                "function": "read",
                "limitations": {
                    "limitation": [
                        {
                            "_identifier": "Section",
                            "values": {
                                "ref": [
                                    {
                                        "_media-type": "application/vnd.ibexa.api.ref+json",
                                        "_href": "1"
                                    },
                                    {
                                        "_media-type": "application/vnd.ibexa.api.ref+jso
View more
Delete Policies

DELETE /user/roles/{id}/policies

All Policies of the given Role are deleted.

Possible responses
Code Description
204

No Content - all Policies of the given Role are deleted.
401

Error - the user is not authorized to delete this content type.
Create Policy

POST /user/roles/{id}/policies

Creates a Policy

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Policy+xml application/vnd.ibexa.api.Policy+json

Content-Type

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

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

400

Error - the input does not match the input schema definition or validation of limitation in PolicyCreate fails.
401

Error - the user is not authorized to create the Policy.
404

Error - the Role does not exist.
Types
Type Description
PolicyCreate This class is used to create a Policy.
PolicyCreateWrapper JSON object with only a PolicyCreate property.
Policy This class represents a policy value.
PolicyWrapper JSON object with only a Policy property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<PolicyCreate>
    <module>content</module>
    <function>create</function>
    <limitations>
        <limitation identifier="Class">
            <values>
                <ref href="2"/>
            </values>
        </limitation>
        <limitation identifier="ParentClass">
            <values>
                <ref href="1"/>
            </values>
        </limitation>
    </limitations>
</PolicyCreate>
View more
Code: 201

file_copy 

                                <Policy href="/user/roles/11/policies/55" media-type="application/vnd.ibexa.api.Policy+xml">
  <id>55</id>
  <module>content</module>
  <function>create</function>
  <limitations>
    <limitation identifier="Class">
      <values>
        <ref href="/content/types/13"/>
      </values>
    </limitation>
    <limitation identifier="ParentClass">
      <values>
        <ref href="/content/types/12"/>
      </values>
    </limitation>
  </limitations>
 </Policy>
View more

/user/roles/{id}/policies/{id}

Update Policy

PATCH /user/roles/{id}/policies/{id}

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

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Policy+xml application/vnd.ibexa.api.Policy+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.PolicyUpdate+xml application/vnd.ibexa.api.PolicyUpdate+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
Possible responses
Code Description
200

400

Error - the input does not match the input schema definition or validation of limitation in PolicyUpdate fails.
401

Error - the user is not authorized to update the Policy.
404

Error - the Role does not exist.
412

Error - the current ETag does not match with the one provided in the If-Match header.
Types
Type Description
PolicyUpdate This class is used to update a Policy.
PolicyUpdateWrapper JSON object with only a PolicyUpdate property.
Policy This class represents a policy value.
PolicyWrapper JSON object with only a Policy property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<PolicyUpdate>
    <limitations>
        <limitation identifier="Class">
            <values>
                <ref href="2"/>
            </values>
        </limitation>
        <limitation identifier="ParentClass">
            <values>
                <ref href="1"/>
            </values>
        </limitation>
    </limitations>
</PolicyUpdate>
View more
Code: 200

file_copy 

                                <Policy href="/user/roles/11/policies/55" media-type="application/vnd.ibexa.api.Policy+xml">
  <id>55</id>
  <module>content</module>
  <function>create</function>
  <limitations>
    <limitation identifier="Class">
      <values>
        <ref href="/content/types/14"/>
      </values>
    </limitation>
    <limitation identifier="ParentClass">
      <values>
        <ref href="/content/types/10"/>
      </values>
    </limitation>
  </limitations>
 </Policy>
View more
Load Policy

GET /user/roles/{id}/policies/{id}

Loads a Policy for the given module and function.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Policy+xml application/vnd.ibexa.api.Policy+json

If-None-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

401

Error - the user has no permission to read Roles.
404

Error - the Role or Policy does not exist.
Types
Type Description
Policy This class represents a policy value.
PolicyWrapper JSON object with only a Policy property.
Code: 200

file_copy 

                                <Policy href="/user/roles/11/policies/45" media-type="application/vnd.ibexa.api.Policy+xml">
  <id>45</id>
  <module>content</module>
  <function>create</function>
  <limitations>
    <limitation identifier="Class">
      <values>
        <ref href="/content/types/10" media-type="application/vnd.ibexa.api.ContentType+xml" />
        <ref href="/content/types/11" media-type="application/vnd.ibexa.api.ContentType+xml" />
        <ref href="/content/types/12" media-type="application/vnd.ibexa.api.ContentType+xml" />
      </values>
    </limitation>
    <limitation identifier="ParentClass">
      <values>
        <ref href="/content/types/4" media-type="application/vnd.ibexa.api.ContentType+xml" />
      </values>
    </limitation>
  </limitations>
</Policy>
View more

file_copy 

                                {
    "Policy": {
        "_media-type": "application/vnd.ibexa.api.Policy+json",
        "_href": "/api/ibexa/v2/user/roles/1/policies/352",
        "id": 352,
        "module": "user",
        "function": "register"
    }
}
View more
Delete Policy

DELETE /user/roles/{id}/policies/{id}

Deletes given Policy.

Possible responses
Code Description
204

No Content - the given Policy is deleted.
401

Error - the user is not authorized to delete this content type.
404

Error - the Role or Policy does not exist.

/user/policies

/user/policies

List Policies for User

GET /user/policies

Search all Policies which are applied to a given User.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.PolicyList+xml application/vnd.ibexa.api.PolicyList+json
Query parameters
Property Type Value
userId string

The User ID.
Possible responses
Code Description
200

OK - Policies which are applied to a given User.
401

Error - the user has no permission to read Roles.
Types
Type Description
PolicyList List of policies.
PolicyListWrapper JSON object with only a PolicyList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<PolicyList media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/policies">
    <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/349">
        <id>349</id>
        <module>content</module>
        <function>read</function>
        <limitations>
            <limitation identifier="Section">
                <values>
                    <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/>
                    <ref media-type="application/vnd.ibexa.api.ref+xml" href="3"/>
                    <ref media-type="application/vnd.ibexa.api.ref+xml" href="6"/>
                </values>
            </limitation>
        </limitations>
    </Policy>
    <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/350">
        <id>350</id>
        <module>user</module>
        <function>login</function>
        <limitations>
View more

file_copy 

                                {
    "PolicyList": {
        "_media-type": "application/vnd.ibexa.api.PolicyList+json",
        "_href": "/api/ibexa/v2/user/policies",
        "Policy": [
            {
                "_media-type": "application/vnd.ibexa.api.Policy+json",
                "_href": "/api/ibexa/v2/user/roles/1/policies/349",
                "id": 349,
                "module": "content",
                "function": "read",
                "limitations": {
                    "limitation": [
                        {
                            "_identifier": "Section",
                            "values": {
                                "ref": [
                                    {
                                        "_media-type": "application/vnd.ibexa.api.ref+json",
                                        "_href": "1"
                                    },
                                    {
                                        "_media-type": "application/vnd.ibexa.api.ref+json",
View more

/user/sessions

/user/sessions

Create session (login a User)

POST /user/sessions

Performs a login for the user or checks if session exists and returns the session and session cookie. The client will need to remember both session name/ID and CSRF token as this is for security reasons not exposed via GET.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Session+xml application/vnd.ibexa.api.Session+json

Content-Type

The SessionInput schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.SessionInput+xml application/vnd.ibexa.api.SessionInput+json

Cookie

Only needed for session's checking {sessionName}={sessionID}.

Property Value
Type string

X-CSRF-Token

Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

Property Value
Type string
Possible responses
Code Description
200

Session already exists.
201

Session is created.
400

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

Error - the authorization failed.
409

Error - header contained a session cookie but different user was authorized.
Types
Type Description
SessionInput This class represents a session input.
SessionInputWrapper JSON object with only a SessionInput property.
Session Value for session.
SessionWrapper JSON object with only a Session property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SessionInput>
  <login>admin</login>
  <password>secret</password>
</SessionInput>
View more

file_copy 

                                {
  "SessionInput": {
    "login": "admin",
    "password": "secret"
  }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Session href="/user/sessions/sessionID" media-type="application/vnd.ibexa.api.Session+xml">
  <name>eZSSID</name>
  <identifier>go327ij2cirpo59pb6rrv2a4el2</identifier>
  <csrfToken>23lkneri34ijajedfw39orj3j93</csrfToken>
  <User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/>
</Session>
View more

file_copy 

                                {
  "Session": {
    "name": "eZSSID",
    "identifier": "go327ij2cirpo59pb6rrv2a4el2",
    "csrfToken": "23lkneri34ijajedfw39orj3j93",
    "User": {
      "_href": "/user/users/14",
      "_media-type": "application/vnd.ibexa.api.User+json"
    }
  }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Session href="/user/sessions/sessionID" media-type="application/vnd.ibexa.api.Session+xml">
  <name>eZSSID</name>
  <identifier>go327ij2cirpo59pb6rrv2a4el2</identifier>
  <csrfToken>23lkneri34ijajedfw39orj3j93</csrfToken>
  <User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/>
</Session>
View more

file_copy 

                                {
  "Session": {
    "name": "eZSSID",
    "identifier": "go327ij2cirpo59pb6rrv2a4el2",
    "csrfToken": "23lkneri34ijajedfw39orj3j93",
    "User": {
      "_href": "/user/users/14",
      "_media-type": "application/vnd.ibexa.api.User+json"
    }
  }
}
View more

/user/sessions/current

Get current session

GET /user/sessions/current

Get current user session, if any.

Header parameters

Cookie

Only needed for session's checking {sessionName}={sessionID}.

Property Value
Type string

Accept

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

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

User is currently logged in and has a valid session.
404

User does not have a valid session, or it has expired.
Types
Type Description
Session Value for session.
SessionWrapper JSON object with only a Session property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Session href="/user/sessions/sessionID" media-type="application/vnd.ibexa.api.Session+xml">
  <name>eZSSID</name>
  <identifier>go327ij2cirpo59pb6rrv2a4el2</identifier>
  <csrfToken>23lkneri34ijajedfw39orj3j93</csrfToken>
  <User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/>
</Session>
View more

file_copy 

                                {
  "Session": {
    "name": "eZSSID",
    "identifier": "go327ij2cirpo59pb6rrv2a4el2",
    "csrfToken": "23lkneri34ijajedfw39orj3j93",
    "User": {
      "_href": "/user/users/14",
      "_media-type": "application/vnd.ibexa.api.User+json"
    }
  }
}
View more

/user/sessions/{sessionId}

Delete session (logout a User)

DELETE /user/sessions/{sessionId}

The user session is removed i.e. the user is logged out.

Header parameters

Cookie

{sessionName}={sessionID}

Property Value
Type string

X-CSRF-Token

The {csrfToken} needed on all unsafe HTTP methods with session.

Property Value
Type string
Possible responses
Code Description
204

OK - session deleted.
404

Error - the session does not exist.

/user/sessions/{sessionId}/refresh

Refresh session (deprecated)

POST /user/sessions/{sessionId}/refresh

Get the session's User information. Deprecated as of Ibexa DXP 4.6, use GET /user/sessions/current instead.

Header parameters

Cookie

{sessionName}={sessionID}

Property Value
Type string

X-CSRF-Token

The {csrfToken} needed on all unsafe HTTP methods with session.

Property Value
Type string

Accept

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

404

Error - the session does not exist.
Types
Type Description
Session Value for session.
SessionWrapper JSON object with only a Session property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Session href="user/sessions/go327ij2cirpo59pb6rrv2a4el2/refresh" media-type="application/vnd.ibexa.api.Session+xml">
  <name>eZSSID</name>
  <identifier>go327ij2cirpo59pb6rrv2a4el2</identifier>
  <csrfToken>23lkneri34ijajedfw39orj3j93</csrfToken>
  <User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/>
</Session>
View more

file_copy 

                                {
  "Session": {
    "name": "eZSSID",
    "identifier": "go327ij2cirpo59pb6rrv2a4el2",
    "csrfToken": "23lkneri34ijajedfw39orj3j93",
    "User": {
      "_href": "/user/users/14",
      "_media-type": "application/vnd.ibexa.api.User+json"
    }
  }
}
View more

/user/token

/user/token/jwt

Create JWT token

POST /user/token/jwt

Creates JWT authentication token.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.JWT+xml application/vnd.ibexa.api.JWT+json

Content-Type

The SessionInput schema encoded in XML or JSON format.

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

401

Error - Unauthorized
Types
Type Description
JWTInput This class represents the input for a JWT authentication token
JWTInputWrapper JSON object with only a JWTInput property.
JWT This class represents the JWT authentication token
JWTWrapper JSON object with only a JWT property.

file_copy 

                                <JWTInput>
    <password>publish</password>
    <username>admin</username>
</JWTInput>
View more

file_copy 

                                {
    "JWTInput": {
        "username": "admin",
        "password": "publish"
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<JWT media-type="application/vnd.ibexa.api.JWT+xml" token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3NjEsImV4cCI6MTYwMjg0NDM2MSwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.LsmdVjad7wMwVQUo4vSftT0zHbJyArOMd23b417E2jI">
    <token>eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3NjEsImV4cCI6MTYwMjg0NDM2MSwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.LsmdVjad7wMwVQUo4vSftT0zHbJyArOMd23b417E2jI</token>
</JWT>
View more

file_copy 

                                {
    "JWT": {
        "_media-type": "application/vnd.ibexa.api.JWT+json",
        "_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3ODAsImV4cCI6MTYwMjg0NDM4MCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.0LHa799HwSwwfDBZd2V0q2xHwGt86PpyZamKnXHQyYI",
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3ODAsImV4cCI6MTYwMjg0NDM4MCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.0LHa799HwSwwfDBZd2V0q2xHwGt86PpyZamKnXHQyYI"
    }
}
View more

Segments

/segments

Create a segment

POST /segments

Creates a segment.

Header parameters

Content-Type

A SegmentCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.SegmentCreate+xml application/vnd.ibexa.api.SegmentCreate+json

Accept

A segment is returned in XML or JSON format.

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

OK - returns new segment's data.
400

Error - input data validation failed.
401

Error - the user is not authorized to create segments.
404

Error - segment group with given identifier does not exist.
406

Error - input data is not acceptable, for example segment identifier is not unique.
Types
Type Description
SegmentCreate This class represents a new segment to create.
SegmentCreateWrapper JSON object with only a SegmentCreate property.
Segment This class represents a segment.
SegmentWrapper JSON object with only a Segment property.
ErrorMessage Represents an error response. Might contain additional properties depending on an error type.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SegmentCreate>
  <identifier>segment_identifier</identifier>
  <name>Segment Name</name>
  <group>corporate_accounts</group>
</SegmentCreate>
View more

file_copy 

                                {
    "SegmentCreate": {
        "identifier": "segment_identifier",
        "name": "Segment Name",
        "group": "corporate_accounts"
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Segment media-type="application/vnd.ibexa.api.Segment+xml" href="/api/ibexa/v2/segments/segment_identifier">
    <id>3</id>
    <identifier>segment_identifier</identifier>
    <name>Segment Name</name>
    <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/>
</Segment>
View more

file_copy 

                                {
    "Segment": {
        "_media-type": "application/vnd.ibexa.api.Segment+json",
        "_href": "/api/ibexa/v2/segments/segment_identifier",
        "id": 3,
        "identifier": "segment_identifier",
        "name": "Segment Name",
        "SegmentGroup": {
            "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
            "_href": "/api/ibexa/v2/segment_groups/corporate_accounts"
        }
    }
}
View more

/segments/{identifier}

Load segment

GET /segments/{identifier}

Loads the identified segment.

Header parameters

Accept

If set, the segment is returned in XML or JSON

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

OK - Return the segment.
401

Error - the user is not authorized to load this segment.
404

Error - the identifier doesn't match any segment.
Types
Type Description
Segment This class represents a segment.
SegmentWrapper JSON object with only a Segment property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Segment media-type="application/vnd.ibexa.api.Segment+xml" href="/api/ibexa/v2/segments/segment_identifier">
    <id>3</id>
    <identifier>segment_identifier</identifier>
    <name>Segment Name</name>
    <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/>
</Segment>
View more

file_copy 

                                {
    "Segment": {
        "_media-type": "application/vnd.ibexa.api.Segment+json",
        "_href": "/api/ibexa/v2/segments/segment_identifier",
        "id": 3,
        "identifier": "segment_identifier",
        "name": "Segment Name",
        "SegmentGroup": {
            "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
            "_href": "/api/ibexa/v2/segment_groups/corporate_accounts"
        }
    }
}
View more
Update segment data

PATCH /segments/{identifier}

Updates the segment's data.

Header parameters

Content-Type

The SegmentUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.SegmentUpdate+xml application/vnd.ibexa.api.SegmentUpdate+json

Accept

A segment is returned in XML or JSON format.

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

OK - returns updated segment's data.
400

Error - input data validation failed.
401

Error - the user is not authorized to create segments.
404

Error - segment or segment group with given identifier does not exist.
406

Error - input data is not acceptable, for example segment identifier is not unique.
Types
Type Description
SegmentUpdate This class represents an update to an existing segment.
SegmentUpdateWrapper JSON object with only a SegmentUpdate property.
Segment This class represents a segment.
SegmentWrapper JSON object with only a Segment property.
ErrorMessage Represents an error response. Might contain additional properties depending on an error type.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SegmentUpdate>
  <identifier>modified_segment_identifier</identifier>
  <name>Modified Segment Name</name>
  <group>small_companies</group>
</SegmentUpdate>
View more

file_copy 

                                {
    "SegmentUpdate": {
        "identifier": "modified_segment_identifier",
        "name": "Modified Segment Name",
        "group": "small_companies"
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Segment media-type="application/vnd.ibexa.api.Segment+xml" href="/api/ibexa/v2/segments/modified_segment_identifier">
    <id>3</id>
    <identifier>modified_segment_identifier</identifier>
    <name>Modified Segment Name</name>
    <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/small_companies"/>
</Segment>
View more

file_copy 

                                {
    "Segment": {
        "_media-type": "application/vnd.ibexa.api.Segment+json",
        "_href": "/api/ibexa/v2/segments/modified_segment_identifier",
        "id": 3,
        "identifier": "modified_segment_identifier",
        "name": "Modified Segment Name",
        "SegmentGroup": {
            "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
            "_href": "/api/ibexa/v2/segment_groups/small_companies"
        }
    }
}
View more
Delete a segment

DELETE /segments/{identifier}

Deletes the segment.

Possible responses
Code Description
204

Segment deleted.
401

Error - the user is not authorized to delete segments.
404

Error - the identifier doesn't match any segment.
Types
Type Description
ErrorMessage Represents an error response. Might contain additional properties depending on an error type.

Segment groups

/segment_groups

List segment groups

GET /segment_groups

Lists segment groups.

Header parameters

Accept

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

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

OK - list the segment groups.
401

Error - the user is not authorized to list segment groups.
Types
Type Description
SegmentGroupList This class lists segment groups.
SegmentGroupListWrapper JSON object with only a SegmentGroupList property.
ErrorMessage Represents an error response. Might contain additional properties depending on an error type.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SegmentGroupList media-type="application/vnd.ibexa.api.SegmentGroupList+xml" href="/api/ibexa/v2/segment_groups">
 <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
  <id>1</id>
  <identifier>corporate_accounts</identifier>
  <name>Corporate Accounts</name>
 </SegmentGroup>
</SegmentGroupList>
View more

file_copy 

                                {
    "SegmentGroupList": {
        "_media-type": "application\/vnd.ibexa.api.SegmentGroupList+json",
        "_href": "\/api\/ibexa\/v2\/segment_groups",
        "SegmentGroup": [
            {
                "_media-type": "application\/vnd.ibexa.api.SegmentGroup+json",
                "_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts",
                "id": 1,
                "identifier": "corporate_accounts",
                "name": "Corporate Accounts"
            }
        ]
    }
}
View more
Create a segment group

POST /segment_groups

Creates a segment group.

Header parameters

Content-Type

A SegmentGroupCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.SegmentGroupCreate+xml application/vnd.ibexa.api.SegmentGroupCreate+json

Accept

A segment group is returned in XML or JSON format.

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

OK - list the segment groups.
400

Error - input data validation failed.
401

Error - the user is not authorized to list segment groups.
406

Error - input data is not acceptable, for example, segment group identifier is not unique.
Types
Type Description
SegmentGroupCreate This class represents a new segment group to create.
SegmentGroupCreateWrapper JSON object with only a SegmentGroupCreate property.
SegmentGroup This class represents a segment group.
SegmentGroupWrapper JSON object with only a SegmentGroup property.
ErrorMessage Represents an error response. Might contain additional properties depending on an error type.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SegmentGroupCreate>
    <identifier>segment_group_identifier</identifier>
    <name>Segment Group Name</name>
</SegmentGroupCreate>
View more

file_copy 

                                {
    "SegmentGroupCreate": {
        "identifier": "segment_group_identifier",
        "name": "Segment Group Name"
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/segment_group_identifier">
    <id>3</id>
    <identifier>segment_group_identifier</identifier>
    <name>Segment Group Name</name>
</SegmentGroup>
View more

file_copy 

                                {
    "SegmentGroup": {
        "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
        "_href": "/api/ibexa/v2/segment_groups/segment_group_identifier",
        "id": 3,
        "identifier": "segment_group_identifier",
        "name": "Segment Group Name"
    }
}
View more

/segment_groups/{identifier}

Load segment group

GET /segment_groups/{identifier}

Loads segment group.

Header parameters

Accept

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

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

OK - return the segment group.
401

Error - the user is not authorized to load this segment group.
404

Error - the identifier doesn't match any segment group.
Types
Type Description
SegmentGroup This class represents a segment group.
SegmentGroupWrapper JSON object with only a SegmentGroup property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
 <id>1</id>
 <identifier>corporate_accounts</identifier>
 <name>Corporate Accounts</name>
</SegmentGroup>
View more

file_copy 

                                {
    "SegmentGroup": {
        "_media-type": "application\/vnd.ibexa.api.SegmentGroup+json",
        "_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts",
        "id": 1,
        "identifier": "corporate_accounts",
        "name": "Corporate Accounts"
    }
}
View more
Update segment group data

PATCH /segment_groups/{identifier}

Updates the segment group's data.

Header parameters

Content-Type

The SegmentGroupUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.SegmentGroupUpdate+xml application/vnd.ibexa.api.SegmentGroupUpdate+json

Accept

A segment group is returned in XML or JSON format.

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

OK - returns updated segment group's data.
Types
Type Description
SegmentGroupUpdate This class represents an update to an existing segment group.
SegmentGroupUpdateWrapper JSON object with only a SegmentGroupUpdate property.
SegmentGroup This class represents a segment group.
SegmentGroupWrapper JSON object with only a SegmentGroup property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SegmentGroupUpdate>
    <identifier>modified_segment_group_identifier</identifier>
    <name>Modified Segment Group Name</name>
</SegmentGroupUpdate>
View more

file_copy 

                                {
    "SegmentGroupUpdate": {
        "identifier": "modified_segment_group_identifier",
        "name": "Modified Segment Group Name"
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/modified_segment_group_identifier">
    <id>4</id>
    <identifier>modified_segment_group_identifier</identifier>
    <name>Modified Segment Group Name</name>
</SegmentGroup>
View more

file_copy 

                                {
    "SegmentGroup": {
        "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
        "_href": "/api/ibexa/v2/segment_groups/modified_segment_group_identifier",
        "id": 3,
        "identifier": "modified_segment_group_identifier",
        "name": "Modified Segment Group Name"
    }
}
View more
Delete a segment group

DELETE /segment_groups/{identifier}

Deletes the segment group.

Possible responses
Code Description
204

Segment group deleted.
401

Error - the user is not authorized to delete segment groups.
404

Error - the identifier doesn't match any segment group.
Types
Type Description
ErrorMessage Represents an error response. Might contain additional properties depending on an error type.

/segment_groups/{identifier}/segments

List segment group's segments

GET /segment_groups/{identifier}/segments

Lists segment group's segments.

Header parameters

Accept

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

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

OK - list the group's segments.
401

Error - the user is not authorized to load this group's segments.
404

Error - the identifier doesn't match any segment group.
Types
Type Description
SegmentList This class lists segments.
SegmentListWrapper JSON object with only a SegmentList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SegmentList media-type="application/vnd.ibexa.api.SegmentList+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts/segments"/>
View more

file_copy 

                                {
    "SegmentList": {
        "_media-type": "application\/vnd.ibexa.api.SegmentList+json",
        "_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts\/segments",
        "Segment": []
    }
}
View more

Services

/services/countries

Countries list

GET /services/countries

Gives access to an ISO-3166 formatted list of world countries. It is useful when presenting a country options list from any application.

Header parameters

Accept

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

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

Types
Type Description
CountryList This class is representing an ISO-3166 formatted list of world countries.
CountryListWrapper JSON object with only a CountryList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<CountryList media-type="application/vnd.ibexa.api.CountryList+xml">
    <Country media-type="application/vnd.ibexa.api.Country+xml" id="AF">
        <name>Afghanistan</name>
        <Alpha2>AF</Alpha2>
        <Alpha3>AFG</Alpha3>
        <IDC>93</IDC>
    </Country>
    <Country media-type="application/vnd.ibexa.api.Country+xml" id="AX">
        <name>Åland</name>
        <Alpha2>AX</Alpha2>
        <Alpha3>ALA</Alpha3>
        <IDC>358</IDC>
    </Country>
    <Country media-type="application/vnd.ibexa.api.Country+xml" id="AL">
        <name>Albania</name>
        <Alpha2>AL</Alpha2>
        <Alpha3>ALB</Alpha3>
        <IDC>355</IDC>
    </Country>
    <Country media-type="application/vnd.ibexa.api.Country+xml" id="DZ">
        <name>Algeria</name>
        <Alpha2>DZ</Alpha2>
        <Alpha3>DZA</Alpha3>
        <IDC>213</IDC>
    </Country>
    <Country media-type="application/vnd.ibexa.api.Country+xml" id="AS">
        <name>American Samoa</
View more

Languages

/languages

Language list

GET /languages

Lists languages

Header parameters

Accept

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

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

Types
Type Description
LanguageList List of languages.
LanguageListWrapper JSON object with only a LanguageList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<LanguageList media-type="application/vnd.ibexa.api.LanguageList+xml" href="/api/ibexa/v2/languages">
 <Language media-type="application/vnd.ibexa.api.Language+xml" href="/api/ibexa/v2/languages/eng-GB">
  <languageId>2</languageId>
  <languageCode>eng-GB</languageCode>
  <name>English (United Kingdom)</name>
 </Language>
 <Language href="/api/ibexa/v2/languages/pol-PL" media-type="application/vnd.ibexa.api.Language+xml">
  <languageId>4</languageId>
  <languageCode>pol-PL</languageCode>
  <name>Polish (polski)</name>
 </Language>
</LanguageList>
View more

file_copy 

                                {
    "LanguageList": {
        "_media-type": "application/vnd.ibexa.api.LanguageList+json",
        "_href": "/api/ibexa/v2/languages",
        "Language": [
            {
                "_media-type": "application/vnd.ibexa.api.Language+json",
                "_href": "/api/ibexa/v2/languages/eng-GB",
                "languageId": 2,
                "languageCode": "eng-GB",
                "name": "English (United Kingdom)"
            }, {
                "_href": "/api/ibexa/v2/languages/pol-PL",
                "_media-type": "application/vnd.ibexa.api.Language+json",
                "languageCode": "pol-PL",
                "languageId": 4,
                "name": "Polish (polski)"
            }
        ]
    }
}
View more

/languages/{code}

Get language

GET /languages/{code}

Header parameters

Accept

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

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

Types
Type Description
Language This class represents a language in the Repository.
LanguageWrapper JSON object with only a Language property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Language media-type="application/vnd.ibexa.api.Language+xml" href="/api/ibexa/v2/languages/eng-GB">
 <languageId>2</languageId>
 <languageCode>eng-GB</languageCode>
 <name>English (United Kingdom)</name>
</Language>
View more

file_copy 

                                {
    "Language": {
        "_media-type": "application/vnd.ibexa.api.Language+json",
        "_href": "/api/ibexa/v2/languages/eng-GB",
        "languageId": 2,
        "languageCode": "eng-GB",
        "name": "English (United Kingdom)"
    }
}
View more

Managing Commerce carts

/cart

Create Cart

POST /cart

Creates Cart from payload.

Header parameters

Content-Type

The CartCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CartCreate+xml application/vnd.ibexa.api.CartCreate+json

Accept

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

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

400

Error - The input does not match the input schema definition.
Types
Type Description
CartCreate This class represents a new Cart to create
CartCreateWrapper JSON object with only a CartCreate property.
Cart This class represents a Cart
CartWrapper JSON object with only a Cart property.

file_copy 

                                <CartCreate>
    <name>Default</name>
    <currencyCode>EUR</currencyCode>
</CartCreate>
View more

file_copy 

                                {
    "CartCreate": {
        "name": "Default",
        "currencyCode": "EUR",
        "context": {
            "foo": "bar"
        }
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Cart media-type="application/vnd.ibexa.api.Cart+xml">
 <id>1</id>
 <identifier>e67d8f4c-95b5-423f-89d8-b2b81c37609b</identifier>
 <name>Default</name>
 <createdAt>2024-09-26T09:16:56+00:00</createdAt>
 <updatedAt>2024-09-26T09:16:56+00:00</updatedAt>
 <owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/>
 <Currency media-type="application/vnd.ibexa.api.Currency+xml">
  <id>2</id>
  <code>EUR</code>
  <subunits>2</subunits>
  <enabled>1</enabled>
 </Currency>
</Cart>
View more

file_copy 

                                {
    "Cart": {
        "_media-type": "application\/vnd.ibexa.api.Cart+json",
        "id": 1,
        "identifier": "e79b5dba-c701-4c64-8032-73719a513e50",
        "name": "Default",
        "createdAt": "2024-09-26T09:16:56+00:00",
        "updatedAt": "2024-09-26T09:16:56+00:00",
        "owner": {
            "_media-type": "application\/vnd.ibexa.api.User+json",
            "_href": "\/api\/ibexa\/v2\/user\/users\/10"
        },
        "Currency": {
            "_media-type": "application\/vnd.ibexa.api.Currency+json",
            "id": 2,
            "code": "EUR",
            "subunits": 2,
            "enabled": true
        },
        "entries": [],
        "context": {
            "foo": "bar"
        }
    }
}
View more

/cart/view

/cart/view

Filter carts

POST /cart/view

Executes a query and returns a View including the results.

Header parameters

Accept

The CartView schema is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CartView+xml application/vnd.ibexa.api.CartView+json

Content-Type

The CartViewInput schema is posted in XML or JSON format.

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

OK - returns a view and its results
Types
Type Description
CartViewInput This class represents a cart view input.
CartViewInputWrapper JSON object with only a CartViewInput property.
CartView This class represents a cart view.
CartViewWrapper JSON object with only a CartView property.

file_copy 

                                <CartViewInput>
    <identifier>loadUserCarts</identifier>
    <CartQuery>
        <offset>0</offset>
        <limit>10</limit>
        <ownerId>10</ownerId>
    </CartQuery>
</CartViewInput>
View more

file_copy 

                                {
    "CartViewInput": {
        "identifier": "loadUserCarts",
        "CartQuery": {
            "offset": 0,
            "limit": 10,
            "ownerId": 10
        }
    }
}
View more
Code: 200

file_copy 

                                {
    "CartView": {
        "_media-type": "application\/vnd.ibexa.api.CartView+json",
        "identifier": "loadUserCarts",
        "Result": {
            "_media-type": "application\/vnd.ibexa.api.ViewResult+json",
            "count": 1,
            "CartList": {
                "_media-type": "application\/vnd.ibexa.api.CartList+json",
                "Cart": [
                    {
                        "_media-type": "application\/vnd.ibexa.api.Cart+json",
                        "id": 1,
                        "identifier": "e79b5dba-c701-4c64-8032-73719a513e50",
                        "name": "Default",
                        "createdAt": "2024-09-26T09:16:56+00:00",
                        "updatedAt": "2024-09-26T09:16:56+00:00",
                        "owner": {
                            "_media-type": "application\/vnd.ibexa.api.User+json",
                            "_href": "\/api\/ibexa\/v2\/user\/users\/10"
                        },
                        "
View more

/cart/{identifier}

/cart/{identifier}

Get Cart

GET /cart/{identifier}

Gets Cart by its identifier.

Header parameters

Accept

The Cart is returned in XML or JSON format.

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

OK - return the cart
401

Error - the user is not authorized to get this cart.
404

Error - the identifier do not match any cart.
Types
Type Description
Cart This class represents a Cart
CartWrapper JSON object with only a Cart property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Cart media-type="application/vnd.ibexa.api.Cart+xml">
 <id>1</id>
 <identifier>e67d8f4c-95b5-423f-89d8-b2b81c37609b</identifier>
 <name>Default</name>
 <createdAt>2024-09-26T09:16:56+00:00</createdAt>
 <updatedAt>2024-09-26T09:16:56+00:00</updatedAt>
 <owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/>
 <Currency media-type="application/vnd.ibexa.api.Currency+xml">
  <id>2</id>
  <code>EUR</code>
  <subunits>2</subunits>
  <enabled>1</enabled>
 </Currency>
</Cart>
View more

file_copy 

                                {
    "Cart": {
        "_media-type": "application\/vnd.ibexa.api.Cart+json",
        "id": 1,
        "identifier": "e79b5dba-c701-4c64-8032-73719a513e50",
        "name": "Default",
        "createdAt": "2024-09-26T09:16:56+00:00",
        "updatedAt": "2024-09-26T09:16:56+00:00",
        "owner": {
            "_media-type": "application\/vnd.ibexa.api.User+json",
            "_href": "\/api\/ibexa\/v2\/user\/users\/10"
        },
        "Currency": {
            "_media-type": "application\/vnd.ibexa.api.Currency+json",
            "id": 2,
            "code": "EUR",
            "subunits": 2,
            "enabled": true
        },
        "entries": [],
        "context": {
            "foo": "bar"
        }
    }
}
View more
Delete Cart

DELETE /cart/{identifier}

Deletes Cart by its identifier.

Update Cart's metadata

PATCH /cart/{identifier}

Updates identified Cart's metadata from payload.

Header parameters

Content-Type

The CartMetadataUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CartMetadataUpdate+xml application/vnd.ibexa.api.CartMetadataUpdate+json

Accept

The updated Cart is returned in XML or JSON format.

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

OK - return the updated cart
400

Error - the input doesn't match the input schema definition.
401

Error - the user is not authorized to update this cart.
404

Error - the identifier doesn't match any cart.
Types
Type Description
CartMetadataUpdate This class represents the update of cart metadata.
CartMetadataUpdateWrapper JSON object with only a CartMetadataUpdate property.
Cart This class represents a Cart
CartWrapper JSON object with only a Cart property.

/cart/{identifier}/entry

Add Entry to Cart

POST /cart/{identifier}/entry

Adds an entry to the cart referenced by its identifier

Header parameters

Content-Type

The CartEntryAdd schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CartEntryAdd+xml application/vnd.ibexa.api.CartEntryAdd+json

Accept

The updated Cart is returned in XML or JSON format.

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

OK - return the updated cart
400

Error - the input doesn't match the input schema definition.
401

Error - the user is not authorized to add an entry to this cart.
404

Error - the identifier doesn't match any cart.
Types
Type Description
CartEntryAdd This class represents a cart entry
CartEntryAddWrapper JSON object with only a CartEntryAdd property.
Cart This class represents a Cart
CartWrapper JSON object with only a Cart property.

file_copy 

                                {
    "CartEntryAdd": {
        "quantity": 1,
        "Product": {
            "code": "test"
        },
        "context": {
            "foo": "bar"
        }
    }
}
View more

/cart/{identifier}/entry/{entryId}

Remove Entry from Cart

DELETE /cart/{identifier}/entry/{entryId}

Removes the given entry from the given Cart.

Header parameters

Accept

The updated Cart is returned in XML or JSON format.

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

OK - return the updated cart
401

Error - the user is not authorized to remove an entry from this cart.
404

Error - the identifiers don't match any cart or entry.
Types
Type Description
CartEntryUpdate
CartEntryUpdateWrapper JSON object with only a CartEntryUpdate property.
Cart This class represents a Cart
CartWrapper JSON object with only a Cart property.
Update Entry from Cart

PATCH /cart/{identifier}/entry/{entryId}

Updates the given entry from the given Cart.

Header parameters

Content-Type

The CartEntryUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CartEntryUpdate+xml application/vnd.ibexa.api.CartEntryUpdate+json

Accept

The updated Cart is returned in XML or JSON format.

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

OK - return the updated cart
400

Error - the input doesn't match the input schema definition.
401

Error - the user is not authorized to update an entry of this cart.
404

Error - the identifiers don't match any cart or entry.
Types
Type Description
CartEntryUpdate
CartEntryUpdateWrapper JSON object with only a CartEntryUpdate property.
Cart This class represents a Cart
CartWrapper JSON object with only a Cart property.

/cart/{identifier}/empty

Empty Cart

POST /cart/{identifier}/empty

Empties the given Cart.

Possible responses
Code Description
204

No Content - Cart emptied.
401

Error - The user is not authorized to empty this Cart.
404

Error - Cart not found.

/cart/{identifier}/summary

Cart Summary

GET /cart/{identifier}/summary

Gets a summary of the given Cart.

Header parameters

Accept

Use CartSummary only if you require additional product information (such as Product type or Content). Depending on the suffix set, the Cart Summary is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ShortCartSummary+json application/vnd.ibexa.api.ShortCartSummary+xml application/vnd.ibexa.api.CartSummary+json application/vnd.ibexa.api.CartSummary+xml
Possible responses
Code Description
200

401

Error - The user is not authorized to read this Cart.
404

Error - Cart not found.
Types
Type Description
CartSummaryWrapper JSON object with only a CartSummary property.
CartSummary This class represents a cart summary.
Code: 200

file_copy 

                                {
    "CartSummary": {
        "_media-type": "application\/vnd.ibexa.api.CartSummary+json",
        "_href": "\/api\/ibexa\/v2\/cart\/b0b51659-75f7-4c8d-9cea-5ce5865dd9ce\/summary",
        "id": 1,
        "identifier": "b0b51659-75f7-4c8d-9cea-5ce5865dd9ce",
        "name": "default",
        "createdAt": "2025-04-03T08:16:09+00:00",
        "updatedAt": "2025-04-03T08:16:09+00:00",
        "Owner": {
            "_media-type": "application\/vnd.ibexa.api.User+json",
            "_href": "\/api\/ibexa\/v2\/user\/users\/14"
        },
        "SummaryEntryCollection": {
            "_media-type": "application\/vnd.ibexa.api.SummaryEntryCollection+json",
            "count": "3",
            "SummaryEntry": [
                {
                    "_media-type": "application\/vnd.ibexa.api.CartSummaryEntry+json",
                    "identifier": "5ce5d7a7-fcc8-4d28-89ad-3f4a53b7ea9a",
                    "id": 1,
                    "names": {
                        "value": [
View more

file_copy 

                                {
    "CartSummary": {
        "_media-type": "application\/vnd.ibexa.api.CartSummary+json",
        "_href": "\/api\/ibexa\/v2\/cart\/b0b51659-75f7-4c8d-9cea-5ce5865dd9ce\/summary",
        "id": 1,
        "identifier": "b0b51659-75f7-4c8d-9cea-5ce5865dd9ce",
        "name": "default",
        "createdAt": "2025-04-03T08:16:09+00:00",
        "updatedAt": "2025-04-03T08:16:09+00:00",
        "Owner": {
            "_media-type": "application\/vnd.ibexa.api.User+json",
            "_href": "\/api\/ibexa\/v2\/user\/users\/14"
        },
        "SummaryEntryCollection": {
            "_media-type": "application\/vnd.ibexa.api.SummaryEntryCollection+json",
            "count": "3",
            "SummaryEntry": [
                {
                    "_media-type": "application\/vnd.ibexa.api.CartSummaryEntry+json",
                    "identifier": "5ce5d7a7-fcc8-4d28-89ad-3f4a53b7ea9a",
                    "id": 1,
                    "names": {
                        "value": [
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<CartSummary media-type="application/vnd.ibexa.api.CartSummary+xml" href="/api/ibexa/v2/cart/b0b51659-75f7-4c8d-9cea-5ce5865dd9ce/summary">
 <id>1</id>
 <identifier>b0b51659-75f7-4c8d-9cea-5ce5865dd9ce</identifier>
 <name>default</name>
 <createdAt>2025-04-03T08:16:09+00:00</createdAt>
 <updatedAt>2025-04-03T08:16:09+00:00</updatedAt>
 <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
 <SummaryEntryCollection media-type="application/vnd.ibexa.api.SummaryEntryCollection+xml">
  <count>3</count>
  <CartSummaryEntry media-type="application/vnd.ibexa.api.CartSummaryEntry+xml">
   <identifier>5ce5d7a7-fcc8-4d28-89ad-3f4a53b7ea9a</identifier>
   <id>1</id>
   <names>
    <value languageCode="eng-GB">Control unit 1|germany|none|physical</value>
   </names>
   <quantity>1</quantity>
   <Price media-type="application/vnd.ibexa.api.Price+xml">
    <RestPrice media-type="application/vnd.ibexa.api.RestPrice+xml">
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<CartSummary media-type="application/vnd.ibexa.api.CartSummary+xml" href="/api/ibexa/v2/cart/b0b51659-75f7-4c8d-9cea-5ce5865dd9ce/summary">
 <id>1</id>
 <identifier>b0b51659-75f7-4c8d-9cea-5ce5865dd9ce</identifier>
 <name>default</name>
 <createdAt>2025-04-03T08:16:09+00:00</createdAt>
 <updatedAt>2025-04-03T08:16:09+00:00</updatedAt>
 <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
 <SummaryEntryCollection media-type="application/vnd.ibexa.api.SummaryEntryCollection+xml">
  <count>3</count>
  <CartSummaryEntry media-type="application/vnd.ibexa.api.CartSummaryEntry+xml">
   <identifier>5ce5d7a7-fcc8-4d28-89ad-3f4a53b7ea9a</identifier>
   <id>1</id>
   <names>
    <value languageCode="eng-GB">Control unit 1|germany|none|physical</value>
   </names>
   <quantity>1</quantity>
   <Price media-type="application/vnd.ibexa.api.Price+xml">
    <RestPrice media-type="application/vnd.ibexa.api.RestPrice+xml">
View more

/cart/{identifier}/validate

Cart Validation

POST /cart/{identifier}/validate

Validates a Cart against constraints

Header parameters

Accept

If set, the Cart Constraint Violations are returned in XML or JSON format.

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

Types
Type Description
CartConstraintViolationList This class represents a list of cart constraint violations.
CartConstraintViolationListWrapper JSON object with only a CartConstraintViolationList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<CartConstraintViolationList media-type="application/vnd.ibexa.api.CartConstraintViolationList+xml"/>
View more

file_copy 

                                {
    "CartConstraintViolationList": {
        "_media-type": "application\/vnd.ibexa.api.CartConstraintViolationList+json",
        "violations": []
    }
}
View more

/cart/authorize

/cart/authorize

Cart Authorization

POST /cart/authorize

Returns the CSRF token required by anonymous user to interact with their own cart.

Header parameters

Accept

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

Types
Type Description
Token This class represents a CSRF token
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Token media-type="application/vnd.ibexa.api.Token+xml">
 <value>eff5.w9r2Ws_zpjcopNJ8FRNVaplGlx19y4Mp2QP-eQWZDKc.-pe4Pam133xKzKQZLCdiIMkj2EgQ5rMdtlGTEEPPaOyHv6Y1iKTsZ2_OtQ</value>
</Token>
View more

file_copy 

                                {
    "Token": {
        "_media-type": "application\/vnd.ibexa.api.Token+json",
        "value": "7b19308.RiDPaorwmJRyQoGajJiLMp843r30WaW-PH1CeH4oQyU.dkOXWOuFrvBfDPXY1t27YMx0hvyFH8fPUwoDNRl_D0sWDb4O3bb-20Q32A"
    }
}
View more

eCommerce API (removed)

/commerce/basket

/commerce/basket

Read list of baskets (removed)

GET /commerce/basket

Returns baskets for the current user. Only "storedBasket" and "wishList" types are handled. Others will return validation error. Removed as of Ibexa DXP 4.4.

Query parameters
Property Type Value
type string

Either "storedBasket" or "wishList". "storedBasket" is assumed if not passed.
Possible responses
Code Description
200

400

Types
Type Description
BasketListResponseWrapper JSON object with only a BasketListResponse property.
ValidationResponse Removed
Code: 200

file_copy 

                                {
  "BasketListResponse": {
    "_media-type": "application\/vnd.ibexa.api.BasketListResponse+json",
    "basketList": [
      {
        "_media-type": "application\/vnd.ibexa.api.stdClass+json",
        "basketId": 5,
        "state": "new",
        "type": "storedBasket",
        "sessionId": "mrt02u8u2rbh6aeeibm7rj0i1j",
        "userId": 14,
        "basketName": "test",
        "dateCreated": {
          "_media-type": "application\/vnd.ibexa.api.DateTime+json"
        },
        "dateLastModified": {
          "_media-type": "application\/vnd.ibexa.api.DateTime+json"
        },
        "totals": [
          {
            "_media-type": "application\/vnd.ibexa.api.BasketTotals+json"
          },
          {
            "_media-type": "application\/vnd.ibexa.api.BasketTotals+json"
          }
        ],
        "totalsSum": {
          "_media-type": "application\/vnd.ibexa.api.BasketTotals+json"
        },
        "dateLastPriceCalculation": {
          "_media-type": "application
View more

/commerce/basket/current

Get current basket (removed)

GET /commerce/basket/current

Returns a Basket instance for the current session. If there isn't one, a new one will be created. Removed as of Ibexa DXP 4.4.

Header parameters

Accept

Property Value
Type string
Examples application/vnd.ibexa.api.Basket+json
Possible responses
Code Description
200

Types
Type Description
BasketWrapper JSON object with only a Basket property.
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more

/commerce/basket/current/{basketId}

Copy basket to user session (removed)

COPY /commerce/basket/current/{basketId}

Adds basket lines into current basket in user session, if any, using basket stored in permanent storage. Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

400

Types
Type Description
BasketWrapper JSON object with only a Basket property.
ValidationResponseWrapper JSON object with only a ValidationResponse property.
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more
Code: 400

file_copy 

                                {
  "ValidationResponse": {
    "_media-type": "application\/vnd.ibexa.api.ValidationResponse+json",
    "messages": {
      "_error": [
        "Access denied"
      ]
    }
  }
}
View more

/commerce/basket/current/referencenumber

Save the external reference number in basket (removed)

PATCH /commerce/basket/current/referencenumber

Removed as of Ibexa DXP 4.4.

/commerce/basket/current/remark

Save the remark in basket (removed)

PATCH /commerce/basket/current/remark

Removed as of Ibexa DXP 4.4.

/commerce/basket/current/party/{partyType}

Update party information in the basket (removed)

PATCH /commerce/basket/current/party/{partyType}

Updates party (buyer, delivery, invoice) information in the basket. Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

400

Types
Type Description
PartyTypeInputWrapper JSON object with only a PartyData property.
BasketWrapper JSON object with only a Basket property.
ValidationResponseWrapper JSON object with only a ValidationResponse property.

file_copy 

                                {
  "PartyData": {
    "_data-type":"invoice",
    "_media-type":"application/vnd.ibexa.api.Party+json",
    "PartyIdentification":[],
    "PartyName":[
      {
        "_media-type":"application/vnd.ibexa.api.PartyPartyName+json",
        "Name":"Testerin"
      },
      {
        "_media-type":"application/vnd.ibexa.api.PartyPartyName+json",
        "Name":""
      }
    ],
    "PostalAddress":{
      "_media-type":"application/vnd.ibexa.api.PartyPostalAddress+json",
      "StreetName":"Teststr. 11",
      "AdditionalStreetName":"",
      "BuildingNumber":null,
      "CityName":"Testingen",
      "PostalZone":"1111",
      "CountrySubentity":"Dummy",
      "CountrySubentityCode":null,
      "AddressLine":[],
      "Country":{
        "_media-type":"application/vnd.ibexa.api.PartyPostalAddressCountry+json",
        "IdentificationCode":"NO",
        "Name":null
      },
      "Department":null,
      "SesExtension":{}
    },
    "Contact":{
      "_media-type":"application/vnd.ibexa.a
View more
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more

/commerce/basket/current/shippingmethod

Update shipping information in current basket (removed)

PATCH /commerce/basket/current/shippingmethod

Updates shipping information in the current basket. Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

400

Types
Type Description
ShippingMethodData Removed
BasketWrapper JSON object with only a Basket property.
ValidationResponseWrapper JSON object with only a ValidationResponse property.

file_copy 

                                {
  "ShippingMethodData": {
    "shippingMethod": "mail"
  }
}
View more
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more

/commerce/basket/current/paymentmethod

Update payment information in current basket (removed)

PATCH /commerce/basket/current/paymentmethod

Updates payment information in the current basket. Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

400

Types
Type Description
PaymentMethodDataWrapper JSON object with only a PaymentMethodData property.
BasketWrapper JSON object with only a Basket property.
ValidationResponseWrapper JSON object with only a ValidationResponse property.

file_copy 

                                {
  "PaymentMethodData": {
    "paymentMethod": "invoice"
  }
}
View more
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more

/commerce/basket/current/voucher

Update and check voucher in current basket (removed)

PATCH /commerce/basket/current/voucher

Updates and checks voucher in current basket. Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

400

Types
Type Description
VoucherDataWrapper JSON object with only a VoucherData property.
BasketWrapper JSON object with only a Basket property.
ValidationResponseWrapper JSON object with only a ValidationResponse property.

file_copy 

                                {
  "VoucherData": {
    "voucherCode": "1234567"
  }
}
View more
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more

/commerce/basket/current/line

Add products to current basket (removed)

POST /commerce/basket/current/line

Adds products to the current basket. Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

400

Types
Type Description
BasketLineDataWrapper JSON object with only a BasketLineData property.
BasketWrapper JSON object with only a Basket property.
ValidationResponseWrapper JSON object with only a ValidationResponse property.

file_copy 

                                {
  "BasketLineData": [
    {
      "sku":"1000",
      "quantity":"3",
      "isVariant":"0",
      "variantCode":""
    }
  ]
}
View more
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more
Code: 400

file_copy 

                                {
  "ValidationResponse": {
    "_media-type": "application\/vnd.ibexa.api.ValidationResponse+json",
    "messages": {
      "_error": [
        "Product with the sku: foo not found"
      ]
    }
  }
}
View more

/commerce/basket/{basketId}

Get Basket by ID (removed)

GET /commerce/basket/{basketId}

Gets basket by ID. Removed as of Ibexa DXP 4.4, use GET /cart/{identifier} instead

Possible responses
Code Description
200

Types
Type Description
BasketWrapper JSON object with only a Basket property.
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 7,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "storedBasket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": "sbnla08g8seeoua51v46jns3vc",
    "userId": 14,
    "basketName": "foo",
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 07:40:00"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 07:40:00"
    },
    "shop": null,
    "requirePriceUpdate": false,
    "totals": null,
    "totalsSum": null,
    "currency": null,
    "totalsSumNet": null,
    "totalsSumGross": null,
    "additionalLines": null,
    "lines": [],
    "dateLastPriceCalculation": null,
    "shippingMethod": null,
View more
Delete Basket by ID (removed)

DELETE /commerce/basket/{basketId}

Deletes basket by ID. Removed as of Ibexa DXP 4.4, use DELETE /cart/{identifier} instead.

Possible responses
Code Description
200

OK - The basket has been deleted
400

Error - The basket does not exist
403

Error - Access denied

/commerce/basket/{basketId}/name

Update the name of the stored basket (removed)

PATCH /commerce/basket/{basketId}/name

Updates the name of the stored basket. Removed as of Ibexa DXP 4.4, use PATCH /cart/{identifier} instead.

Possible responses
Code Description
200

Types
Type Description
BasketHeaderDataWrapper JSON object with only a BasketHeaderData property.
BasketWrapper JSON object with only a Basket property.

file_copy 

                                {
  "BasketHeaderData": {
    "value": "foobar"
  }
}
View more
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more

/commerce/basket/{basketId}/note

Update the note of the stored basket (removed)

PATCH /commerce/basket/{basketId}/note

Updates the note of the stored basket. Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

Types
Type Description
BasketHeaderDataWrapper JSON object with only a BasketHeaderData property.
BasketWrapper JSON object with only a Basket property.

file_copy 

                                {
  "BasketHeaderData": {
    "value": "foobar"
  }
}
View more
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more

/commerce/basket/{basketId}/line

Add products to stored basket (removed)

POST /commerce/basket/{basketId}/line

Adds products to the stored basket. Removed as of Ibexa DXP 4.4, use POST /cart/{identifier}/entry instead.

Possible responses
Code Description
200

400

Types
Type Description
BasketLineDataWrapper JSON object with only a BasketLineData property.
BasketWrapper JSON object with only a Basket property.
ValidationResponseWrapper JSON object with only a ValidationResponse property.

file_copy 

                                {
  "BasketLineData": [
    {
      "sku":"1000",
      "quantity":"3",
      "isVariant":"0",
      "variantCode":""
    }
  ]
}
View more
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more
Code: 400

file_copy 

                                {
  "ValidationResponse": {
    "_media-type": "application\/vnd.ibexa.api.ValidationResponse+json",
    "messages": {
      "_error": [
        "Product with the sku: foo not found"
      ]
    }
  }
}
View more

/commerce/basket/{basketId}/line/{lineId}

Delete a line from a stored basket (removed)

DELETE /commerce/basket/{basketId}/line/{lineId}

Removed as of Ibexa DXP 4.4, use DELETE /cart/{identifier}/entry/{entryId} instead.

Possible responses
Code Description
200

400

Types
Type Description
BasketWrapper JSON object with only a Basket property.
ValidationResponseWrapper JSON object with only a ValidationResponse property.
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more
Code: 400

file_copy 

                                {
  "ValidationResponse": {
    "_media-type": "application\/vnd.ibexa.api.ValidationResponse+json",
    "messages": {
      "_error": [
        "msg.invalid_basket_line_data"
      ]
    }
  }
}
View more

/commerce/basket/{basketName}

Create a new persisted basket (removed)

POST /commerce/basket/{basketName}

Creates a new persisted basket. Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

400

Types
Type Description
BasketWrapper JSON object with only a Basket property.
ValidationResponseWrapper JSON object with only a ValidationResponse property.
Code: 200

file_copy 

                                {
  "Basket": {
    "_media-type": "application\/vnd.ibexa.api.Basket+json",
    "basketId": 1,
    "originId": null,
    "erpOrderId": null,
    "guid": null,
    "state": "new",
    "type": "basket",
    "erpFailCounter": null,
    "erpFailErrorLog": null,
    "sessionId": null,
    "userId": 14,
    "basketName": null,
    "invoiceParty": null,
    "deliveryParty": null,
    "buyerParty": null,
    "remark": null,
    "dateCreated": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:33:26"
    },
    "dateLastModified": {
      "_media-type": "application\/vnd.ibexa.api.DateTime+json",
      "string": "2021-03-12 10:35:22"
    },
    "shop": "MAIN",
    "requirePriceUpdate": false,
    "totals": {
      "lines": {
        "_media-type": "application\/vnd.ibexa.api.BasketTotals+json",
        "name": "lines",
        "totalNet": 0,
        "totalGross": 0,
        "vatList": {
          "19": 0
        },
        "groupType": "order",
View more
Code: 400

file_copy 

                                {
  "ValidationResponse": {
    "_media-type": "application\/vnd.ibexa.api.ValidationResponse+json",
    "messages": {
      "_error": [
        "msg.duplicate_basket_name_not_allowed"
      ]
    }
  }
}
View more

/commerce/checkout

/commerce/checkout/paymentmethods

Get list of payment methods (removed)

GET /commerce/checkout/paymentmethods

Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

Types
Type Description
PaymentMethodDataResponseWrapper JSON object with only a PaymentMethodDataResponse property.
Code: 200

file_copy 

                                {
  "PaymentMethodDataResponse": {
    "_media-type": "application\/vnd.ibexa.api.PaymentMethodDataResponse+json",
    "paymentMethods": {
      "paypal": "paypal",
      "invoice": "invoice"
    },
    "defaultMethod": "invoice"
  }
}
View more

/commerce/checkout/shippingmethods

Get list of shipping methods (removed)

GET /commerce/checkout/shippingmethods

Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

Types
Type Description
ShippingMethodDataResponseWrapper JSON object with only a ShippingMethodDataResponse property.
Code: 200

file_copy 

                                {
  "ShippingMethodDataResponse": {
    "_media-type": "application\/vnd.ibexa.api.ShippingMethodDataResponse+json",
    "shippingMethods": {
      "standard": "standard",
      "expressDel": "express_delivery"
    },
    "defaultMethod": "standard",
    "shippingMethodsSorted": []
  }
}
View more

/commerce/customer/addresses/shipping

/commerce/customer/addresses/shipping

Get list of shipping addresses (removed)

GET /commerce/customer/addresses/shipping

Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

Types
Type Description
ShippingAddressesResponseWrapper JSON object with only a ShippingAddressesResponse property.
Code: 200

file_copy 

                                {
  "ShippingAddressesResponse": {
    "_media-type": "application\/vnd.ibexa.api.ShippingAddressesResponse+json",
    "Parties": [
      {
        "_media-type": "application\/vnd.ibexa.api.Party+json",
        "PartyIdentification": [],
        "PartyName": [],
        "PostalAddress": {
          "_media-type": "application\/vnd.ibexa.api.PartyPostalAddress+json",
          "StreetName": null,
          "AdditionalStreetName": null,
          "BuildingNumber": null,
          "CityName": null,
          "PostalZone": null,
          "CountrySubentity": null,
          "CountrySubentityCode": null,
          "AddressLine": [],
          "Country": {
            "_media-type": "application\/vnd.ibexa.api.PartyPostalAddressCountry+json",
            "IdentificationCode": null,
            "Name": null
          },
          "Department": null,
          "SesExtension": {}
        },
        "Contact": {
          "_media-type": "application\/vnd.ibexa.api.Contact+json",
          "ID":
View more

/commerce/customerprice

/commerce/customerprice

Get customer prices for products (removed)

POST /commerce/customerprice

Gets customer prices for the requested products. Removed as of Ibexa DXP 4.4.

Possible responses
Code Description
200

Types
Type Description
CustomerPriceDataWrapper
PriceResponseWrapper JSON object with only a PriceResponse property.

file_copy 

                                {
  "PriceResponse": {
    "_media-type": "application\/vnd.ibexa.api.PriceResponse+json",
    "priceResponse": {
      "_media-type": "application\/vnd.ibexa.api.priceResponse+json"
    }
  }
}
View more
Code: 200

file_copy 

                                {
  "PriceResponse": {
    "_media-type": "application\/vnd.ibexa.api.PriceResponse+json",
    "priceResponse": {
      "_media-type": "application\/vnd.ibexa.api.priceResponse+json"
    }
  }
}
View more

/commerce/common/check_sku_file/{mode}

/commerce/common/check_sku_file/{mode}

Add to basket from CSV or Excel (removed)

POST /commerce/common/check_sku_file/{mode}

Adds to basket a line from a CSV or Excel file. Removed as of Ibexa DXP 4.4.

/commerce/country

/commerce/country

Get list of countries (removed)

GET /commerce/country

Removed as of Ibexa DXP 4.4, use GET /services/countries instead.

Possible responses
Code Description
200

Types
Type Description
CountrySelectionResponseWrapper JSON object with only a CountrySelectionResponse property.
Code: 200

file_copy 

                                {
  "CountrySelectionResponse": {
    "_media-type": "application\/vnd.ibexa.api.CountrySelectionResponse+json",
    "countryOptions": {
      "DZ": "Algeria",
      "AU": "Australia",
      "AT": "Austria",
      "BE": "Belgium",
      "BR": "Brazil",
      "BG": "Bulgaria",
      "CA": "Canada",
      "CY": "Cyprus",
      "CZ": "Czechia",
      "DK": "Denmark",
      "EE": "Estonia",
      "SZ": "Eswatini",
      "FI": "Finland",
      "FR": "France",
      "DE": "Germany",
      "GR": "Greece",
      "HU": "Hungary",
      "IS": "Iceland",
      "IN": "India",
      "ID": "Indonesia",
      "IE": "Ireland",
      "IT": "Italy",
      "KE": "Kenya",
      "LV": "Latvia",
      "LT": "Lithuania",
      "MO": "Macao SAR China",
      "MY": "Malaysia",
      "MT": "Malta",
      "MX": "Mexico",
      "MZ": "Mozambique",
      "NL": "Netherlands",
      "NZ": "New Zealand",
      "NG": "Nigeria",
      "NO": "Norway",
      "PH": "Philippines",
      "PL": "Poland",
      "PT": "Portuga
View more

Orders

/orders/orders

/orders/orders

Create order

POST /orders/orders

Creates a new order.

Header parameters

Accept

If set, the new order is returned in JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.Order+json

Content-Type

The Order schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.OrderCreate+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 create this order.
406

Error - a order with this identifier already exists.
Types
Type Description
OrderCreateWrapper JSON object with only a OrderCreate property.
OrderWrapper JSON object with only a Order property.

file_copy 

                                {
    "OrderCreate": {
        "OrderUser": {
            "id": 14,
            "name": "Administrator",
            "email": "[email protected]"
        },
        "OrderCurrency": {
            "id": 1,
            "code": "EUR"
        },
        "OrderValue": {
            "vat": "10",
            "total_gross": "11",
            "total_net": "10"
        },
        "OrderCompany": {
            "id": 68,
            "name": "Apple"
        },
        "source": "local",
        "items": [
            {
                "OrderItem": {
                    "OrderItemValue": {
                        "unit_price_gross": "110",
                        "unit_price_net": "100",
                        "vat_rate": "10",
                        "subtotal_price_gross": "1100",
                        "subtotal_price_net": "1000"
                    },
                    "OrderItemProduct": {
                        "id": 1,
                        "code": "test",
                        "name":
View more
Code: 200

file_copy 

                                {
    "Order": {
        "_media-type": "application/vnd.ibexa.api.Order+json",
        "id": 2,
        "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898",
        "created": {
            "date": "2023-04-18 09:06:02.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "modified": {
            "date": "2023-04-18 09:06:02.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "status": "pending",
        "OrderUser": {
            "_media-type": "application/vnd.ibexa.api.OrderUser+json",
            "id": 14,
            "name": "Administrator",
            "email": "[email protected]"
        },
        "OrderCurrency": {
            "_media-type": "application/vnd.ibexa.api.OrderCurrency+json",
            "id": 1,
            "code": "EUR"
        },
        "OrderValue": {
            "_media-type": "application/vnd.ibexa.api.OrderValue+json",
            "vat": {
                "amount": "10",
                "c
View more
Load orders

GET /orders/orders

Loads a list of orders.

Header parameters

Accept

OrderList - If set, the orders list returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.OrderList+xml application/vnd.ibexa.api.OrderList+json
Query parameters
Property Type Value
offset integer

The offset of the result set.
limit integer

The number of orders returned.
Possible responses
Code Description
200

OK - loads orders.
401

Error - the user has no permission to read orders.
Types
Type Description
OrderList This class represents an orders list.
OrderListWrapper JSON object with only a OrderList property.
Code: 200

file_copy 

                                {
    "OrderList": {
        "_media-type": "application/vnd.ibexa.api.OrderList+json",
        "count": 10,
        "Order": [
            {
                "_media-type": "application/vnd.ibexa.api.Order+json",
                "id": 2,
                "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898",
                "created": {
                    "date": "2023-04-18 09:06:02.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "modified": {
                    "date": "2023-04-18 09:06:02.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "status": "pending",
                "OrderUser": {
                    "_media-type": "application/vnd.ibexa.api.OrderUser+json",
                    "id": 14,
                    "name": "Administrator",
                    "email": "[email protected]"
                },
                "OrderCurrency": {
View more

/orders/order

/orders/order/{identifier}

Load order by identifier

GET /orders/order/{identifier}

Loads an order by its identifier (UUID).

Header parameters

Accept

Order - If set, the order returned in XML or JSON format.

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

OK - loads the order.
401

Error - the user has no permission to read orders.
404

Error - the order does not exist.
Types
Type Description
Order This class represents order.
OrderWrapper JSON object with only a Order property.
Code: 200

file_copy 

                                {
    "Order": {
        "_media-type": "application/vnd.ibexa.api.Order+json",
        "id": 1,
        "identifier": "02ce9f94-e36b-4acf-92f7-eb93cda6af71",
        "created": {
            "date": "2023-10-18 06:24:00.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "modified": {
            "date": "2023-10-18 06:24:00.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "status": "pending",
        "source": "local_shop",
        "OrderUser": {
            "_media-type": "application/vnd.ibexa.api.OrderUser+json",
            "id": null,
            "name": "Anonymous User",
            "email": "[email protected]"
        },
        "OrderCurrency": {
            "_media-type": "application/vnd.ibexa.api.OrderCurrency+json",
            "id": 2,
            "code": "EUR"
        },
        "OrderValue": {
            "_media-type": "application/vnd.ibexa.api.OrderValue+json",
            "vat": {
View more

/orders/order/{identifier}/shipments

Load shipments

GET /orders/order/{identifier}/shipments

Loads a order's list of shipments.

Header parameters

Accept

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

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

OK - loads the shipments.
401

Error - the user has no permission to read order's shipment lists.
404

Error - the order does not exist.
Types
Type Description
ShipmentRefList This class represents a list of Shipments
ShipmentRefListWrapper JSON object with only a ShipmentRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ShipmentRefList media-type="application/vnd.ibexa.api.ShipmentRefList+xml" href="/api/ibexa/v2/shipments">
    <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/foo"/>
    <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/bar"/>
    <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/baz"/>
    <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/qux"/>
</ShipmentRefList>
View more

file_copy 

                                {
    "ShipmentRefList": {
        "_media-type": "application\/vnd.ibexa.api.ShipmentRefList+json",
        "_href": "\/api\/ibexa\/v2\/shipments",
        "shipmentRefList": [
            {
                "_media-type": "application\/vnd.ibexa.api.Shipment+json",
                "_href": "\/api\/ibexa\/v2\/shipments\/foo"
            },
            {
                "_media-type": "application\/vnd.ibexa.api.Shipment+json",
                "_href": "\/api\/ibexa\/v2\/shipments\/bar"
            },
            {
                "_media-type": "application\/vnd.ibexa.api.Shipment+json",
                "_href": "\/api\/ibexa\/v2\/shipments\/baz"
            },
            {
                "_media-type": "application\/vnd.ibexa.api.Shipment+json",
                "_href": "\/api\/ibexa\/v2\/shipments\/qux"
            }
        ]
    }
}
View more
Create shipment

POST /orders/order/{identifier}/shipments

Creates and adds a shipment to an order

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Shipment+xml application/vnd.ibexa.api.Shipment+json

Content-Type

The shipments schema encoded in XML or JSON format.

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

Shipment is created and returned
Types
Type Description
ShipmentCreate This class represents the creation of a shipment.
ShipmentCreateWrapper JSON object with only a ShipmentCreate property.
Shipment This class represents a single shipment.
ShipmentWrapper JSON object with only a Shipment property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8" ?>
<ShipmentCreate>
    <identifier>abc</identifier>
    <ShippingMethod media-type="application/vnd.ibexa.api.ShippingMethod+json" href="/api/ibexa/v2/shipping/methods/parcel_locker"/>
    <Amount>
        <value>1922</value>
        <currency>EUR</currency>
    </Amount>
    <Owner media-type="application/vnd.ibexa.api.User+json" href="/api/ibexa/v2/user/users/14"/>
    <Context>
        <key1>value1</key1>
        <key2>value2</key2>
    </Context>
</ShipmentCreate>
View more

file_copy 

                                {
  "ShipmentCreate": {
    "identifier": "abc",
    "ShippingMethod": {
      "_media-type": "application/vnd.ibexa.api.ShippingMethod+json",
      "_href": "/api/ibexa/v2/shipping/methods/parcel_locker"
    },
    "Amount": {
      "value": "1922",
      "currency": "EUR"
    },
    "Owner": {
      "_media-type": "application/vnd.ibexa.api.User+json",
      "_href": "/api/ibexa/v2/user/users/14"
    },
    "Context": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}
View more

/orders/order/{id}

Load order by ID

GET /orders/order/{id}

Loads an order by its numerical ID.

Header parameters

Accept

Order - If set, the order returned in XML or JSON format.

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

OK - loads the order.
401

Error - the user has no permission to read orders.
404

Error - the order does not exist.
Types
Type Description
Order This class represents order.
OrderWrapper JSON object with only a Order property.
Code: 200

file_copy 

                                {
    "Order": {
        "_media-type": "application/vnd.ibexa.api.Order+json",
        "id": 1,
        "identifier": "02ce9f94-e36b-4acf-92f7-eb93cda6af71",
        "created": {
            "date": "2023-10-18 06:24:00.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "modified": {
            "date": "2023-10-18 06:24:00.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "status": "pending",
        "source": "local_shop",
        "OrderUser": {
            "_media-type": "application/vnd.ibexa.api.OrderUser+json",
            "id": null,
            "name": "Anonymous User",
            "email": "[email protected]"
        },
        "OrderCurrency": {
            "_media-type": "application/vnd.ibexa.api.OrderCurrency+json",
            "id": 2,
            "code": "EUR"
        },
        "OrderValue": {
            "_media-type": "application/vnd.ibexa.api.OrderValue+json",
            "vat": {
View more
Update order

PATCH /orders/order/{id}

Updates an order.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Order+json

Content-Type

The OrderUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.OrderUpdate+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 order.
404

Error - the order with the given ID does not exist.
406

Error - the order cannot be cancelled due to not-allowed workflow transition
Types
Type Description
OrderUpdateWrapper JSON object with only a OrderUpdate property.
OrderWrapper JSON object with only a Order property.

file_copy 

                                {
    "OrderUpdate": {
        "status": "cancelled",
        "transition": "cancel"
    }
}
View more
Code: 200

file_copy 

                                {
    "Order": {
        "_media-type": "application/vnd.ibexa.api.Order+json",
        "id": 1,
        "identifier": "02ce9f94-e36b-4acf-92f7-eb93cda6af71",
        "created": {
            "date": "2023-10-18 06:24:00.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "modified": {
            "date": "2023-10-18 06:24:00.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "status": "pending",
        "source": "local_shop",
        "OrderUser": {
            "_media-type": "application/vnd.ibexa.api.OrderUser+json",
            "id": null,
            "name": "Anonymous User",
            "email": "[email protected]"
        },
        "OrderCurrency": {
            "_media-type": "application/vnd.ibexa.api.OrderCurrency+json",
            "id": 2,
            "code": "EUR"
        },
        "OrderValue": {
            "_media-type": "application/vnd.ibexa.api.OrderValue+json",
            "vat": {
View more

/orders/order/cancel/{id}

Cancel order

POST /orders/order/cancel/{id}

Cancels the given order.

Possible responses
Code Description
204

No content - the given order is cancelled.
401

Error - the user is not authorized to delete this order.
404

Error - the order with the given ID does not exist.
406

Error - the order cannot be cancelled due to not-allowed workflow transition

Payment methods

/payment-method

Create payment method

POST /payment-method

Header parameters

Accept

If set, the created Payment Method is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.PaymentMethod+xml application/vnd.ibexa.api.PaymentMethod+json

Content-Type

The Payment Method input schema encoded in XML or JSON.

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

OK
400

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

Error - the user is not authorized to create Payment Method.
404

Error - the payment methods does not exist.
Types
Type Description
PaymentMethodCreateStruct
PaymentMethodCreateStructWrapper JSON object with only a PaymentMethodCreateStruct property.
PaymentMethod
PaymentMethodWrapper JSON object with only a PaymentMethod property.

file_copy 

                                <PaymentMethodCreateStruct>
    <identifier>bank_transfer</identifier>
    <type>offline</type>
    <names>
        <eng-GB>Bank transfer</eng-GB>
    </names>
</PaymentMethodCreateStruct>
View more

file_copy 

                                {
  "PaymentMethodCreateStruct": {
    "identifier": "bank_transfer",
    "type": "offline",
    "names": {
      "eng-GB": "Bank Transfer"
    }
  }
}
View more
Code: 200

file_copy 

                                
{
  "PaymentMethod": {
    "_media-type": "application\/vnd.ibexa.api.PaymentMethod+json",
    "identifier": "bank_transfer",
    "id": 1,
    "enabled": true,
    "name": "Bank transfer",
    "description": "Bank transfer"
  }
}
View more

/payment-method/view

/payment-method/view

List payment methods

POST /payment-method/view

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

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.PaymentMethodView+xml application/vnd.ibexa.api.PaymentMethodView+json

Content-Type

The view input in XML or JSON format.

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

400

Error - the input does not match the input schema definition.
Types
Type Description
PaymentMethodViewInput
PaymentMethodViewInputWrapper JSON object with only a PaymentMethodViewInput property.
PaymentMethodView
PaymentMethodViewWrapper JSON object with only a PaymentMethodView property.

file_copy 

                                {
  "PaymentMethodViewInput": {
    "identifier": "example",
    "PaymentMethodQuery": {
      "offset": 0,
      "limit": 10
    }
  }
}
View more
Code: 200

file_copy 

                                {
  "PaymentMethodView": {
    "_media-type": "application\/vnd.ibexa.api.PaymentMethodView+json",
    "identifier": "example",
    "Result": {
      "_media-type": "application\/vnd.ibexa.api.ViewResult+json",
      "count": 4,
      "PaymentMethodList": [
        {
          "_media-type": "application\/vnd.ibexa.api.PaymentMethod+json",
          "identifier": "bank_transfer",
          "id": 1,
          "enabled": true,
          "name": "Bank transfer",
          "description": "Bank transfer"
        },
        {
          "_media-type": "application\/vnd.ibexa.api.PaymentMethod+json",
          "identifier": "cash_on_delivery",
          "id": 2,
          "enabled": true,
          "name": "Cash on delivery",
          "description": "Cash on delivery"
        },
        {
          "_media-type": "application\/vnd.ibexa.api.PaymentMethod+json",
          "identifier": "invoice",
          "id": 3,
          "enabled": true,
          "name": "Invoice",
          "description"
View more

/payment-method/{id}

/payment-method/{id}

Load payment method by id

GET /payment-method/{id}

Loads an payment method by its id.

Header parameters

Accept

Payment Method - If set, the payment method returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.PaymentMethod+json
Possible responses
Code Description
200

OK - loads the payment method.
401

Error - the user has no permission to read payment methods.
404

Error - the payment methods does not exist.
Types
Type Description
PaymentMethodWrapper JSON object with only a PaymentMethod property.
Code: 200

file_copy 

                                {
  "PaymentMethod": {
    "_media-type": "application\/vnd.ibexa.api.PaymentMethod+json",
    "identifier": "bank_transfer",
    "id": 1,
    "enabled": true,
    "name": "Bank transfer",
    "description": "Bank transfer"
  }
}
View more

/payment-method/{identifier}

/payment-method/{identifier}

Load payment method by identifier

GET /payment-method/{identifier}

Loads an payment method by its identifier.

Header parameters

Accept

Payment Method - If set, the payment method returned in XML or JSON format.

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

OK - loads the payment method.
401

Error - the user has no permission to read payment methods.
404

Error - the payment methods does not exist.
Types
Type Description
PaymentMethod
PaymentMethodWrapper JSON object with only a PaymentMethod property.
Code: 200

file_copy 

                                {
  "PaymentMethod": {
    "_media-type": "application\/vnd.ibexa.api.PaymentMethod+json",
    "identifier": "bank_transfer",
    "id": 1,
    "enabled": true,
    "name": "Bank transfer",
    "description": "Bank transfer"
  }
}
View more
Delete payment method

DELETE /payment-method/{identifier}

Possible responses
Code Description
204

No Content
401

Error - the user has no permission to delete payment methods.
404

Error - the payment methods does not exist.
Update payment method

PATCH /payment-method/{identifier}

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.PaymentMethod+xml application/vnd.ibexa.api.PaymentMethod+json

Content-Type

The Payment Method input schema encoded in XML or JSON.

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

OK
400

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

Error - the user is not authorized to update Payment Method.
404

Error - the payment methods does not exist.
Types
Type Description
PaymentMethodUpdateStruct
PaymentMethodUpdateStructWrapper JSON object with only a PaymentMethodUpdateStruct property.
PaymentMethod
PaymentMethodWrapper JSON object with only a PaymentMethod property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<PaymentMethodUpdateStruct>
    <names>
        <eng-GB>Bank transfer (updated)</eng-GB>
    </names>
</PaymentMethodUpdateStruct>
View more

file_copy 

                                {
  "PaymentMethodUpdateStruct": {
    "names": {
      "eng-GB": "Bank transfer (updated)"
    }
  }
}
View more
Code: 200

file_copy 

                                {
  "PaymentMethod": {
    "_media-type": "application\/vnd.ibexa.api.PaymentMethod+json",
    "identifier": "bank_transfer",
    "id": 1,
    "enabled": true,
    "name": "Bank transfer",
    "description": "Bank transfer"
  }
}
View more

Shipping methods

/shipping/methods

/shipping/methods

Load shipping methods

GET /shipping/methods

Loads shipping methods.

Header parameters

Accept

Shipping method reference - if set, the shipping method is returned in XML or JSON format.

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

OK - list the shipping methods.
401

Error - the user has no permission to read shipping methods.
Types
Type Description
ShippingMethodRefList This class represents a list of shipping methods
ShippingMethodRefListWrapper JSON object with only a ShippingMethodRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ShippingMethodRefList media-type="application/vnd.ibexa.api.ShippingMethodRefList+xml" href="/api/ibexa/v2/shipping/methods">
    <ShippingMethodRef media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_delivery"/>
    <ShippingMethodRef media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker_delivery"/>
</ShippingMethodRefList>
View more

file_copy 

                                {
    "ShippingMethodRefList": {
        "_media-type": "application\/vnd.ibexa.api.ShippingMethodRefList+json",
        "_href": "\/api\/ibexa\/v2\/shipping\/methods",
        "ShippingMethodRefs": [
            {
                "_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
                "_href": "\/api\/ibexa\/v2\/shipping\/methods\/parcel_delivery"
            },
            {
                "_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
                "_href": "\/api\/ibexa\/v2\/shipping\/methods\/parcel_locker_delivery"
            }
        ]
    }
}
View more

/shipping/methods/{identifier}

Load shipping method based on its identifier

GET /shipping/methods/{identifier}

Loads shipping method based on its identifier.

Header parameters

Accept

Shipping method - if set, the shipping method is returned in XML or JSON format.

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

OK - loads the shipping method.
401

Error - the user has no permission to read shipping methods.
404

Error - the shipping method does not exist.
Types
Type Description
ShippingMethod This class represents a shipping method.
ShippingMethodWrapper JSON object with only a ShippingMethod property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ShippingMethod media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/method1">
    <identifier>method1</identifier>
    <name>AmE Method 1</name>
    <names>
        <value languageCode="eng-US">AmE Method 1</value>
        <value languageCode="eng-GB">BrE Method 1</value>
    </names>
    <description>AmE Description of Method 1</description>
    <descriptions>
        <value languageCode="eng-US">AmE Description of Method 1</value>
        <value languageCode="eng-GB">BrE Description of Method 1</value>
    </descriptions>
    <enabled>true</enabled>
    <options>
        <value key="price">20.0000</value>
        <value key="currency">EUR</value>
    </options>
    <regions>
        <RegionRef media-type="application/vnd.ibexa.api.Region+xml" href="/api/ibexa/v2/product/catalog/regions/default"/>
    </regions>
    <type media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/s
View more

file_copy 

                                {
    "ShippingMethod": {
        "_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
        "_href": "\/api\/ibexa\/v2\/shipping\/methods\/method1",
        "identifier": "method1",
        "name": "AmE Method 1",
        "names": {
            "value": [
                {
                    "_languageCode": "eng-US",
                    "#text": "AmE Method 1"
                },
                {
                    "_languageCode": "eng-GB",
                    "#text": "BrE Method 1"
                }
            ]
        },
        "description": "AmE Description of Method 1",
        "descriptions": {
            "value": [
                {
                    "_languageCode": "eng-US",
                    "#text": "AmE Description of Method 1"
                },
                {
                    "_languageCode": "eng-GB",
                    "#text": "BrE Description of Method 1"
                }
            ]
        },
        "enabled": true,
        "op
View more

/shipping/method-types

/shipping/method-types

Load shipping methods types

GET /shipping/method-types

Loads shipping methods types.

Header parameters

Accept

Shipping method type reference - if set, the shipping method is returned in XML or JSON format.

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

OK - loads the shipping method.
401

Error - the user has no permission to read shipping methods types.
404

Error - the shipping method type does not exist.
Types
Type Description
ShippingMethodTypesList This class represents a list of shipping method types.
ShippingMethodTypesListWrapper JSON object with only a ShippingMethodTypesList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ShippingMethodTypesList media-type="application/vnd.ibexa.api.ShippingMethodTypesList+xml" href="/api/ibexa/v2/shipping/method-types">
    <ShippingMethodType media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/flat_rate">
        <identifier>flat_rate</identifier>
        <name>Flat rate</name>
    </ShippingMethodType>
    <ShippingMethodType media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/free">
        <identifier>free</identifier>
        <name>Free shipping</name>
    </ShippingMethodType>
</ShippingMethodTypesList>
View more

file_copy 

                                {
    "ShippingMethodTypesList": {
        "_media-type": "application\/vnd.ibexa.api.ShippingMethodTypesList+json",
        "_href": "\/api\/ibexa\/v2\/shipping\/method-types",
        "ShippingMethodTypes": [
            {
                "_media-type": "application\/vnd.ibexa.api.ShippingMethodType+json",
                "_href": "\/api\/ibexa\/v2\/shipping\/method-types\/flat_rate",
                "identifier": "flat_rate",
                "name": "Flat rate"
            },
            {
                "_media-type": "application\/vnd.ibexa.api.ShippingMethodType+json",
                "_href": "\/api\/ibexa\/v2\/shipping\/method-types\/free",
                "identifier": "free",
                "name": "Free shipping"
            }
        ]
    }
}
View more

/shipping/method-types/{identifier}

Load shipping method type based on its identifier

GET /shipping/method-types/{identifier}

Loads shipping methods type based on their identifiers.

Header parameters

Accept

Shipping method type - if set, the shipping method is returned in XML or JSON format.

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

OK - loads the shipping method.
401

Error - the user has no permission to read shipping methods.
404

Error - the shipping method type does not exist.
Types
Type Description
ShippingMethodType This class represents a shipping method type.
ShippingMethodTypeWrapper JSON object with only a ShippingMethodType property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ShippingMethodType media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/flat_rate">
    <identifier>flat_rate</identifier>
    <name>Flat rate</name>
</ShippingMethodType>
View more

file_copy 

                                {
	"ShippingMethodType": {
		"_media-type": "application\/vnd.ibexa.api.ShippingMethodType+json",
		"_href": "\/api\/ibexa\/v2\/shipping\/method-types\/flat_rate",
		"identifier": "flat_rate",
		"name": "Flat rate"
	}
}
View more

Shipments

/shipments

Load shipments

GET /shipments

Loads a list of shipments.

Header parameters

Accept

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

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

OK - loads the shipments.
401

Error - the user has no permission to read shipment lists.
404

Error - the shipment does not exist.
Types
Type Description
ShipmentRefList This class represents a list of Shipments
ShipmentRefListWrapper JSON object with only a ShipmentRefList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ShipmentRefList media-type="application/vnd.ibexa.api.ShipmentRefList+xml" href="/api/ibexa/v2/shipments">
    <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/foo"/>
    <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/bar"/>
    <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/baz"/>
    <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/qux"/>
</ShipmentRefList>
View more

file_copy 

                                {
    "ShipmentRefList": {
        "_media-type": "application\/vnd.ibexa.api.ShipmentRefList+json",
        "_href": "\/api\/ibexa\/v2\/shipments",
        "shipmentRefList": [
            {
                "_media-type": "application\/vnd.ibexa.api.Shipment+json",
                "_href": "\/api\/ibexa\/v2\/shipments\/foo"
            },
            {
                "_media-type": "application\/vnd.ibexa.api.Shipment+json",
                "_href": "\/api\/ibexa\/v2\/shipments\/bar"
            },
            {
                "_media-type": "application\/vnd.ibexa.api.Shipment+json",
                "_href": "\/api\/ibexa\/v2\/shipments\/baz"
            },
            {
                "_media-type": "application\/vnd.ibexa.api.Shipment+json",
                "_href": "\/api\/ibexa\/v2\/shipments\/qux"
            }
        ]
    }
}
View more

/shipments/{identifier}

Load a single shipment based on its identifier

GET /shipments/{identifier}

Loads a single shipment based on its identifier.

Header parameters

Accept

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

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

OK - loads the shipment.
401

Error - the user has no permission to read shipments.
404

Error - the shipment does not exist.
Types
Type Description
Shipment This class represents a single shipment.
ShipmentWrapper JSON object with only a Shipment property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Shipment media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/ae741491-e80c-49f2-8a44-5163b4afa144">
    <id>1</id>
    <identifier>ae741491-e80c-49f2-8a44-5163b4afa144</identifier>
    <status>pending</status>
    <transitions>
        <transition>prepare</transition>
        <transition>cancel</transition>
    </transitions>
    <Order media-type="application/vnd.ibexa.api.Order+xml" href="/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f"/>
    <Amount>
        <value>2257</value>
        <currency>EUR</currency>
    </Amount>
    <createdAt>2023-06-26T15:40:28+02:00</createdAt>
    <updatedAt>2023-06-26T15:40:28+02:00</updatedAt>
    <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Method media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker_delivery"/>
</Shipment>
View more

file_copy 

                                {
  "Shipment": {
    "_media-type": "application\/vnd.ibexa.api.Shipment+json",
    "_href": "\/api\/ibexa\/v2\/shipments\/ae741491-e80c-49f2-8a44-5163b4afa144",
    "id": 1,
    "identifier": "ae741491-e80c-49f2-8a44-5163b4afa144",
    "status": "pending",
    "transitions": {
      "transitionList": [
        "prepare",
        "cancel"
      ]
    },
    "Order": {
      "_media-type": "application\/vnd.ibexa.api.Order+json",
      "_href": "\/api\/ibexa\/v2\/orders\/order\/33f6db52-478f-41f1-afbe-6d38f6a4704f"
    },
    "Amount": {
      "value": "2257",
      "currency": "EUR"
    },
    "createdAt": "2023-06-26T15:40:28+02:00",
    "updatedAt": "2023-06-26T15:40:28+02:00",
    "Owner": {
      "_media-type": "application\/vnd.ibexa.api.User+json",
      "_href": "\/api\/ibexa\/v2\/user\/users\/14"
    },
    "Method": {
      "_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
      "_href": "\/api\/ibexa\/v2\/shipping\/methods\/parcel_locker_delivery"
    }
  }
}
View more
Update shipment

PATCH /shipments/{identifier}

Updates a shipment.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Shipment+xml application/vnd.ibexa.api.Shipment+json

Content-Type

The ShipmentUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ShipmentUpdate+xml application/vnd.ibexa.api.ShipmentUpdate+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 shipment.
404

Error - the shipment with the given ID does not exist.
406

Error - the shipment cannot be cancelled due to not-allowed workflow transition
Types
Type Description
ShipmentUpdate This class represents the update of a shipment.
ShipmentUpdateWrapper JSON object with only a ShipmentUpdate property.
Shipment This class represents a single shipment.
ShipmentWrapper JSON object with only a Shipment property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8" ?>
<ShipmentUpdate>
    <identifier>new_identifier</identifier>
    <transition>prepare</transition>
    <Owner media-type='application/vnd.ibexa.api.User+json' href='/api/ibexa/v2/user/users/14'/>
    <Context>
        <item1>value1</item1>
        <item2>value2</item2>
    </Context>
</ShipmentUpdate>
View more

file_copy 

                                {
    "ShipmentUpdate": {
        "identifier": "new_identifier",
        "transition": "prepare",
        "Owner": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "Context": {
            "item1": "value1",
            "item2": "value2"
        }
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Shipment media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/new_identifier">
    <id>1</id>
    <identifier>new_identifier</identifier>
    <status>prepared</status>
    <transitions>
        <transition>send-to-carrier</transition>
        <transition>cancel</transition>
    </transitions>
    <Order media-type="application/vnd.ibexa.api.Order+xml" href="/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f"/>
    <Amount>
        <value>2257</value>
        <currency>EUR</currency>
    </Amount>
    <createdAt>2023-06-26T15:40:28+02:00</createdAt>
    <updatedAt>2023-06-26T15:40:28+02:00</updatedAt>
    <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
    <Method media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker_delivery"/>
</Shipment>
View more

file_copy 

                                {
  "Shipment": {
    "_media-type": "application\/vnd.ibexa.api.Shipment+json",
    "_href": "\/api\/ibexa\/v2\/shipments\/new_identifier",
    "id": 1,
    "identifier": "new_identifier",
    "status": "prepared",
    "transitions": {
      "transitionList": [
        "send-to-carrier",
        "cancel"
      ]
    },
    "Order": {
      "_media-type": "application\/vnd.ibexa.api.Order+json",
      "_href": "\/api\/ibexa\/v2\/orders\/order\/33f6db52-478f-41f1-afbe-6d38f6a4704f"
    },
    "Amount": {
      "value": "2257",
      "currency": "EUR"
    },
    "createdAt": "2023-06-26T15:40:28+02:00",
    "updatedAt": "2023-06-26T15:40:28+02:00",
    "Owner": {
      "_media-type": "application\/vnd.ibexa.api.User+json",
      "_href": "\/api\/ibexa\/v2\/user\/users\/14"
    },
    "Method": {
      "_media-type": "application\/vnd.ibexa.api.ShippingMethod+json",
      "_href": "\/api\/ibexa\/v2\/shipping\/methods\/parcel_locker_delivery"
    }
  }
}
View more
Delete shipment

DELETE /shipments/{identifier}

Deletes a shipment.

Possible responses
Code Description
204

No content - shipment is deleted.
401

Error - the user is not authorized to delete this shipment.
404

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

Corporate Account

/corporate

Root Resource

GET /corporate

Provides basic information about Corporate Account endpoints and configuration.

Header parameters

Accept

If set, helps to determine response format.

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

List of Link objects to specific Corporate Account REST resources
Types
Type Description
CorporateAccountRoot This class represents Corporate Account Root resource information.
CorporateAccountRootWrapper JSON object with only a CorporateAccountRoot property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<CorporateAccountRoot media-type="application/vnd.ibexa.api.CorporateAccountRoot+xml">
  <link media-type="application/vnd.ibexa.api.CompaniesList+xml" rel="ca-companies" href="/api/ibexa/v2/corporate/companies"/>
  <link media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" rel="ca-types" href="/api/ibexa/v2/content/typegroups?identifier=corporate_account"/>
  <link media-type="application/vnd.ibexa.api.ContentType+xml" rel="ca-types-company" href="/api/ibexa/v2/content/types/48"/>
  <link media-type="application/vnd.ibexa.api.ContentType+xml" rel="ca-types-member" href="/api/ibexa/v2/content/types/47"/>
  <link media-type="application/vnd.ibexa.api.ContentType+xml" rel="ca-types-address" href="/api/ibexa/v2/content/types/49"/>
  <link media-type="application/vnd.ibexa.api.SalesRepresentativesList+xml" rel="ca-sales-representatives" href="/api/ibexa/v2/corporate/sales-representatives"/>
  <link media-type="application/vnd.ibexa.api.Role+xml
View more

file_copy 

                                {
  "CorporateAccountRoot": {
    "_media-type": "application\/vnd.ibexa.api.CorporateAccountRoot+json",
    "links": [
      {
        "_media-type": "application\/vnd.ibexa.api.CompaniesList+json",
        "_rel": "ca-companies",
        "_href": "\/api\/ibexa\/v2\/corporate\/companies"
      },
      {
        "_media-type": "application\/vnd.ibexa.api.ContentTypeGroup+json",
        "_rel": "ca-types",
        "_href": "\/api\/ibexa\/v2\/content\/typegroups?identifier=corporate_account"
      },
      {
        "_media-type": "application\/vnd.ibexa.api.ContentType+json",
        "_rel": "ca-types-company",
        "_href": "\/api\/ibexa\/v2\/content\/types\/48"
      },
      {
        "_media-type": "application\/vnd.ibexa.api.ContentType+json",
        "_rel": "ca-types-member",
        "_href": "\/api\/ibexa\/v2\/content\/types\/47"
      },
      {
        "_media-type": "application\/vnd.ibexa.api.ContentType+json",
        "_rel": "ca-types-address",
        "_href": "\/api\
View more

/corporate/companies

/corporate/companies

Read list of companies

GET /corporate/companies

Returns paginated list of available companies.

Header parameters

Accept

If set, helps to determine response format.

Property Value
Type string
Examples application/vnd.ibexa.api.CompanyList+xml application/vnd.ibexa.api.CompanyList+json
Query parameters
Property Type Value
filter string

An array-shaped string representing filtering Criterion. Supported Criteria:

Criterion Example
Creation date filter[DateMetadataCriterion][Target]=created&filter[DateMetadataCriterion][Value]=1679493636&filter[DateMetadataCriterion][Operator]=gte
Updated date filter[DateMetadataCriterion][Target]=modified&filter[DateMetadataCriterion][Value]=1679493636&filter[DateMetadataCriterion][Operator]=gte
Company Name filter[CompanyNameCriterion][Operator]=contains&filter[CompanyNameCriterion][Value]=Ibexa
salesRep (id) filter[Field][name]=sales_rep&filter[Field][operator]=eq&filter[Field][value]=122
contact (id) filter[Field][name]=contact&filter[Field][operator]=eq&filter[Field][value]=74
sort string

An array-shaped string representing sorting clauses. Supported Clauses:

Clause Example
By Content (Company) name sort[ContentName]=ascending
By publication date sort[DatePublished]=descending
By modification date sort[DateModified]=ascending
offset integer

The offset of the result set.
limit integer

The number of returned companies.
Possible responses
Code Description
200

Company list containing Company objects.
400

Returned when invalid Criterion or Sort clause is used
Types
Type Description
CompanyList This class represents a list of companies.
CompanyListWrapper JSON object with only a CompanyList property.
ErrorMessage Represents an error response. Might contain additional properties depending on an error type.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<CompanyList media-type="application/vnd.ibexa.api.CompanyList+xml">
  <Company media-type="application/vnd.ibexa.api.Company+xml">
    <id>66</id>
    <name>Ibexa AS</name>
    <Content media-type="application/vnd.ibexa.api.Content+xml"
             href="/api/ibexa/v2/content/objects/66" remoteId="9f20fb03d0ab0a6aef9930f7e6720377"
             id="66">
      <ContentType media-type="application/vnd.ibexa.api.ContentType+xml"
                   href="/api/ibexa/v2/content/types/48"/>
      <Name>Ibexa AS</Name>
      <TranslatedName>Ibexa AS</TranslatedName>
      <Versions media-type="application/vnd.ibexa.api.VersionList+xml"
                href="/api/ibexa/v2/content/objects/66/versions"/>
      <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml"
                      href="/api/ibexa/v2/content/objects/66/currentversion">
        <Version media-type="application/vnd.ibexa.api.Version+xml"
                 href="/api/ibexa/v2/c
View more

file_copy 

                                {
    "CompanyList": {
        "_media-type": "application\/vnd.ibexa.api.CompanyList+json",
        "companies": [
            {
                "_media-type": "application\/vnd.ibexa.api.Company+json",
                "id": 66,
                "name": "Ibexa AS",
                "Content": {
                    "_media-type": "application\/vnd.ibexa.api.Content+json",
                    "_href": "\/api\/ibexa\/v2\/content\/objects\/66",
                    "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377",
                    "_id": 66,
                    "ContentType": {
                        "_media-type": "application\/vnd.ibexa.api.ContentType+json",
                        "_href": "\/api\/ibexa\/v2\/content\/types\/48"
                    },
                    "Name": "Ibexa AS",
                    "TranslatedName": "Ibexa AS",
                    "Versions": {
                        "_media-type": "application\/vnd.ibexa.api.VersionList+json",
                        "_hr
View more
Create a company

POST /corporate/companies

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Company+xml application/vnd.ibexa.api.Company+json

Content-Type

The CompanyCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CompanyCreate+json application/vnd.ibexa.api.CompanyCreate+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 Company.
Types
Type Description
CompanyCreate This class is used to create a company.
CompanyCreateWrapper JSON object with only a CompanyCreate property.
Company This class represents a company.
CompanyWrapper JSON object with only a Company property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<CompanyCreate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <User/>
  <fields>
    <field>
      <fieldDefinitionIdentifier>active</fieldDefinitionIdentifier>
      <fieldValue>true</fieldValue>
    </field>
    <field>
      <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>
      <fieldValue>Ibexa Sp. z o. o.</fieldValue>
    </field>
    <field>
      <fieldDefinitionIdentifier>vat</fieldDefinitionIdentifier>
      <fieldValue>123 456 789</fieldValue>
    </field>
    <field>
      <fieldDefinitionIdentifier>website</fieldDefinitionIdentifier>
      <fieldValue>https://ibexa.co</fieldValue>
    </field>
    <field>
      <fieldDefinitionIdentifier>customer_group</fieldDefinitionIdentifier>
      <fieldValue>
        <value key="customer_group_id">1</value>
      </fieldValue>
    </field>
    <field>
      <fieldDefinitionIdentifier>sales_rep</fieldDefinitionIdentifier>
      <fieldValue>
        <value key="destinationCont
View more

file_copy 

                                {
    "CompanyCreate": {
        "fields": {
            "field": [
                {
                    "fieldDefinitionIdentifier": "active",
                    "fieldValue": true
                },
                {
                    "fieldDefinitionIdentifier": "name",
                    "fieldValue": "Ibexa Sp. z o. o."
                },
                {
                    "fieldDefinitionIdentifier": "vat",
                    "fieldValue": "123 456 789"
                },
                {
                    "fieldDefinitionIdentifier": "website",
                    "fieldValue": "https://ibexa.co"
                },
                {
                    "fieldDefinitionIdentifier": "customer_group",
                    "fieldValue": {
                        "customer_group_id": 1
                    }
                },
                {
                    "fieldDefinitionIdentifier": "sales_rep",
                    "fieldValue": {
                        "destinat
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Company media-type="application/vnd.ibexa.api.Company+xml">
  <id>66</id>
  <name>Ibexa AS</name>
  <Content media-type="application/vnd.ibexa.api.Content+xml"
           href="/api/ibexa/v2/content/objects/66" remoteId="9f20fb03d0ab0a6aef9930f7e6720377"
           id="66">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml"
                 href="/api/ibexa/v2/content/types/48"/>
    <Name>Ibexa AS</Name>
    <TranslatedName>Ibexa AS</TranslatedName>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml"
              href="/api/ibexa/v2/content/objects/66/versions"/>
    <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml"
                    href="/api/ibexa/v2/content/objects/66/currentversion">
      <Version media-type="application/vnd.ibexa.api.Version+xml"
               href="/api/ibexa/v2/content/objects/66/versions/1">
        <VersionInfo>
          <id>593</id>
          <versionNo>1</v
View more

file_copy 

                                {
    "Company": {
        "_media-type": "application\/vnd.ibexa.api.Company+json",
        "id": 66,
        "name": "Ibexa AS",
        "Content": {
            "_media-type": "application\/vnd.ibexa.api.Content+json",
            "_href": "\/api\/ibexa\/v2\/content\/objects\/66",
            "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377",
            "_id": 66,
            "ContentType": {
                "_media-type": "application\/vnd.ibexa.api.ContentType+json",
                "_href": "\/api\/ibexa\/v2\/content\/types\/48"
            },
            "Name": "Ibexa AS",
            "TranslatedName": "Ibexa AS",
            "Versions": {
                "_media-type": "application\/vnd.ibexa.api.VersionList+json",
                "_href": "\/api\/ibexa\/v2\/content\/objects\/66\/versions"
            },
            "CurrentVersion": {
                "_media-type": "application\/vnd.ibexa.api.Version+json",
                "_href": "\/api\/ibexa\/v2\/content\/objects\/66\/curr
View more

/corporate/companies/{companyId}

Get company

GET /corporate/companies/{companyId}

Returns the company by given company ID.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Company+xml application/vnd.ibexa.api.Company+json

If-None-match

ETag

Property Value
Type string
Possible responses
Code Description
200

401

Error - The user is not authorized to read this company.
404

Error - The company does not exist.
Types
Type Description
CompanyWrapper JSON object with only a Company property.
Company This class represents a company.
Code: 200

file_copy 

                                {
    "Company": {
        "_media-type": "application\/vnd.ibexa.api.Company+json",
        "id": 66,
        "name": "Ibexa AS",
        "Content": {
            "_media-type": "application\/vnd.ibexa.api.Content+json",
            "_href": "\/api\/ibexa\/v2\/content\/objects\/66",
            "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377",
            "_id": 66,
            "ContentType": {
                "_media-type": "application\/vnd.ibexa.api.ContentType+json",
                "_href": "\/api\/ibexa\/v2\/content\/types\/48"
            },
            "Name": "Ibexa AS",
            "TranslatedName": "Ibexa AS",
            "Versions": {
                "_media-type": "application\/vnd.ibexa.api.VersionList+json",
                "_href": "\/api\/ibexa\/v2\/content\/objects\/66\/versions"
            },
            "CurrentVersion": {
                "_media-type": "application\/vnd.ibexa.api.Version+json",
                "_href": "\/api\/ibexa\/v2\/content\/objects\/66\/curr
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Company media-type="application/vnd.ibexa.api.Company+xml">
  <id>66</id>
  <name>Ibexa AS</name>
  <Content media-type="application/vnd.ibexa.api.Content+xml"
           href="/api/ibexa/v2/content/objects/66" remoteId="9f20fb03d0ab0a6aef9930f7e6720377"
           id="66">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml"
                 href="/api/ibexa/v2/content/types/48"/>
    <Name>Ibexa AS</Name>
    <TranslatedName>Ibexa AS</TranslatedName>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml"
              href="/api/ibexa/v2/content/objects/66/versions"/>
    <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml"
                    href="/api/ibexa/v2/content/objects/66/currentversion">
      <Version media-type="application/vnd.ibexa.api.Version+xml"
               href="/api/ibexa/v2/content/objects/66/versions/1">
        <VersionInfo>
          <id>593</id>
          <versionNo>1</v
View more
Delete company

DELETE /corporate/companies/{companyId}

The given company is deleted.

Header parameters

Accept

If set, in the case of an error the error message is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ErrorMessage+xml application/vnd.ibexa.api.ErrorMessage+json

X-CSRF-Token

Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

Property Value
Type string
Possible responses
Code Description
204

No Content - given company is deleted.
401

Error - the user is not authorized to delete this company.
404

Error - the company does not exist.
Update a company

PATCH /corporate/companies/{companyId}

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

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Company+xml application/vnd.ibexa.api.Company+json

Content-Type

The company input schema encoded in XML or JSON.

Property Value
Type string
Examples application/vnd.ibexa.api.CompanyUpdate+xml application/vnd.ibexa.api.CompanyUpdate+json

If-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - company updated.
400

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

Error - the user is not authorized to create this company.
Types
Type Description
CompanyUpdate This class is used to update a Company.
CompanyUpdateWrapper JSON object with only a CompanyUpdate property.
Company This class represents a company.
CompanyWrapper JSON object with only a Company property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<CompanyUpdate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <fields>
    <field>
      <fieldDefinitionIdentifier>contact</fieldDefinitionIdentifier>
      <fieldValue>
        <value key="destinationContentId">144</value>
      </fieldValue>
    </field>
  </fields>
</CompanyUpdate>
View more

file_copy 

                                {
    "CompanyUpdate": {
        "fields": {
            "field": [
                {
                    "fieldDefinitionIdentifier": "contact",
                    "fieldValue": {
                        "destinationContentId": 144
                    }
                }
            ]
        }
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Company media-type="application/vnd.ibexa.api.Company+xml">
  <id>66</id>
  <name>Ibexa AS</name>
  <Content media-type="application/vnd.ibexa.api.Content+xml"
           href="/api/ibexa/v2/content/objects/66" remoteId="9f20fb03d0ab0a6aef9930f7e6720377"
           id="66">
    <ContentType media-type="application/vnd.ibexa.api.ContentType+xml"
                 href="/api/ibexa/v2/content/types/48"/>
    <Name>Ibexa AS</Name>
    <TranslatedName>Ibexa AS</TranslatedName>
    <Versions media-type="application/vnd.ibexa.api.VersionList+xml"
              href="/api/ibexa/v2/content/objects/66/versions"/>
    <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml"
                    href="/api/ibexa/v2/content/objects/66/currentversion">
      <Version media-type="application/vnd.ibexa.api.Version+xml"
               href="/api/ibexa/v2/content/objects/66/versions/1">
        <VersionInfo>
          <id>593</id>
          <versionNo>1</v
View more

file_copy 

                                {
    "Company": {
        "_media-type": "application\/vnd.ibexa.api.Company+json",
        "id": 66,
        "name": "Ibexa AS",
        "Content": {
            "_media-type": "application\/vnd.ibexa.api.Content+json",
            "_href": "\/api\/ibexa\/v2\/content\/objects\/66",
            "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377",
            "_id": 66,
            "ContentType": {
                "_media-type": "application\/vnd.ibexa.api.ContentType+json",
                "_href": "\/api\/ibexa\/v2\/content\/types\/48"
            },
            "Name": "Ibexa AS",
            "TranslatedName": "Ibexa AS",
            "Versions": {
                "_media-type": "application\/vnd.ibexa.api.VersionList+json",
                "_href": "\/api\/ibexa\/v2\/content\/objects\/66\/versions"
            },
            "CurrentVersion": {
                "_media-type": "application\/vnd.ibexa.api.Version+json",
                "_href": "\/api\/ibexa\/v2\/content\/objects\/66\/curr
View more

/corporate/companies/{companyId}/members

Read list of company members

GET /corporate/companies/{companyId}/members

Returns paginated list of a given company members.

Header parameters

Accept

If set, helps to determine response format.

Property Value
Type string
Examples application/vnd.ibexa.api.MemberList+xml application/vnd.ibexa.api.MemberList+json
Query parameters
Property Type Value
filter

An array-shaped string representing filtering Criterion. Supported Criteria:

Criterion Example
Creation date filter[DateMetadataCriterion][Target]=created&filter[DateMetadataCriterion][Value]=1679493636&filter[DateMetadataCriterion][Operator]=gte
Updated date filter[DateMetadataCriterion][Target]=modified&filter[DateMetadataCriterion][Value]=1679493636&filter[DateMetadataCriterion][Operator]=gte
sort string

An array-shaped string representing sorting clauses. Supported Clauses:

Clause Example
By Content (Member) name sort[ContentName]=ascending
By Member account creation date sort[DatePublished]=descending
By Member account modification date sort[DateModified]=ascending
offset integer

The offset of the result set.
limit integer

The number of returned members.
Possible responses
Code Description
200

400

Returned when invalid Criterion or Sort clause is used.
Types
Type Description
MemberList This class represents a list of company members.
MemberListWrapper JSON object with only a MemberList property.
ErrorMessage Represents an error response. Might contain additional properties depending on an error type.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<MemberList media-type="application/vnd.ibexa.api.MemberList+xml" href="/api/ibexa/v2/corporate/companies/139/members">
  <Member media-type="application/vnd.ibexa.api.Member+xml" href="/api/ibexa/v2/corporate/companies/139/members/144">
    <id>144</id>
    <name>Jay Kowalski</name>
    <Company media-type="application/vnd.ibexa.api.Company+xml">
      <id>139</id>
      <name>Ibexa Sp. z o. o.</name>
      <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/139" remoteId="b16d06d4c5ba7c37b26fa167b551dfc2" id="139">
        <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/48"/>
        <Name>Ibexa Sp. z o. o.</Name>
        <TranslatedName>Ibexa Sp. z o. o.</TranslatedName>
        <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/139/versions"/>
        <CurrentVersion media-type="application/vnd.ibe
View more

file_copy 

                                {
    "MemberList": {
        "_media-type": "application\/vnd.ibexa.api.MemberList+json",
        "_href": "\/api\/ibexa\/v2\/corporate\/companies\/139\/members",
        "members": [
            {
                "_media-type": "application\/vnd.ibexa.api.Member+json",
                "_href": "\/api\/ibexa\/v2\/corporate\/companies\/139\/members\/144",
                "id": 144,
                "name": "Jay Kowalski",
                "Company": {
                    "_media-type": "application\/vnd.ibexa.api.Company+json",
                    "id": 139,
                    "name": "Ibexa Sp. z o. o.",
                    "Content": {
                        "_media-type": "application\/vnd.ibexa.api.Content+json",
                        "_href": "\/api\/ibexa\/v2\/content\/objects\/139",
                        "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2",
                        "_id": 139,
                        "ContentType": {
                            "_media-type": "app
View more
Create a company member

POST /corporate/companies/{companyId}/members

Creates a company member.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Member+xml application/vnd.ibexa.api.Member+json

Content-Type

The CompanyCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.MemberCreate+json application/vnd.ibexa.api.MemberCreate+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 a company member.
Types
Type Description
MemberCreate This class is used to create a member.
MemberCreateWrapper JSON object with only a MemberCreate property.
Member This class represents a company member.
MemberWrapper JSON object with only a Member property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<MemberCreate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <login>jay.kowalski</login>
    <email>[email protected]</email>
    <password>Ibexa123#</password>
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/14"/>
    <fields>
        <field>
            <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>
            <fieldValue>Jay</fieldValue>
        </field>
        <field>
            <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>
            <fieldValue>Kowalski</fieldValue>
        </field>
        <field>
            <fieldDefinitionIdentifier>phone_number</fieldDefinitionIdentifier>
            <fieldValue>+48 123 123 456</fieldValue>
        </field>
    </fields>
</MemberCreate>
View more

file_copy 

                                {
  "MemberCreate": {
    "login": "jay.kowalski",
    "email": "[email protected]",
    "password": "Ibexa123#",
    "Role": {
      "_media-type": "application/vnd.ibexa.api.Role+json",
      "_href": "/api/ibexa/v2/user/roles/12"
    },
    "fields": {
      "field": [
        {
          "fieldDefinitionIdentifier": "first_name",
          "fieldValue": "Jay"
        },
        {
          "fieldDefinitionIdentifier": "last_name",
          "fieldValue": "Kowalski"
        },
        {
          "fieldDefinitionIdentifier": "phone_number",
          "fieldValue": "+48 123 123 456"
        }
      ]
    }
  }
}
View more
Code: 201

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Member media-type="application/vnd.ibexa.api.Member+xml"
        href="/api/ibexa/v2/corporate/companies/139/members/144">
  <id>144</id>
  <name>Jay Kowalski</name>
  <Company media-type="application/vnd.ibexa.api.Company+xml">
    <id>139</id>
    <name>Ibexa Sp. z o. o.</name>
    <Content media-type="application/vnd.ibexa.api.Content+xml"
             href="/api/ibexa/v2/content/objects/139" remoteId="b16d06d4c5ba7c37b26fa167b551dfc2"
             id="139">
      <ContentType media-type="application/vnd.ibexa.api.ContentType+xml"
                   href="/api/ibexa/v2/content/types/48"/>
      <Name>Ibexa Sp. z o. o.</Name>
      <TranslatedName>Ibexa Sp. z o. o.</TranslatedName>
      <Versions media-type="application/vnd.ibexa.api.VersionList+xml"
                href="/api/ibexa/v2/content/objects/139/versions"/>
      <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml"
                      href="/api/ibexa/v2/content/objec
View more

file_copy 

                                {
    "Member": {
        "_media-type": "application\/vnd.ibexa.api.Member+json",
        "_href": "\/api\/ibexa\/v2\/corporate\/companies\/139\/members\/144",
        "id": 144,
        "name": "Jay Kowalski",
        "Company": {
            "_media-type": "application\/vnd.ibexa.api.Company+json",
            "id": 139,
            "name": "Ibexa Sp. z o. o.",
            "Content": {
                "_media-type": "application\/vnd.ibexa.api.Content+json",
                "_href": "\/api\/ibexa\/v2\/content\/objects\/139",
                "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2",
                "_id": 139,
                "ContentType": {
                    "_media-type": "application\/vnd.ibexa.api.ContentType+json",
                    "_href": "\/api\/ibexa\/v2\/content\/types\/48"
                },
                "Name": "Ibexa Sp. z o. o.",
                "TranslatedName": "Ibexa Sp. z o. o.",
                "Versions": {
                    "_media-type": "appli
View more

/corporate/companies/{companyId}/members/{memberId}

Get company member

GET /corporate/companies/{companyId}/members/{memberId}

Returns the company member by given member ID.

Header parameters

Accept

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

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

401

Error - The user is not authorized to read this company.
404

Error - The company does not exist.
Types
Type Description
Member This class represents a company member.
MemberWrapper JSON object with only a Member property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Member media-type="application/vnd.ibexa.api.Member+xml"
        href="/api/ibexa/v2/corporate/companies/139/members/144">
  <id>144</id>
  <name>Jay Kowalski</name>
  <Company media-type="application/vnd.ibexa.api.Company+xml">
    <id>139</id>
    <name>Ibexa Sp. z o. o.</name>
    <Content media-type="application/vnd.ibexa.api.Content+xml"
             href="/api/ibexa/v2/content/objects/139" remoteId="b16d06d4c5ba7c37b26fa167b551dfc2"
             id="139">
      <ContentType media-type="application/vnd.ibexa.api.ContentType+xml"
                   href="/api/ibexa/v2/content/types/48"/>
      <Name>Ibexa Sp. z o. o.</Name>
      <TranslatedName>Ibexa Sp. z o. o.</TranslatedName>
      <Versions media-type="application/vnd.ibexa.api.VersionList+xml"
                href="/api/ibexa/v2/content/objects/139/versions"/>
      <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml"
                      href="/api/ibexa/v2/content/objec
View more

file_copy 

                                {
    "Member": {
        "_media-type": "application\/vnd.ibexa.api.Member+json",
        "_href": "\/api\/ibexa\/v2\/corporate\/companies\/139\/members\/144",
        "id": 144,
        "name": "Jay Kowalski",
        "Company": {
            "_media-type": "application\/vnd.ibexa.api.Company+json",
            "id": 139,
            "name": "Ibexa Sp. z o. o.",
            "Content": {
                "_media-type": "application\/vnd.ibexa.api.Content+json",
                "_href": "\/api\/ibexa\/v2\/content\/objects\/139",
                "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2",
                "_id": 139,
                "ContentType": {
                    "_media-type": "application\/vnd.ibexa.api.ContentType+json",
                    "_href": "\/api\/ibexa\/v2\/content\/types\/48"
                },
                "Name": "Ibexa Sp. z o. o.",
                "TranslatedName": "Ibexa Sp. z o. o.",
                "Versions": {
                    "_media-type": "appli
View more
Delete company member

DELETE /corporate/companies/{companyId}/members/{memberId}

The given company member is deleted.

Header parameters

Accept

If set, in the case of an error the error message is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ErrorMessage+xml application/vnd.ibexa.api.ErrorMessage+json

X-CSRF-Token

Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.

Property Value
Type string
Possible responses
Code Description
204

No Content - given company member is deleted.
401

Error - the user is not authorized to delete this company member.
404

Error - the company member does not exist.
Update a company member

PATCH /corporate/companies/{companyId}/members/{memberId}

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

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Member+xml application/vnd.ibexa.api.Member+json

Content-Type

The company input schema encoded in XML or JSON.

Property Value
Type string
Examples application/vnd.ibexa.api.MemberUpdate+xml application/vnd.ibexa.api.MemberUpdate+json

If-Match

ETag

Property Value
Type string
Possible responses
Code Description
200

OK - company member updated.
400

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

Error - the user is not authorized to create this company member.
Types
Type Description
MemberUpdate This class is used to update a member.
MemberUpdateWrapper JSON object with only a MemberUpdate property.
Member This class represents a company member.
MemberWrapper JSON object with only a Member property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<MemberUpdate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <email>[email protected]</email>
    <password>Publish123#</password>
    <enabled>false</enabled>
    <maxLogin>5</maxLogin>
    <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/15"/>
    <fields>
        <field>
            <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>
            <fieldValue>Jay</fieldValue>
        </field>
        <field>
            <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>
            <fieldValue>Kowalski</fieldValue>
        </field>
        <field>
            <fieldDefinitionIdentifier>phone_number</fieldDefinitionIdentifier>
            <fieldValue>+48 123 123 456</fieldValue>
        </field>
    </fields>
</MemberUpdate>
View more

file_copy 

                                {
  "MemberUpdate": {
    "login": "jay.kowalski",
    "email": "[email protected]",
    "password": "Ibexa123#",
    "maxLogin": 5,
    "enabled": false,
    "Role": {
      "_media-type": "application/vnd.ibexa.api.Role+json",
      "_href": "/api/ibexa/v2/user/roles/15"
    },
    "fields": {
      "field": [
        {
          "fieldDefinitionIdentifier": "first_name",
          "fieldValue": "Jay"
        },
        {
          "fieldDefinitionIdentifier": "last_name",
          "fieldValue": "Kowalski"
        },
        {
          "fieldDefinitionIdentifier": "phone_number",
          "fieldValue": "+48 123 123 456"
        }
      ]
    }
  }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<Member media-type="application/vnd.ibexa.api.Member+xml"
        href="/api/ibexa/v2/corporate/companies/139/members/144">
  <id>144</id>
  <name>Jay Kowalski</name>
  <Company media-type="application/vnd.ibexa.api.Company+xml">
    <id>139</id>
    <name>Ibexa Sp. z o. o.</name>
    <Content media-type="application/vnd.ibexa.api.Content+xml"
             href="/api/ibexa/v2/content/objects/139" remoteId="b16d06d4c5ba7c37b26fa167b551dfc2"
             id="139">
      <ContentType media-type="application/vnd.ibexa.api.ContentType+xml"
                   href="/api/ibexa/v2/content/types/48"/>
      <Name>Ibexa Sp. z o. o.</Name>
      <TranslatedName>Ibexa Sp. z o. o.</TranslatedName>
      <Versions media-type="application/vnd.ibexa.api.VersionList+xml"
                href="/api/ibexa/v2/content/objects/139/versions"/>
      <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml"
                      href="/api/ibexa/v2/content/objec
View more

file_copy 

                                {
    "Member": {
        "_media-type": "application\/vnd.ibexa.api.Member+json",
        "_href": "\/api\/ibexa\/v2\/corporate\/companies\/139\/members\/144",
        "id": 144,
        "name": "Jay Kowalski",
        "Company": {
            "_media-type": "application\/vnd.ibexa.api.Company+json",
            "id": 139,
            "name": "Ibexa Sp. z o. o.",
            "Content": {
                "_media-type": "application\/vnd.ibexa.api.Content+json",
                "_href": "\/api\/ibexa\/v2\/content\/objects\/139",
                "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2",
                "_id": 139,
                "ContentType": {
                    "_media-type": "application\/vnd.ibexa.api.ContentType+json",
                    "_href": "\/api\/ibexa\/v2\/content\/types\/48"
                },
                "Name": "Ibexa Sp. z o. o.",
                "TranslatedName": "Ibexa Sp. z o. o.",
                "Versions": {
                    "_media-type": "appli
View more

/corporate/sales-representatives

/corporate/sales-representatives

Read list of sales representatives

GET /corporate/sales-representatives

Returns paginated list of available sales representatives.

Header parameters

Accept

If set, helps to determine response format.

Property Value
Type string
Examples application/vnd.ibexa.api.SalesRepresentativesList+xml application/vnd.ibexa.api.SalesRepresentativesList+json
Query parameters
Property Type Value
offset integer

The offset of the result set.
limit integer

The number of returned representatives.
Possible responses
Code Description
200

Sales representatives list containing Company objects.
401

Error - the user is not authorized to read Sales Representatives List.
Types
Type Description
SalesRepresentativesList This class represents a list of sales representatives.
SalesRepresentativesListWrapper JSON object with only a SalesRepresentativesList property.
ErrorMessage Represents an error response. Might contain additional properties depending on an error type.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<SalesRepresentativesList media-type="application/vnd.ibexa.api.SalesRepresentativesList+xml">
    <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/75" id="75" remoteId="f262e2fa12ae105b78a1b654e87a0874">
        <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/>
        <name>John Black</name>
        <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/75/versions"/>
        <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/10"/>
        <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/64/76"/>
        <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/75/locations"/>
        <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api
View more

file_copy 

                                {
    "SalesRepresentativesList": {
        "_media-type": "application/vnd.ibexa.api.SalesRepresentativesList+json",
        "users": [
            {
                "_media-type": "application/vnd.ibexa.api.User+json",
                "_href": "/api/ibexa/v2/user/users/75",
                "_id": 75,
                "_remoteId": "f262e2fa12ae105b78a1b654e87a0874",
                "ContentType": {
                    "_media-type": "application/vnd.ibexa.api.ContentType+json",
                    "_href": "/api/ibexa/v2/content/types/4"
                },
                "name": "John Black",
                "Versions": {
                    "_media-type": "application/vnd.ibexa.api.VersionList+json",
                    "_href": "/api/ibexa/v2/content/objects/75/versions"
                },
                "Section": {
                    "_media-type": "application/vnd.ibexa.api.Section+json",
                    "_href": "/api/ibexa/v2/content/sections/10"
                },
View more

Product catalog

/product/catalog/catalogs

/product/catalog/catalogs

Create catalog

POST /product/catalog/catalogs

Creates a new catalog.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.CatalogCreate+json

Content-Type

The catalog schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CatalogCreate+json
Possible responses
Code Description
201

400

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

Error - the user is not authorized to update this catalog.
403

Error - a catalog with the same name already exists.
404

Error - no catalog with the given code exists.
Types
Type Description
CatalogCreateWrapper JSON object with only a CatalogCreate property.
CatalogWrapper JSON object with only a Catalog property.

file_copy 

                                {
    "CatalogCreate": {
        "identifier": "test_catalog",
        "criteria": {
            "ProductCodeCriterion": ["ski", "snowboard"],
            "ProductAvailabilityCriterion": true,
            "ColorAttributeCriterion": {
                "identifier": "color",
                "value": ["#000000", "#FFFFFF"]
            },
            "CreatedAtCriterion": {
                "operator": ">=",
                "created_at": "12-09-2022"
            },
            "FloatAttributeCriterion": {
                "identifier": "width",
                "value": 16.6
            },
            "IntegerAttributeRangeCriterion": {
                "identifier": "length",
                "min": 180,
                "max": 230
            }
        },
        "names": {
            "eng-GB": "Snow Equipment"
        },
        "status": "draft"
    }
}
View more
Code: 201

file_copy 

                                {
    "Catalog": {
        "_media-type": "application/vnd.ibexa.api.Catalog+json",
        "identifier": "test_catalog",
        "name": "Snow Equipment",
        "description": "",
        "User": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "created": 1666090438,
        "modified": 1666090438,
        "status": "draft",
        "Criteria": [
            {
                "_media-type": "application/vnd.ibexa.api.ProductCode+json",
                "ProductCodeCriterion": {
                    "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
                    "codes": [
                        "ski",
                        "snowboard"
                    ]
                }
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductAvailability+json",
                "ProductAvailabilityCriterion": {
                    "_media-type":
View more

/product/catalog/catalogs/{identifier}

Delete catalog

DELETE /product/catalog/catalogs/{identifier}

Deletes the given catalog.

Possible responses
Code Description
204

No content - the given catalog is deleted.
401

Error - the user is not authorized to delete this catalog.
Load catalog

GET /product/catalog/catalogs/{identifier}

Loads the given catalog.

Header parameters

Accept

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

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

401

Error - the user is not authorized to view this catalog.
404

Error - no catalog with the given identifier exists.
Types
Type Description
Catalog This class represents a catalog.
CatalogWrapper JSON object with only a Catalog property.
Code: 200

file_copy 

                                {
    "Catalog": {
        "_media-type": "application/vnd.ibexa.api.Catalog+json",
        "identifier": "test_catalog",
        "name": "Snow Equipment",
        "description": "",
        "User": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "created": 1666090438,
        "modified": 1666090438,
        "status": "draft",
        "Criteria": [
            {
                "_media-type": "application/vnd.ibexa.api.ProductCode+json",
                "ProductCodeCriterion": {
                    "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
                    "codes": [
                        "ski",
                        "snowboard"
                    ]
                }
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductAvailability+json",
                "ProductAvailabilityCriterion": {
                    "_media-type":
View more
Update catalog

PATCH /product/catalog/catalogs/{identifier}

Updates a catalog.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.CatalogUpdate+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.CatalogUpdate+json
Possible responses
Code Description
201

400

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

Error - the user is not authorized to update this catalog.
403

Error - a catalog with the same identifier already exists.
404

Error - no catalog with the given identifier exists.
Types
Type Description
CatalogUpdateWrapper JSON object with only a CatalogUpdate property.
CatalogWrapper JSON object with only a Catalog property.

file_copy 

                                {
    "CatalogUpdate": {
        "identifier": "test_catalog_updated",
        "criteria": {
            "ProductCodeCriterion": ["ski"],
            "ProductAvailabilityCriterion": false,
            "CreatedAtCriterion": {
                "operator": ">=",
                "created_at": "12-12-2022"
            }
        },
        "names": {
            "eng-GB": "Snow Equipment updated"
        },
        "descriptions": {
            "eng-GB": "Snow Equipment catalog for 2022"
        },
        "transition": "publish"
    }
}
View more
Code: 201

file_copy 

                                {
    "Catalog": {
        "_media-type": "application/vnd.ibexa.api.Catalog+json",
        "identifier": "test_catalog_updated",
        "name": "Snow Equipment updated",
        "description": "Snow Equipment catalog for 2022",
        "User": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "created": 1666090438,
        "modified": 1666091260,
        "status": "published",
        "Criteria": [
            {
                "_media-type": "application/vnd.ibexa.api.ProductCode+json",
                "ProductCodeCriterion": {
                    "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
                    "codes": [
                        "ski"
                    ]
                }
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductAvailability+json",
                "ProductAvailabilityCriterion": {
View more

/product/catalog/catalogs/copy/{identifier}

Copy catalog

POST /product/catalog/catalogs/copy/{identifier}

Copies a catalog.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.CatalogCopy+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.CatalogCopy+json
Possible responses
Code Description
201

400

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

Error - the user is not authorized to copy this catalog.
403

Error - a catalog with the same identifier already exists.
404

Error - no catalog with the given identifier exists.
Types
Type Description
CatalogCopyWrapper JSON object with only a CatalogCopy property.
CatalogWrapper JSON object with only a Catalog property.

file_copy 

                                {
    "CatalogCopy": {
        "identifier": "test_catalog_copied",
        "creator_id": 14
    }
}
View more
Code: 201

file_copy 

                                {
    "Catalog": {
        "_media-type": "application/vnd.ibexa.api.Catalog+json",
        "identifier": "test_catalog_copied",
        "name": "Snow Equipment updated",
        "description": "Snow Equipment catalog for 2022",
        "User": {
            "_media-type": "application/vnd.ibexa.api.User+json",
            "_href": "/api/ibexa/v2/user/users/14"
        },
        "created": 1666091820,
        "modified": 1666091820,
        "status": "draft",
        "Criteria": [
            {
                "_media-type": "application/vnd.ibexa.api.ProductCode+json",
                "ProductCodeCriterion": {
                    "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
                    "codes": [
                        "ski"
                    ]
                }
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductAvailability+json",
                "ProductAvailabilityCriterion": {
                    "_med
View more

/product/catalog/catalogs/view

Filter catalogs

POST /product/catalog/catalogs/view

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

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CatalogView+xml application/vnd.ibexa.api.CatalogView+json

Content-Type

The view input in XML or JSON format.

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

400

Error - the input does not match the input schema definition.
Types
Type Description
CatalogViewInput This class represents a catalog view input.
CatalogViewInputWrapper JSON object with only a ViewInput property.
CatalogView
CatalogViewWrapper JSON object with only a CatalogView property.

file_copy 

                                {
    "ViewInput": {
        "identifier": "TitleView",
        "CatalogQuery": {
            "Query": {
                "CatalogIdentifierCriterion": "test",
                "CatalogNameCriterion": "test"
            }
        }
    }
}
View more
Code: 200

file_copy 

                                {
    "CatalogView": {
        "_media-type": "application/vnd.ibexa.api.CatalogView+json",
        "identifier": "TitleView",
        "CatalogQuery": {
            "_media-type": "application/vnd.ibexa.api.CatalogQuery+json"
        },
        "Result": {
            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
            "count": 1,
            "CatalogList": {
                "_media-type": "application/vnd.ibexa.api.CatalogList+json",
                "Catalog": [
                    {
                        "_media-type": "application/vnd.ibexa.api.Catalog+json",
                        "identifier": "test",
                        "name": "test",
                        "description": "",
                        "User": {
                            "_media-type": "application/vnd.ibexa.api.User+json",
                            "_href": "/api/ibexa/v2/user/users/14"
                        },
                        "created": 1665479475,
View more

/product/catalog/catalogs/{identifier}/products/view

Filter catalog products

POST /product/catalog/catalogs/{identifier}/products/view

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

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductView+xml application/vnd.ibexa.api.ProductView+json

Content-Type

The view input in XML or JSON format.

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

400

Error - the input does not match the input schema definition.
Types
Type Description
ProductViewInput This class represents a product view input.
ProductViewInputWrapper JSON object with only a ViewInput property.
ProductView This class represents a product view.
ProductViewWrapper JSON object with only a ProductView property.

file_copy 

                                {
    "ViewInput": {
        "identifier": "TitleView",
        "ProductQuery": {
            "Query": {
                "ProductCodeCriterion": "test",
                "ProductAvailabilityCriterion": true
            }
        }
    }
}
View more
Code: 200

file_copy 

                                {
    "ProductView": {
        "_media-type": "application/vnd.ibexa.api.ProductView+json",
        "identifier": "TitleView",
        "ProductQuery": {
            "_media-type": "application/vnd.ibexa.api.ProductQuery+json"
        },
        "Result": {
            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
            "count": 1,
            "ProductList": {
                "_media-type": "application/vnd.ibexa.api.ProductList+json",
                "Product": [
                    {
                        "_media-type": "application/vnd.ibexa.api.Product+json",
                        "code": "test",
                        "name": "test",
                        "ProductType": {
                            "_media-type": "application/vnd.ibexa.api.ProductType+json",
                            "identifier": "quickdraw",
                            "name": "Quickdraw",
                            "AttributeAssignmentList": []
                        },
View more

/product/catalog/catalogs/filters

Load catalog filters

GET /product/catalog/catalogs/filters

Loads product filters available for catalogs.

Header parameters

Accept

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

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

Types
Type Description
ProductFilterList This class represents a product filter list.
ProductFilterListWrapper JSON object with only a ProductFilterList property.
Code: 200

file_copy 

                                {
    "ProductFilterList": {
        "_media-type": "application/vnd.ibexa.api.ProductFilterList+json",
        "ProductFilter": [
            {
                "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
                "name": "CreatedAtCriterion"
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
                "name": "CreatedAtRangeCriterion"
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
                "name": "ProductCategoryCriterion"
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
                "name": "ColorAttributeCriterion"
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductFilter+json",
                "name": "FloatAttributeCriterion"
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductFilt
View more

/product/catalog/catalogs/sort_clauses

Load catalog sort clauses

GET /product/catalog/catalogs/sort_clauses

Loads product sort clauses available for catalogs.

Header parameters

Accept

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

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

Types
Type Description
ProductSortClauseList This class represents a product sort clause list.
ProductSortClauseListWrapper JSON object with only a ProductSortClauseList property.
Code: 200

file_copy 

                                {
    "ProductSortClauseList": {
        "_media-type": "application/vnd.ibexa.api.ProductSortClauseList+json",
        "ProductSortClause": [
            {
                "_media-type": "application/vnd.ibexa.api.ProductSortClause+json",
                "name": "ProductName"
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductSortClause+json",
                "name": "ProductCode"
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductSortClause+json",
                "name": "ProductAvailability"
            },
            {
                "_media-type": "application/vnd.ibexa.api.ProductSortClause+json",
                "name": "CreatedAt"
            }
        ]
    }
}
View more

/product/catalog/currencies

/product/catalog/currencies

Create currency

POST /product/catalog/currencies

Creates a new currency.

Header parameters

Accept

If set, the new currency is returned in JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.Currency+json

Content-Type

The Currency schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CurrencyCreate+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 create this currency.
406

Error - a currency with this code already exists.
Types
Type Description
CurrencyCreateWrapper JSON object with only a CurrencyCreate property.
CurrencyWrapper JSON object with only a Currency property.

file_copy 

                                {
    "CurrencyCreate": {
        "code": "cur",
        "subunits": 1,
        "enabled": true
    }
}
View more
Code: 200

file_copy 

                                {
    "Currency": {
        "_media-type": "application/vnd.ibexa.api.Currency+json",
        "id": 181,
        "code": "cur",
        "subunits": 1,
        "enabled": true
    }
}
View more
Load currencies

GET /product/catalog/currencies

Loads the list of currencies.

Header parameters

Accept

CurrencyList - If set, the currency list returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CurrencyList+json
Possible responses
Code Description
200

OK - loads currencies.
401

Error - the user has no permission to read currencies.
Types
Type Description
CurrencyListWrapper JSON object with only a CurrencyList property.
Code: 200

file_copy 

                                {
    "CurrencyList": {
        "_media-type": "application/vnd.ibexa.api.CurrencyList+json",
        "Currency": [
            {
                "_media-type": "application/vnd.ibexa.api.Currency+json",
                "id": 1,
                "code": "AFN",
                "subunits": 1,
                "enabled": false
            },
            {
                "_media-type": "application/vnd.ibexa.api.Currency+json",
                "id": 2,
                "code": "EUR",
                "subunits": 2,
                "enabled": false
            },
            {
                "_media-type": "application/vnd.ibexa.api.Currency+json",
                "id": 3,
                "code": "ALL",
                "subunits": 2,
                "enabled": false
            },
            {
                "_media-type": "application/vnd.ibexa.api.Currency+json",
                "id": 4,
                "code": "DZD",
                "subunits": 2,
                "enabled": false
View more

/product/catalog/currencies/{id}

Load currency

GET /product/catalog/currencies/{id}

Loads a currency.

Header parameters

Accept

Currency - If set, the currency returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.Currency+json
Possible responses
Code Description
200

OK - loads the currency.
401

Error - the user has no permission to read currencies.
404

Error - the currency does not exist.
Types
Type Description
CurrencyWrapper JSON object with only a Currency property.
Code: 200

file_copy 

                                {
    "Currency": {
        "_media-type": "application/vnd.ibexa.api.Currency+json",
        "id": 3,
        "code": "ALL",
        "subunits": 2,
        "enabled": false
    }
}
View more
Update currency

PATCH /product/catalog/currencies/{id}

Updates a currency.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Currency+json

Content-Type

The CurrencyUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CurrencyUpdate+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 create this User.
403

Error - a currency with the same ID already exists.
404

Error - the currency with the given ID does not exist.
Types
Type Description
CurrencyUpdateWrapper JSON object with only a CurrencyUpdate property.
CurrencyWrapper JSON object with only a Currency property.

file_copy 

                                {
    "CurrencyUpdate": {
        "subunits": 1,
        "enabled": false
    }
}
View more
Code: 200

file_copy 

                                {
    "Currency": {
        "_media-type": "application/vnd.ibexa.api.Currency+json",
        "id": 1,
        "code": "AFN",
        "subunits": 1,
        "enabled": false
    }
}
View more
Delete currency

DELETE /product/catalog/currencies/{id}

Deletes the given currency.

Possible responses
Code Description
200

No content - the given currency is deleted.
401

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

/product/catalog/currencies/view

Filter currencies

POST /product/catalog/currencies/view

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

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CurrencyView+xml application/vnd.ibexa.api.CurrencyView+json

Content-Type

The view input in XML or JSON format.

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

400

Error - the input does not match the input schema definition.
Types
Type Description
CurrencyViewInput This class represents a currency view input.
CurrencyViewInputWrapper JSON object with only a ViewInput property.
CurrencyView This class represents a currency view.
CurrencyViewWrapper JSON object with only a CurrencyView property.

file_copy 

                                {
    "ViewInput": {
        "identifier": "TitleView",
        "CurrencyQuery": {
            "limit": "10",
            "offset": "0"
        }
    }
}
View more
Code: 200

file_copy 

                                {
    "CurrencyView": {
        "_media-type": "application/vnd.ibexa.api.CurrencyView+json",
        "identifier": "TitleView",
        "CurrencyQuery": {
            "_media-type": "application/vnd.ibexa.api.CurrencyQuery+json"
        },
        "Result": {
            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
            "count": 179,
            "CurrencyList": {
                "_media-type": "application/vnd.ibexa.api.CurrencyList+json",
                "Currency": [
                    {
                        "_media-type": "application/vnd.ibexa.api.Currency+json",
                        "id": 1,
                        "code": "AFN",
                        "subunits": 2,
                        "enabled": false
                    },
                    {
                        "_media-type": "application/vnd.ibexa.api.Currency+json",
                        "id": 2,
                        "code": "EUR",
                        "subunits": 2,
View more

/product/catalog/regions

/product/catalog/regions

Load regions

GET /product/catalog/regions

Loads the list of regions.

Header parameters

Accept

RegionList - If set, the regions list returned in XML or JSON format.

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

OK - loads regions.
401

Error - the user has no permission to read regions.
Types
Type Description
RegionList This class represents a region list.
RegionListWrapper JSON object with only a RegionList property.
Code: 200

file_copy 

                                {
    "RegionList": {
        "_media-type": "application/vnd.ibexa.api.RegionList+json",
        "Region": [
            {
                "_media-type": "application/vnd.ibexa.api.Region+json",
                "identifier": "france"
            },
            {
                "_media-type": "application/vnd.ibexa.api.Region+json",
                "identifier": "__REGION_2__"
            },
            {
                "_media-type": "application/vnd.ibexa.api.Region+json",
                "identifier": "__REGION_1__"
            },
            {
                "_media-type": "application/vnd.ibexa.api.Region+json",
                "identifier": "foo"
            },
            {
                "_media-type": "application/vnd.ibexa.api.Region+json",
                "identifier": "bar"
            }
        ]
    }
}
View more

/product/catalog/regions/{identifier}

Load region

GET /product/catalog/regions/{identifier}

Loads a region by its identifier

Header parameters

Accept

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

OK - loads region.
404

Error - the region does not exist.
Types
Type Description
Region This class represents a region.
RegionWrapper JSON object with only a Region property.

/product/catalog/regions/view

Filter regions

POST /product/catalog/regions/view

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

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.RegionView+xml application/vnd.ibexa.api.RegionView+json

Content-Type

The view input in XML or JSON format.

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

400

Error - the input does not match the input schema definition.
Types
Type Description
RegionViewInput This class represents a region view input.
RegionViewInputWrapper JSON object with only a ViewInput property.
RegionView This class represents a region view.
RegionViewWrapper JSON object with only a RegionView property.

file_copy 

                                {
    "ViewInput": {
        "identifier": "TitleView",
        "RegionQuery": {
            "limit": "10",
            "offset": "0"
        }
    }
}
View more
Code: 200

file_copy 

                                {
    "RegionView": {
        "_media-type": "application/vnd.ibexa.api.RegionView+json",
        "identifier": "TitleView",
        "RegionQuery": {
            "_media-type": "application/vnd.ibexa.api.RegionQuery+json"
        },
        "Result": {
            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
            "count": 2,
            "RegionList": {
                "_media-type": "application/vnd.ibexa.api.RegionList+json",
                "Region": [
                    {
                        "_media-type": "application/vnd.ibexa.api.Region+json",
                        "identifier": "region_1"
                    },
                    {
                        "_media-type": "application/vnd.ibexa.api.Region+json",
                        "identifier": "region_2"
                    }
                ]
            }
        }
    }
}
View more

/product/catalog/attribute_types

/product/catalog/attribute_types

List Attribute Types

GET /product/catalog/attribute_types

Lists all Attribute Types.

Header parameters

Accept

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

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

OK - returns a list of Attribute Types
Types
Type Description
AttributeTypeList This class represents an attribute type list.
AttributeTypeListWrapper JSON object with only a AttributeTypeList property.

/product/catalog/attribute_types/{identifier}

Get Attribute Type

GET /product/catalog/attribute_types/{identifier}

Gets an Attribute Type by its identifier.

Header parameters

Accept

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

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

OK - returns the Attribute Type
404

Error - The Attribute Type does not exist.
Types
Type Description
AttributeType This class represents an attribute type.
AttributeTypeWrapper JSON object with only a AttributeType property.

/product/catalog/attribute_groups

/product/catalog/attribute_groups

Load attribute groups (deprecated)

GET /product/catalog/attribute_groups

Returns a list of attribute groups. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attribute_groups/view instead.

Header parameters

Accept

AttributeGroupList - If set, the attribute group list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeGroupList+xml application/vnd.ibexa.api.AttributeGroupList+json

Content-Type

The AttributeGroupListGet schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeGroupListGet+json application/vnd.ibexa.api.AttributeGroupListGet+json
Possible responses
Code Description
200

401

Error - the user has no permission to read attribute groups.
Types
Type Description
AttributeGroupListGetWrapper JSON object with only a AttributeGroupListGet property.
AttributeGroupList This class represents an attribute group list.
AttributeGroupListWrapper JSON object with only a AttributeGroupList property.

file_copy 

                                {
    "AttributeGroupListGet": {
        "prefix": "s",
        "offset": 0,
        "limit": 10
    }
}
View more
Code: 200

file_copy 

                                {
    "AttributeGroupList": {
        "_media-type": "application/vnd.ibexa.api.AttributeGroupList+json",
        "AttributeGroup": [
            {
                "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
                "name": "Attribute Group Test",
                "identifier": "attr_group_test",
                "position": 0
            },
            {
                "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
                "name": "Dimensions",
                "identifier": "ag_dimensions",
                "position": 0
            }
        ]
    }
}
View more
Create attribute group

POST /product/catalog/attribute_groups

Creates a new attribute group.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeGroupCreate+json

Content-Type

The AttributeGroup schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeGroupCreate+json
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 attribute group.
403

Error - an attribute group with the same identifier already exists.
Types
Type Description
AttributeGroupCreateWrapper JSON object with only a AttributeGroupCreate property.
AttributeGroupWrapper JSON object with only a AttributeGroup property.

file_copy 

                                {
    "AttributeGroupCreate": {
        "identifier": "attr_group_test",
        "names": {
            "eng-GB": "Attribute Group Test"
        },
        "position": 0
    }
}
View more
Code: 201

file_copy 

                                {
    "AttributeGroup": {
        "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
        "name": "Attribute Group Test",
        "identifier": "attr_group_test",
        "position": 0
    }
}
View more

/product/catalog/attribute_groups/{id}

Load attribute group

GET /product/catalog/attribute_groups/{id}

Returns the given attribute group.

Header parameters

Accept

AttributeGroupGet - If set, the attribute group List is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeGroup+xml application/vnd.ibexa.api.AttributeGroup+json

Content-Type

An optional AttributeGroupGet schema encoded in XML or JSON format.

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

401

Error - the user has no permission to read attribute groups.
Types
Type Description
AttributeGroupGet This class represents an attribute group query.
AttributeGroupGetWrapper JSON object with only a AttributeGroupGet property.
AttributeGroup This class represents an attribute group.
AttributeGroupWrapper JSON object with only a AttributeGroup property.

file_copy 

                                {
    "AttributeGroupGet": {
        "languages": ["eng-GB"]
    }
}
View more
Code: 200

file_copy 

                                {
    "AttributeGroup": {
        "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
        "name": "Attribute Group Test",
        "identifier": "attr_group_test",
        "position": 0
    }
}
View more
Update attribute group

PATCH /product/catalog/attribute_groups/{id}

Updates an attribute group.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeGroup+xml application/vnd.ibexa.api.AttributeGroup+json

Content-Type

The attribute group update schema is sent in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeGroupUpdate+xml application/vnd.ibexa.api.AttributeGroupUpdate+json
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 attribute group.
403

Error - an attribute group with the same identifier already exists.
404

Error - the group with the given ID does not exist.
Types
Type Description
AttributeGroupUpdate This class is used to update an attribute group.
AttributeGroupUpdateWrapper JSON object with only a AttributeGroupUpdate property.
AttributeGroup This class represents an attribute group.
AttributeGroupWrapper JSON object with only a AttributeGroup property.

file_copy 

                                {
    "AttributeGroupUpdate": {
        "identifier": "ag_colors",
        "names": {
            "eng-GB": "Colors Group"
        },
        "position": 0
    }
}
View more
Code: 201

file_copy 

                                {
    "AttributeGroup": {
        "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
        "name": "Colors Group",
        "identifier": "ag_colors",
        "position": 0
    }
}
View more
Delete attribute group

DELETE /product/catalog/attribute_groups/{id}

Deletes an attribute group.

Possible responses
Code Description
204

No content - the given attribute group is deleted.
401

Error - the user is not authorized to delete this attribute group.

/product/catalog/attribute_groups/translation/{id}/{languageCode}

Delete attribute group translation

DELETE /product/catalog/attribute_groups/translation/{id}/{languageCode}

Deletes given translation from attribute group.

Possible responses
Code Description
200

No content - the given attribute group translation is deleted.
401

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

/product/catalog/attribute_groups/view

Filter attribute groups

POST /product/catalog/attribute_groups/view

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

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeGroupView+xml application/vnd.ibexa.api.AttributeGroupView+json

Content-Type

The view input in XML or JSON format.

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

400

Error - the input does not match the input schema definition.
Types
Type Description
AttributeGroupViewInput This class represents an attribute group view input.
AttributeGroupViewInputWrapper JSON object with only a ViewInput property.
AttributeGroupView This class represents an attribute group view.
AttributeGroupViewWrapper JSON object with only a AttributeGroupView property.

file_copy 

                                {
    "ViewInput": {
        "identifier": "TitleView",
        "AttributeGroupQuery": {
            "limit": "10",
            "offset": "0",
            "name_prefix": "test"
        }
    }
}
View more
Code: 200

file_copy 

                                {
    "AttributeGroupView": {
        "_media-type": "application/vnd.ibexa.api.AttributeGroupView+json",
        "identifier": "TitleView",
        "AttributeGroupQuery": {
            "_media-type": "application/vnd.ibexa.api.AttributeGroupQuery+json"
        },
        "Result": {
            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
            "count": 1,
            "AttributeGroupList": {
                "_media-type": "application/vnd.ibexa.api.AttributeGroupList+json",
                "AttributeGroup": [
                    {
                        "_media-type": "application/vnd.ibexa.api.AttributeGroup+json",
                        "name": "Test Attribute group",
                        "identifier": "test_attribute_group",
                        "position": 0
                    }
                ]
            }
        }
    }
}
View more

/product/catalog/attributes

/product/catalog/attributes

Create attribute

POST /product/catalog/attributes

Creates a new attribute.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeCreate+json

Content-Type

The attribute schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeCreate+json
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 attribute.
403

Error - an attribute with the same name already exists.
Types
Type Description
AttributeCreateWrapper JSON object with only a AttributeCreate property.
AttributeWrapper JSON object with only a Attribute property.

file_copy 

                                {
    "AttributeCreate": {
        "identifier": "foo",
        "type": "checkbox",
        "group": "attr_group_test",
        "names": {
            "eng-GB": "Attribute"
        },
        "descriptions": {
            "eng-GB": "description"
        },
        "position": 0,
        "options": {
            "foo": "bar"
        }
    }
}
View more
Code: 201

file_copy 

                                {
    "Attribute": {
        "_media-type": "application/vnd.ibexa.api.Attribute+json",
        "identifier": "foo",
        "name": "Attribute",
        "description": "description",
        "type": "Checkbox",
        "type_identifier": "checkbox",
        "value": true,
        "group": "Attribute Test",
        "position": 0,
        "options": []
    }
}
View more
Load attributes (deprecated)

GET /product/catalog/attributes

Loads list of all attributes. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attributes/view instead.

Header parameters

Accept

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

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

401

Error - the user has no permission to read user groups.
Types
Type Description
AttributeList This class represents an attribute list.
AttributeListWrapper JSON object with only a AttributeList property.
Code: 200

file_copy 

                                {
    "AttributeList": {
        "_media-type": "application/vnd.ibexa.api.AttributeList+json",
        "Attribute": [
            {
                "_media-type": "application/vnd.ibexa.api.Attribute+json",
                "identifier": "attrib1",
                "name": "Attrib1",
                "description": "",
                "type": "Checkbox",
                "type_identifier": "checkbox",
                "value": true,
                "group": "Attribute Group Test",
                "position": 0,
                "options": []
            },
            {
                "_media-type": "application/vnd.ibexa.api.Attribute+json",
                "identifier": "attrib2",
                "name": "Attrib2",
                "description": "",
                "type": "Checkbox",
                "type_identifier": "checkbox",
                "value": true,
                "group": "Attribute Group Test",
                "position": 0,
                "options": []
            },
View more

/product/catalog/attributes/{id}

Load attribute

GET /product/catalog/attributes/{id}

Loads given attribute.

Header parameters

Accept

Attribute - If set, the given attribute is returned in XML or JSON format.

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

401

Error - the user has no permission to read the attribute.
Types
Type Description
Attribute This class represents an attribute.
AttributeWrapper JSON object with only a Attribute property.
Code: 200

file_copy 

                                {
    "Attribute": {
        "_media-type": "application/vnd.ibexa.api.Attribute+json",
        "identifier": "attrib2",
        "name": "Attrib2",
        "description": "",
        "type": "Checkbox",
        "type_identifier": "checkbox",
        "value": true,
        "group": "Attribute Group Test",
        "position": 0,
        "options": []
    }
}
View more
Delete attribute

DELETE /product/catalog/attributes/{id}

The given attribute is removed from the attribute group.

Possible responses
Code Description
200

No Content.
401

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

/product/catalog/attributes/{id}/{group_id}

Update attribute

PATCH /product/catalog/attributes/{id}/{group_id}

Updates an attribute.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeUpdate+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeUpdate+json
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 attribute.
403

Error - an attribute with the same name already exists.
404

Error - the attribute with the given ID does not exist.
Types
Type Description
AttributeUpdateWrapper JSON object with only a AttributeUpdate property.
AttributeWrapper JSON object with only a Attribute property.

file_copy 

                                {
    "AttributeUpdate": {
        "identifier": "attr_group",
        "names": {
            "eng-GB": "Attribute Group"
        },
        "descriptions": {
            "eng-GB": "description"
        },
        "position": 0,
        "options": {
            "foo": "bar"
        }
    }
}
View more
Code: 201

file_copy 

                                {
    "Attribute": {
        "_media-type": "application/vnd.ibexa.api.Attribute+json",
        "identifier": "attr_group",
        "name": "Attribute Group",
        "description": "description",
        "type": "Checkbox",
        "type_identifier": "checkbox",
        "value": true,
        "group": "Attribute Group",
        "position": 0,
        "options": []
    }
}
View more

/product/catalog/attributes/translation/{id}/{languageCode}

Delete attribute translation

DELETE /product/catalog/attributes/translation/{id}/{languageCode}

The given translation is removed from the attribute.

Possible responses
Code Description
200

No Content.
401

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

/product/catalog/attributes/view

Filter attributes

POST /product/catalog/attributes/view

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

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.AttributeView+xml application/vnd.ibexa.api.AttributeView+json

Content-Type

The view input in XML or JSON format.

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

400

Error - the input does not match the input schema definition.
Types
Type Description
AttributeViewInput This class represents an attribute view input.
AttributeViewInputWrapper JSON object with only a ViewInput property.
AttributeView This class represents an attribute view.
AttributeViewWrapper JSON object with only a AttributeView property.

file_copy 

                                {
    "ViewInput": {
        "identifier": "TitleView",
        "AttributeQuery": {
            "limit": "10",
            "offset": "0",
            "Query": {
                "AttributeNameCriterion": "measure",
                "AttributeGroupIdentifierCriterion": "test_attribute_group"
            }
        }
    }
}
View more
Code: 200

file_copy 

                                {
    "AttributeView": {
        "_media-type": "application/vnd.ibexa.api.AttributeView+json",
        "identifier": "TitleView",
        "AttributeQuery": {
            "_media-type": "application/vnd.ibexa.api.AttributeQuery+json"
        },
        "Result": {
            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
            "count": 1,
            "AttributeList": {
                "_media-type": "application/vnd.ibexa.api.AttributeList+json",
                "Attribute": [
                    {
                        "_media-type": "application/vnd.ibexa.api.Attribute+json",
                        "identifier": "measure",
                        "name": "measure",
                        "description": "",
                        "type": "Measurement",
                        "type_identifier": "measurement",
                        "group": "Test Attribute group",
                        "position": 0,
                        "options": {
View more

/product/catalog/customer_groups

/product/catalog/customer_groups

Load customer groups

GET /product/catalog/customer_groups

Returns a list of customer groups

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.CustomerGroupList+json
Possible responses
Code Description
200

401

Error - the user has no permission to read customer groups.
Types
Type Description
CustomerGroupListWrapper JSON object with only a CustomerGroupList property.
Code: 200

file_copy 

                                {
    "CustomerGroupList": {
        "_media-type": "application/vnd.ibexa.api.CustomerGroupList+json",
        "CustomerGroup": [
            {
                "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
                "id": 1,
                "name": "Resellers",
                "identifier": "resellers",
                "description": "",
                "users": [],
                "global_price_rate": "0.00"
            },
            {
                "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
                "id": 2,
                "name": "Contractors",
                "identifier": "contractors",
                "description": "",
                "users": [],
                "global_price_rate": "-20.00"
            }
        ]
    }
}
View more
Create customer group

POST /product/catalog/customer_groups

Creates a new customer group.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.CustomerGroupCreate+json

Content-Type

The CustomerGroupCreate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CustomerGroupCreate+json
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 Customer Group.
403

Error - a customer group with the same name already exists.
Types
Type Description
CustomerGroupCreateWrapper JSON object with only a CustomerGroupCreate property.
CustomerGroupWrapper JSON object with only a CustomerGroup property.

file_copy 

                                {
    "CustomerGroupCreate": {
        "identifier": "customer_group",
        "names": {
            "eng-GB": "Customer Group"
        },
        "descriptions": {
            "eng-GB": "Customer Group description"
        },
        "global_price_rate": "1"
    }
}
View more
Code: 201

file_copy 

                                {
    "CustomerGroup": {
        "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
        "id": 5,
        "name": "test-en",
        "identifier": "test",
        "description": "test-desc-en",
        "users": [],
        "global_price_rate": "1.00"
    }
}
View more

/product/catalog/customer_groups/{identifier}

Load customer group

GET /product/catalog/customer_groups/{identifier}

Returns a customer group

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.CustomerGroup+json
Possible responses
Code Description
200

401

Error - the user has no permission to read customer groups.
Types
Type Description
CustomerGroupWrapper JSON object with only a CustomerGroup property.
Code: 200

file_copy 

                                {
    "CustomerGroup": {
        "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
        "id": 1,
        "name": "Resellers",
        "identifier": "resellers",
        "description": "",
        "users": [],
        "global_price_rate": "0.00"
    }
}
View more
Update customer group

PATCH /product/catalog/customer_groups/{identifier}

Updates the given customer group.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.CustomerGroupUpdate+json

Content-Type

The CustomerGroupUpdate schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CustomerGroupUpdate+json
Possible responses
Code Description
201

400

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

Error - the user is not authorized to update a customer group.
Types
Type Description
CustomerGroupUpdateWrapper JSON object with only a CustomerGroupUpdate property.
CustomerGroupWrapper JSON object with only a CustomerGroup property.

file_copy 

                                {
    "CustomerGroupUpdate": {
        "identifier": "customer_group",
        "names": {
            "eng-GB": "Customer Group"
        },
        "global_price_rate": "1"
    }
}
View more
Code: 201

file_copy 

                                {
    "CustomerGroup": {
        "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
        "id": 1,
        "name": "Customer Group",
        "identifier": "customer_group",
        "description": "",
        "users": [],
        "global_price_rate": "1.00"
    }
}
View more
Delete customer group

DELETE /product/catalog/customer_groups/{identifier}

Deletes the given customer group.

Possible responses
Code Description
204

No content - the given customer group is deleted.
401

Error - the user is not authorized to delete this customer group.

/product/catalog/customer_groups/view

Filter customer groups

POST /product/catalog/customer_groups/view

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

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CustomerGroupView+xml application/vnd.ibexa.api.CustomerGroupView+json

Content-Type

The view input in XML or JSON format.

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

400

Error - the input does not match the input schema definition.
Types
Type Description
CustomerGroupViewInput This class represents a customer group view input.
CustomerGroupViewInputWrapper JSON object with only a ViewInput property.
CustomerGroupView This class represents a customer group view.
CustomerGroupViewWrapper JSON object with only a CustomerGroupView property.

file_copy 

                                {
    "ViewInput": {
        "identifier": "TitleView",
        "CustomerGroupQuery": {
            "limit": "10",
            "offset": "0"
        }
    }
}
View more
Code: 200

file_copy 

                                {
    "CustomerGroupView": {
        "_media-type": "application/vnd.ibexa.api.CustomerGroupView+json",
        "identifier": "TitleView",
        "CustomerGroupQuery": {
            "_media-type": "application/vnd.ibexa.api.CustomerGroupQuery+json"
        },
        "Result": {
            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
            "count": 1,
            "CustomerGroupList": {
                "_media-type": "application/vnd.ibexa.api.CustomerGroupList+json",
                "CustomerGroup": [
                    {
                        "_media-type": "application/vnd.ibexa.api.CustomerGroup+json",
                        "id": 1,
                        "name": "Business",
                        "identifier": "business",
                        "description": "Most trusted business customers, being our partners for at least 5 years.",
                        "users": [],
                        "global_price_rate": "15.00"
                    }
View more

/product/catalog/product_types

/product/catalog/product_types

Create product type

POST /product/catalog/product_types

Creates a new product type.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ProductTypeCreate+json

Content-Type

The ProductType schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductTypeCreate+json
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 product type.
403

Error - a product type with the same name already exists.
404

Error - the product type with the given ID does not exist.
Types
Type Description
ProductTypeCreateWrapper JSON object with only a ProductTypeCreate property.
ProductTypeWrapper JSON object with only a ProductType property.

file_copy 

                                {
    "ProductTypeCreate": {
        "ContentTypeCreateStruct": {
            "_media-type": "application/vnd.ibexa.api.ContentType+json",
            "_href": "/api/ibexa/v2/content/types/2",
            "id": 2,
            "status": "DEFINED",
            "identifier": "test_pt321",
            "names": {
                "value": [
                    {
                        "_languageCode": "eng-GB",
                        "#text": "Article"
                    }
                ]
            },
            "descriptions": {
                "value": [
                    {
                        "_languageCode": "eng-GB",
                        "#text": null
                    }
                ]
            },
            "creationDate": "2002-06-18T09:21:38+00:00",
            "modificationDate": "2021-06-28T11:31:22+00:00",
            "remoteId": "c15b600eb9198b1924063b5a68758232",
            "urlAliasSchema": "",
            "nameSchema": "<short_title|title>",
View more
Code: 201

file_copy 

                                {
    "ProductType": {
        "_media-type": "application/vnd.ibexa.api.ProductType+json",
        "identifier": "test_pt321",
        "name": "New Product Type",
        "AttributeAssignmentList": [
            {
                "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
                "is_required": false,
                "is_discriminator": true,
                "Attribute": {
                    "_media-type": "application/vnd.ibexa.api.Attribute+json",
                    "identifier": "testAttr",
                    "name": "testAttr",
                    "description": "",
                    "type": "Checkbox",
                    "type_identifier": "checkbox",
                    "value": true,
                    "group": "Test Attribute group",
                    "position": 0,
                    "options": []
                }
            }
        ]
    }
}
View more
Load product types (deprecated)

GET /product/catalog/product_types

Returns a list of product types. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/product_types/view instead.

Header parameters

Accept

ProductTypeList - If set, the product type list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductTypeList+xml application/vnd.ibexa.api.ProductTypeList+json

Content-Type

The ProductTypeList schema encoded in XML or JSON format.

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

401

Error - the user has no permission to read product type.
Types
Type Description
ProductTypeListGet This class represents a product type list query.
ProductTypeListGetWrapper JSON object with only a ProductTypeListGet property.
ProductTypeList This class represents a product type list.
ProductTypeListWrapper JSON object with only a ProductTypeList property.

file_copy 

                                {
    "ProductTypeListGet": {
        "name_prefix": "s",
        "offset": 0,
        "limit": 10
    }
}
View more
Code: 200

file_copy 

                                {
    "ProductTypeList": {
        "_media-type": "application/vnd.ibexa.api.ProductTypeList+json",
        "ProductType": [
            {
                "_media-type": "application/vnd.ibexa.api.ProductType+json",
                "identifier": "s_rope",
                "name": "Static ropes",
                "AttributeAssignmentList": []
            }
        ]
    }
}
View more

/product/catalog/product_types/is_used/{identifier}

Check product type usage

GET /product/catalog/product_types/is_used/{identifier}

Checks whether the product type is in use.

Header parameters

Accept

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

404

Error - product type not found.
Types
Type Description
ProductTypeUsage This class represents a product type usage.
ProductTypeUsageWrapper JSON object with only a ProductTypeUsage property.

/product/catalog/product_types/{id}

Load product type

GET /product/catalog/product_types/{id}

Returns the given product type.

Header parameters

Accept

ProductType - If set, the product type is returned in XML or JSON format.

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

401

Error - the user has no permission to read product type.
Types
Type Description
ProductType This class represents a product type.
ProductTypeWrapper JSON object with only a ProductType property.
Code: 200

file_copy 

                                {
    "ProductType": {
        "_media-type": "application/vnd.ibexa.api.ProductType+json",
        "identifier": "d_rope",
        "name": "Dynamic ropes",
        "AttributeAssignmentList": []
    }
}
View more
Update product type

PATCH /product/catalog/product_types/{id}

Updates product type.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ProductTypeUpdate+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.ProductTypeUpdate+json
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 product type.
404

Error - the product type with the given ID does not exist.
Types
Type Description
ProductTypeUpdateWrapper JSON object with only a ProductTypeUpdate property.
ProductTypeWrapper JSON object with only a ProductType property.

file_copy 

                                {
    "ProductTypeUpdate": {
        "ContentTypeUpdateStruct": {
            "names": {
                "value": [
                    {
                        "_languageCode": "eng-GB",
                        "#text": "pt_1_updated"
                    }
                ]
            },
            "descriptions": {
                "value": [
                    {
                        "_languageCode": "eng-GB",
                        "#text": "updated"
                    }
                ]
            }
        },
        "assigned_attributes": [
            {
                "identifier": "size",
                "is_required": false,
                "is_discriminator": true
            }
        ]
    }
}
View more
Code: 201

file_copy 

                                {
    "ProductType": {
        "_media-type": "application/vnd.ibexa.api.ProductType+json",
        "identifier": "NEW",
        "name": "pt_1_updated",
        "AttributeAssignmentList": [
            {
                "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
                "is_required": false,
                "is_discriminator": true,
                "Attribute": {
                    "_media-type": "application/vnd.ibexa.api.Attribute+json",
                    "identifier": "size",
                    "name": "Size",
                    "description": "",
                    "type": "Integer",
                    "type_identifier": "integer",
                    "value": 5,
                    "group": "Hat",
                    "position": 0,
                    "options": []
                }
            }
        ]
    }
}
View more
Delete product type

DELETE /product/catalog/product_types/{id}

Deletes the given product type.

Possible responses
Code Description
204

No content - the given product type is deleted.
401

Error - the user is not authorized to delete this product type.

/product/catalog/product_types/view

Filter product types

POST /product/catalog/product_types/view

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

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductTypeView+xml application/vnd.ibexa.api.ProductTypeView+json

Content-Type

The view input in XML or JSON format.

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

400

Error - the input does not match the input schema definition.
Types
Type Description
ProductTypeViewInput This class represents a product type view input.
ProductTypeViewInputWrapper JSON object with only a ViewInput property.
ProductTypeView This class represents a product type view.
ProductTypeViewWrapper JSON object with only a ProductTypeView property.

file_copy 

                                {
    "ViewInput": {
        "identifier": "TitleView",
        "ProductTypeQuery": {
            "limit": "10",
            "offset": "0",
            "name_prefix": "new"
        }
    }
}
View more
Code: 200

file_copy 

                                {
    "ProductTypeView": {
        "_media-type": "application/vnd.ibexa.api.ProductTypeView+json",
        "identifier": "TitleView",
        "ProductTypeQuery": {
            "_media-type": "application/vnd.ibexa.api.ProductTypeQuery+json"
        },
        "Result": {
            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
            "count": 1,
            "ProductTypeList": {
                "_media-type": "application/vnd.ibexa.api.ProductTypeList+json",
                "ProductType": [
                    {
                        "_media-type": "application/vnd.ibexa.api.ProductType+json",
                        "identifier": "climbing_shoe",
                        "name": "New Product Type",
                        "AttributeAssignmentList": [
                            {
                                "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
                                "is_required": false,
View more

/product/catalog/products

/product/catalog/products

Load products list (deprecated)

GET /product/catalog/products

Returns a list of products. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/products/view instead.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ProductList+json

Content-Type

The product list schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductListGet+json
Possible responses
Code Description
200

401

Error - the user has no permission to read product.
Types
Type Description
ProductListGetWrapper JSON object with only a ProductListGet property.
ProductListWrapper JSON object with only a ProductList property.

file_copy 

                                {
    "ProductListGet": {
        "offset": 0, 
        "limit": 10,
        "languages": ["eng-GB"] 
    }
}
View more
Code: 200

file_copy 

                                {
    "ProductList": {
        "_media-type": "application/vnd.ibexa.api.ProductList+json",
        "Product": [
            {
                "_media-type": "application/vnd.ibexa.api.Product+json",
                "code": "wsk_98845",
                "name": "HUMMINGBIRD PRO DRY 9,2MM",
                "ProductType": {
                    "_media-type": "application/vnd.ibexa.api.ProductType+json",
                    "identifier": "d_rope",
                    "name": "Dynamic ropes",
                    "AttributeAssignmentList": []
                },
                "Thumbnail": {
                    "_media-type": "application/vnd.ibexa.api.Thumbnail+json",
                    "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file",
                    "width": null,
                    "height": null,
                    "mimeType": "image/svg+xml"
                },
                "created_at": 1645787815,
                "updated_at": 1645787815,
                "Attribu
View more

/product/catalog/products/{productTypeIdentifier}

Create product

POST /product/catalog/products/{productTypeIdentifier}

Creates a new product.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ProductCreate+json

Content-Type

The product schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductCreate+json
Possible responses
Code Description
201

400

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

Error - the user is not authorized to update this product.
403

Error - a product with the same name already exists.
404

Error - no product with the given code exists.
Types
Type Description
ProductCreateWrapper JSON object with only a ProductCreate property.
ProductWrapper JSON object with only a Product property.

file_copy 

                                {
    "ProductCreate": {
        "ContentCreate": {
            "ContentType": {
                "_href": "/api/ibexa/v2/content/types/46",
                "FieldDefinitions": {
                    "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json",
                    "_href": "/api/ibexa/v2/content/types/260/fieldDefinitions",
                    "FieldDefinition": []
                }
            },
            "LocationCreate": {
                "ParentLocation": {
                    "_href": "/api/ibexa/v2/content/locations/1/2"
                },
                "priority": "0",
                "hidden": "false",
                "sortField": "PATH",
                "sortOrder": "ASC"
            },
            "alwaysAvailable": "true",
            "fields": {
                "field": [
                    {
                        "fieldDefinitionIdentifier": "name",
                        "languageCode": "eng-GB",
                        "fieldTypeIdentifier"
View more
Code: 201

file_copy 

                                {
    "Product": {
        "_media-type": "application/vnd.ibexa.api.Product+json",
        "code": "DRESUN",
        "name": "Yellow sundress",
        "ProductType": {
            "_media-type": "application/vnd.ibexa.api.ProductType+json",
            "identifier": "dress",
            "name": "Dress",
            "AttributeAssignmentList": [
                {
                    "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
                    "is_required": false,
                    "is_discriminator": false,
                    "Attribute": {
                        "_media-type": "application/vnd.ibexa.api.Attribute+json",
                        "identifier": "size",
                        "name": "Size",
                        "description": "",
                        "type": "Integer",
                        "type_identifier": "integer",
                        "value": 5,
                        "group": "Hat",
                        "position":
View more

/product/catalog/products/{identifier}

Delete product

DELETE /product/catalog/products/{identifier}

Deletes the given product.

Possible responses
Code Description
204

No content - the given product is deleted.
401

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

/product/catalog/products/{code}

Load the given product

GET /product/catalog/products/{code}

Loads the given product.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.Product+json

Content-Type

An optional product schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductGet+json
Possible responses
Code Description
200

401

Error - the user is not authorized to view this product.
404

Error - no product with the given code exists.
Types
Type Description
ProductGetWrapper JSON object with only a ProductGet property.
ProductWrapper JSON object with only a Product property.

file_copy 

                                {
    "ProductGet": {
        "languages": [
            "eng-GB"
        ]
    }
}
View more
Code: 200

file_copy 

                                {
    "Product": {
        "_media-type": "application/vnd.ibexa.api.Product+json",
        "code": "DRESUN",
        "name": "Yellow sundress",
        "ProductType": {
            "_media-type": "application/vnd.ibexa.api.ProductType+json",
            "identifier": "dress",
            "name": "Dress",
            "AttributeAssignmentList": [
                {
                    "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
                    "is_required": false,
                    "is_discriminator": false,
                    "Attribute": {
                        "_media-type": "application/vnd.ibexa.api.Attribute+json",
                        "identifier": "size",
                        "name": "Size",
                        "description": "",
                        "type": "Integer",
                        "type_identifier": "integer",
                        "value": 5,
                        "group": "Hat",
                        "position":
View more
Update product

PATCH /product/catalog/products/{code}

Updates product.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ProductUpdate+json

Content-Type

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

Property Value
Type string
Examples application/vnd.ibexa.api.ProductUpdate+json
Possible responses
Code Description
201

400

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

Error - the user is not authorized to update this product.
403

Error - a product with the same code already exists.
404

Error - no product with the given code exists.
Types
Type Description
ProductUpdateWrapper JSON object with only a ProductUpdate property.
ProductWrapper JSON object with only a Product property.

file_copy 

                                {
    "ProductUpdate": {
        "ContentUpdate": {
              "__url": "/api/ibexa/v2/content/objects/67",
              "fields": {
                  "field": [
                                {
                                    "fieldDefinitionIdentifier": "name",
                                    "languageCode": "eng-GB",
                                    "fieldTypeIdentifier": "ezstring",
                                    "fieldValue": "IN6.1200tze205"
                                }
                           ]
               }
         },
        "code": "NEWCODE"
    }
}
View more
Code: 201

file_copy 

                                {
    "Product": {
        "_media-type": "application/vnd.ibexa.api.Product+json",
        "code": "bbbb",
        "name": "fgh",
        "ProductType": {
            "_media-type": "application/vnd.ibexa.api.ProductType+json",
            "identifier": "test_pt321",
            "name": "New Product Type",
            "AttributeAssignmentList": [
                {
                    "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
                    "is_required": false,
                    "is_discriminator": true,
                    "Attribute": {
                        "_media-type": "application/vnd.ibexa.api.Attribute+json",
                        "identifier": "testAttr",
                        "name": "testAttr",
                        "description": "",
                        "type": "Checkbox",
                        "type_identifier": "checkbox",
                        "value": true,
                        "group": "Test Attribute group",
View more

/product/catalog/products/{code}/prices

Load the list of product prices

GET /product/catalog/products/{code}/prices

Loads the list of product prices.

Header parameters

Accept

PriceList - if set, the product price list is returned in JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.PriceList+json
Possible responses
Code Description
200

OK - loads the list of product prices.
401

Error - the user has no permission to read prices.
Types
Type Description
PriceListWrapper JSON object with only a PriceList property.
Code: 200

file_copy 

                                {
    "PriceList": {
        "_media-type": "application/vnd.ibexa.api.PriceList+json",
        "prices": [
            {
                "_media-type": "application/vnd.ibexa.api.Price+json",
                "id": 1,
                "amount": "12.00",
                "base_amount": "12.00",
                "Currency": {
                    "_media-type": "application/vnd.ibexa.api.Currency+json",
                    "id": 2,
                    "code": "EUR",
                    "subunits": 2,
                    "enabled": true
                },
                "money": "1200",
                "base_money": "1200"
            },
            {
                "_media-type": "application/vnd.ibexa.api.Price+json",
                "id": 2,
                "amount": "12.00",
                "base_amount": "12.00",
                "Currency": {
                    "_media-type": "application/vnd.ibexa.api.Currency+json",
                    "id": 5,
                    "code": "USD",
View more
Create product price or custom price

POST /product/catalog/products/{code}/prices

Create product price or custom price.

Header parameters

Accept

The product price schema encoded in JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.Price+json application/vnd.ibexa.api.CustomPrice+json

Content-Type

If set, the new price is returned in JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.PriceCreateStruct+json application/vnd.ibexa.api.CustomPriceCreateStruct+json
Possible responses
Code Description
200

OK - creates product price.
400

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

Error - the user is not authorized to create this price.
Types
Type Description
PriceCreateStructWrapper JSON object with only a PriceCreateStruct property.
CustomPriceCreateStructWrapper JSON object with only a CustomPriceCreateStruct property.
PriceWrapper JSON object with only a Price property.
CustomPriceWrapper JSON object with only a CustomPrice property.

file_copy 

                                {
  "PriceCreateStruct": {
    "amount": 9,
    "currency": "CHF"
  }
}
View more

file_copy 

                                {
  "CustomPriceCreateStruct": {
    "customerGroup": "test",
    "amount": 2500,
    "customAmount": 1500,
    "currency": "EUR"
  }
}
View more
Code: 200

file_copy 

                                {
    "Price": {
        "_media-type": "application/vnd.ibexa.api.Price+json",
        "id": 4,
        "amount": "0.09",
        "base_amount": "0.09",
        "Currency": {
            "_media-type": "application/vnd.ibexa.api.Currency+json",
            "id": 94,
            "code": "CHF",
            "subunits": 2,
            "enabled": true
        },
        "money": "9",
        "base_money": "9"
    }
}
View more

file_copy 

                                {
    "CustomPrice": {
        "_media-type": "application/vnd.ibexa.api.CustomPrice+json",
        "id": 5,
        "amount": "15.00",
        "base_amount": "25.00",
        "Currency": {
            "_media-type": "application/vnd.ibexa.api.Currency+json",
            "id": 2,
            "code": "EUR",
            "subunits": 2,
            "enabled": true
        },
        "money": "1500",
        "base_money": "2500",
        "custom_money": "1500",
        "custom_amount": "15.00"
    }
}
View more

/product/catalog/products/{code}/prices/{currencyCode}

Get price in given currency

GET /product/catalog/products/{code}/prices/{currencyCode}

Get price in given currency.

Header parameters

Accept

If set, gets price in given currency in JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.Price+json
Possible responses
Code Description
200

OK - gets price in given currency.
401

Error - the user has no permission to read prices.
404

Error - the price does not exist.
Types
Type Description
PriceWrapper JSON object with only a Price property.
Code: 200

file_copy 

                                {
    "Price": {
        "_media-type": "application/vnd.ibexa.api.Price+json",
        "id": 1,
        "amount": "12.00",
        "base_amount": "12.00",
        "Currency": {
            "_media-type": "application/vnd.ibexa.api.Currency+json",
            "id": 2,
            "code": "EUR",
            "subunits": 2,
            "enabled": true
        },
        "money": "1200",
        "base_money": "1200"
    }
}
View more

/product/catalog/products/{code}/prices/{currencyCode}/customer-group/{customerGroupIdentifier}

Get price in given currency and customer group

GET /product/catalog/products/{code}/prices/{currencyCode}/customer-group/{customerGroupIdentifier}

Get price in given currency and customer group.

Header parameters

Accept

If set, gets price in given currency and customer group in JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.CustomPrice+json
Possible responses
Code Description
200

OK - gets price in given currency and customer group.
401

Error - the user has no permission to read prices.
404

Error - the price does not exist.
Types
Type Description
CustomPriceWrapper JSON object with only a CustomPrice property.
Code: 200

file_copy 

                                {
    "CustomPrice": {
        "_media-type": "application/vnd.ibexa.api.CustomPrice+json",
        "id": 3,
        "amount": "11.50",
        "base_amount": "10.00",
        "Currency": {
            "_media-type": "application/vnd.ibexa.api.Currency+json",
            "id": 5,
            "code": "USD",
            "subunits": 2,
            "enabled": true
        },
        "money": "1150",
        "base_money": "1000",
        "custom_money": "1150",
        "custom_amount": "11.50",
        "custom_rule": "15.00"
    }
}
View more

/product/catalog/products/{code}/prices/{id}

Delete product price

DELETE /product/catalog/products/{code}/prices/{id}

Deletes product price.

Header parameters

Accept

If set, deletes price of given id.

Property Value
Type string
Examples application/vnd.ibexa.api.PriceDelete+json

Content-Type

Delete product price.

Property Value
Type string
Examples application/vnd.ibexa.api.PriceDelete+json
Possible responses
Code Description
200

No content - the given price is deleted.
401

Error - the user is not authorized to delete this price.
Update product price

PATCH /product/catalog/products/{code}/prices/{id}

Updates product price.

Header parameters

Accept

If set, updates product price.

Property Value
Type string
Examples application/vnd.ibexa.api.Price+json application/vnd.ibexa.api.CustomPrice+json

Content-Type

Update price or custom price for given currency.

Property Value
Type string
Examples application/vnd.ibexa.api.PriceUpdateStruct+json application/vnd.ibexa.api.CustomPriceUpdateStruct+json
Possible responses
Code Description
200

OK - updates product price.
400

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

Error - the user is not authorized to update this price.
Types
Type Description
PriceUpdateStructWrapper JSON object with only a PriceUpdateStruct property.
CustomPriceUpdateStructWrapper JSON object with only a CustomPriceUpdateStruct property.
PriceWrapper JSON object with only a Price property.
CustomPriceWrapper JSON object with only a CustomPrice property.

file_copy 

                                {
  "PriceUpdateStruct": {
    "amount": 3500,
    "currency": "USD"
  }
}
View more

file_copy 

                                {
  "CustomPriceUpdateStruct": {
    "amount": 2500,
    "customAmount": 1700,
    "currency": "USD"
  }
}
View more
Code: 200

file_copy 

                                {
    "Price": {
        "_media-type": "application/vnd.ibexa.api.Price+json",
        "id": 2,
        "amount": "35.00",
        "base_amount": "35.00",
        "Currency": {
            "_media-type": "application/vnd.ibexa.api.Currency+json",
            "id": 5,
            "code": "USD",
            "subunits": 2,
            "enabled": true
        },
        "money": "3500",
        "base_money": "3500"
    }
}
View more

file_copy 

                                {
    "CustomPrice": {
        "_media-type": "application/vnd.ibexa.api.CustomPrice+json",
        "id": 3,
        "amount": "17.00",
        "base_amount": "35.00",
        "Currency": {
            "_media-type": "application/vnd.ibexa.api.Currency+json",
            "id": 5,
            "code": "USD",
            "subunits": 2,
            "enabled": true
        },
        "money": "1700",
        "base_money": "3500",
        "custom_money": "1700",
        "custom_amount": "17.00",
        "custom_rule": null
    }
}
View more

/product/catalog/products/view

Filter products

POST /product/catalog/products/view

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

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductView+xml application/vnd.ibexa.api.ProductView+json

Content-Type

The view input in XML or JSON format.

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

400

Error - the input does not match the input schema definition.
Types
Type Description
ProductViewInput This class represents a product view input.
ProductViewInputWrapper JSON object with only a ViewInput property.
ProductView This class represents a product view.
ProductViewWrapper JSON object with only a ProductView property.

file_copy 

                                {
    "ViewInput": {
        "identifier": "TitleView",
        "ProductQuery": {
            "limit": "10",
            "offset": "0",
            "Filter": {
                "ProductTypeCriterion": "desk",
                "ProductAvailabilityCriterion": false
            },
            "SortClauses": {
                "ProductName": "descending"
            },
            "Aggregations": [
                {
                    "ProductPriceRange": {
                        "name": "price",
                        "currencyCode": "EUR",
                        "ranges": [
                            {"from": 0, "to": 10000},
                            {"from": 10000, "to": null}
                        ]
                    }
                }
            ]
        }
    }
}
View more
Code: 200

file_copy 

                                {
    "ProductView": {
        "_media-type": "application/vnd.ibexa.api.ProductView+json",
        "identifier": "TitleView",
        "ProductQuery": {
            "_media-type": "application/vnd.ibexa.api.ProductQuery+json"
        },
        "Result": {
            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
            "count": 2,
            "ProductList": {
                "_media-type": "application/vnd.ibexa.api.ProductList+json",
                "Product": [
                    {
                        "_media-type": "application/vnd.ibexa.api.Product+json",
                        "code": "OTHER",
                        "isBaseProduct": false,
                        "isVariant": false,
                        "name": "Other Office Desk",
                        "ProductType": {
                            "_media-type": "application/vnd.ibexa.api.ProductType+json",
                            "identifier": "desk",
                            "name": "Desk",
View more

/product/catalog/product_variants

/product/catalog/product_variants/{baseProductCode}

Create product variant

POST /product/catalog/product_variants/{baseProductCode}

Creates a new product variant.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ProductVariantCreate+json

Content-Type

The product variant schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductVariantCreate+json
Possible responses
Code Description
201

No content - product variant is created.
400

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

Error - the user is not authorized to create this product variant.
403

Error - a product variant with the same name already exists.
404

Error - no base product with the given code exists.
Types
Type Description
ProductVariantCreateWrapper JSON object with only a ProductVariantCreate property.

file_copy 

                                {
    "ProductVariantCreate": {
        "attributes": {
            "width": 100,
            "height": 50,
            "color": "#000000"
        },
        "code": "macbook_pro"
    }
}
View more

/product/catalog/product_variants/generate/{baseProductCode}

Generate product variants

POST /product/catalog/product_variants/generate/{baseProductCode}

Generates new product variants based on selected (discriminator) attributes.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ProductVariantGenerate+json

Content-Type

The product variant schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductVariantGenerate+json
Possible responses
Code Description
201

No content - product variants are generated.
400

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

Error - the user is not authorized to create this product variant.
403

Error - a product variant with the same name already exists.
404

Error - no base product with the given code exists.
Types
Type Description
ProductVariantGenerateWrapper JSON object with only a ProductVariantGenerate property.

file_copy 

                                {
    "ProductVariantGenerate": {
        "attributes": {
            "width": [
                123
            ],
            "colors": [
                "#000000", "#ffffff", "#d4d400", "#ff0000"
            ]
        }
    }
}
View more

/product/catalog/product_variants/{code}

Delete product variant

DELETE /product/catalog/product_variants/{code}

Deletes the given product variant.

Possible responses
Code Description
204

No content - product variant is deleted.
401

Error - the user is not authorized to delete this product variant.
Update product variant

PATCH /product/catalog/product_variants/{code}

Updates product variant.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ProductVariant+json

Content-Type

The product variant update schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductVariantUpdate+json
Possible responses
Code Description
201

400

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

Error - the user is not authorized to update this product variant.
403

Error - a product variant with the same code already exists.
404

Error - no product variant with the given code exists.
Types
Type Description
ProductVariantUpdateWrapper JSON object with only a ProductVariantUpdate property.
ProductVariantWrapper JSON object with only a ProductVariant property.

file_copy 

                                {
    "ProductVariantUpdate": {
        "code": "test",
        "attributes": {
            "number": 2.0,
            "testattr": 10
        }
    }
}
View more
Code: 201

file_copy 

                                {
    "ProductVariant": {
        "_media-type": "application/vnd.ibexa.api.ProductVariant+json",
        "code": "test",
        "name": "Macbook Air ",
        "Product": {
            "_media-type": "application/vnd.ibexa.api.Product+json",
            "code": "mac_air",
            "name": "Macbook Air",
            "ProductType": {
                "_media-type": "application/vnd.ibexa.api.ProductType+json",
                "identifier": "laptop",
                "name": "Laptop",
                "AttributeAssignmentList": [
                    {
                        "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
                        "is_required": false,
                        "is_discriminator": true,
                        "Attribute": {
                            "_media-type": "application/vnd.ibexa.api.Attribute+json",
                            "identifier": "number",
                            "name": "number",
                            "d
View more

/product/catalog/product_variants/view/{baseProductCode}

Filter product variants

POST /product/catalog/product_variants/view/{baseProductCode}

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

Header parameters

Accept

The view in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ProductVariantView+xml application/vnd.ibexa.api.ProductVariantView+json

Content-Type

The view input in XML or JSON format.

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

400

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

Error - the base product does not exist.
Types
Type Description
ProductVariantViewInput This class represents a product variant view input.
ProductVariantViewInputWrapper JSON object with only a ViewInput property.
ProductVariantView This class represents a product variant view.
ProductVariantViewWrapper JSON object with only a ProductVariantView property.

file_copy 

                                {
    "ViewInput": {
        "identifier": "TitleView",
        "ProductVariantQuery": {
            "offset": "0",
            "limit": "10"
        }
    }
}
View more
Code: 200

file_copy 

                                {
    "ProductVariantView": {
        "_media-type": "application/vnd.ibexa.api.ProductVariantView+json",
        "identifier": "TitleView",
        "ProductVariantQuery": {
            "_media-type": "application/vnd.ibexa.api.ProductVariantQuery+json"
        },
        "Result": {
            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
            "count": 2,
            "ProductVariantList": {
                "_media-type": "application/vnd.ibexa.api.ProductVariantList+json",
                "ProductVariant": [
                    {
                        "_media-type": "application/vnd.ibexa.api.ProductVariant+json",
                        "code": "test",
                        "name": "Macbook Air 2/10",
                        "Product": {
                            "_media-type": "application/vnd.ibexa.api.Product+json",
                            "code": "mac_air",
                            "name": "Macbook Air",
                            "ProductType"
View more

/product/catalog/product_variant

/product/catalog/product_variant/{code}

Load product variant

GET /product/catalog/product_variant/{code}

Loads the given product variant.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ProductVariant+json
Possible responses
Code Description
200

401

Error - the user is not authorized to view this product variant.
404

Error - no product variant with the given code exists.
Types
Type Description
ProductVariantWrapper JSON object with only a ProductVariant property.
Code: 200

file_copy 

                                {
    "ProductVariant": {
        "_media-type": "application/vnd.ibexa.api.ProductVariant+json",
        "code": "macbook",
        "name": "Macbook Air 32/232",
        "Product": {
            "_media-type": "application/vnd.ibexa.api.Product+json",
            "code": "mac_air",
            "name": "Macbook Air",
            "ProductType": {
                "_media-type": "application/vnd.ibexa.api.ProductType+json",
                "identifier": "laptop",
                "name": "Laptop",
                "AttributeAssignmentList": [
                    {
                        "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
                        "is_required": false,
                        "is_discriminator": true,
                        "Attribute": {
                            "_media-type": "application/vnd.ibexa.api.Attribute+json",
                            "identifier": "number",
                            "name": "number",
View more

/product/catalog/vat

/product/catalog/vat/{region}

Load VAT region

GET /product/catalog/vat/{region}

Loads a VAT category for the given region.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.VatCategoryList+json
Possible responses
Code Description
200

401

Error - the user is not authorized to read this object.
404

Error - the VAT category region does not exist.
Types
Type Description
VatCategoryListWrapper JSON object with only a VatCategoryList property.
Code: 200

file_copy 

                                {
    "VatCategoryList": {
        "_media-type": "application/vnd.ibexa.api.VatCategoryList+json",
        "VatCategory": [
            {
                "_media-type": "application/vnd.ibexa.api.VatCategory+json",
                "identifier": "standard",
                "region": "region_1",
                "vatValue": 18
            },
            {
                "_media-type": "application/vnd.ibexa.api.VatCategory+json",
                "identifier": "reduced",
                "region": "region_1",
                "vatValue": 6
            },
            {
                "_media-type": "application/vnd.ibexa.api.VatCategory+json",
                "identifier": "none",
                "region": "region_1",
                "vatValue": null
            }
        ]
    }
}
View more

/product/catalog/vat/{region}/{identifier}

Load VAT specific region

GET /product/catalog/vat/{region}/{identifier}

Loads a VAT category for the given identifier.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.VatCategory+json
Possible responses
Code Description
200

401

Error - the user is not authorized to read this object.
404

Error - the VAT category for the given identifier not exists.
Types
Type Description
VatCategoryWrapper JSON object with only a VatCategory property.
Code: 200

file_copy 

                                {
    "VatCategory": {
        "_media-type": "application/vnd.ibexa.api.VatCategory+json",
        "identifier": "standard",
        "region": "region_1",
        "vatValue": 18
    }
}
View more

Taxonomy

/taxonomy/{taxonomyName}/entry/{id}

Get Entry by ID

GET /taxonomy/{taxonomyName}/entry/{id}

Loads taxonomy Entry by its Entry ID.

Header parameters

Accept

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

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

OK - returns the taxonomy Entry.
401

Error - the user is not authorized to read this Entry.
404

Error - the Entry does not exists.
Types
Type Description
TaxonomyEntry This class represents a taxonomy entry.
TaxonomyEntryWrapper JSON object with only a TaxonomyEntry property.

/taxonomy/{taxonomyName}/entry/identifier/{identifier}

Get Entry by identifier

GET /taxonomy/{taxonomyName}/entry/identifier/{identifier}

Loads taxonomy Entry by its Entry identifier.

Header parameters

Accept

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

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

OK - returns the taxonomy Entry.
401

Error - the user is not authorized to read this Entry.
404

Error - the Entry does not exists.
Types
Type Description
TaxonomyEntry This class represents a taxonomy entry.
TaxonomyEntryWrapper JSON object with only a TaxonomyEntry property.

/taxonomy/{taxonomyName}/entry/content-id/{contentId}

Get Entry by Content ID

GET /taxonomy/{taxonomyName}/entry/content-id/{contentId}

Loads taxonomy Entry by its Content ID.

Header parameters

Accept

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

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

OK - returns the taxonomy Entry.
401

Error - the user is not authorized to read this Entry.
404

Error - the Entry does not exists.
Types
Type Description
TaxonomyEntry This class represents a taxonomy entry.
TaxonomyEntryWrapper JSON object with only a TaxonomyEntry property.

/taxonomy/{taxonomyName}/entries

Delete Entries

DELETE /taxonomy/{taxonomyName}/entries

Bulk removes several taxonomy entries.

Header parameters

Content-Type

Target Entries schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.TaxonomyEntryBulkRemove+xml application/vnd.ibexa.api.TaxonomyEntryBulkRemove+json
Possible responses
Code Description
204

No Content - The entries have been deleted.
400

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

Error - The user is not authorized to delete some of the entries.
Types
Type Description
TaxonomyEntryBulkRemove This class is used to bulk remove taxonomy entries.
TaxonomyEntryBulkRemoveWrapper JSON object with only a TaxonomyEntryBulkRemove property.

file_copy 

                                {
    "TaxonomyEntryBulkRemove": {
        "entries": [ 2, 3 ]
    }
}
View more

/taxonomy/{taxonomyName}/entries/move

Move Entries

POST /taxonomy/{taxonomyName}/entries/move

Bulk move several taxonomy entries relative to sibling.

Header parameters

Content-Type

The Entry moves schema encoded in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.TaxonomyEntryBulkMove+xml application/vnd.ibexa.api.TaxonomyEntryBulkMove+json
Possible responses
Code Description
204

No Content - The entries have been moved.
400

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

Error - The user is not authorized to move some of the entries.
404

Error - Some to-be-moved or sibling entries do not exist.
Types
Type Description
TaxonomyEntryBulkMove This class is used to bulk move taxonomy entries.
TaxonomyEntryBulkMoveWrapper JSON object with only a TaxonomyEntryBulkMove property.

file_copy 

                                {
    "TaxonomyEntryBulkMove": {
        "entries": [
            {
                "entry": 2,
                "sibling": 1,
                "position": "next"
            },
            {
                "entry": 3,
                "sibling": 1,
                "position": "prev"
            }
        ]
    }
}
View more

/taxonomy/{taxonomyName}/entry-assignment/{id}

Get Assignment by ID

GET /taxonomy/{taxonomyName}/entry-assignment/{id}

Gets taxonomy entry Assignment by its ID.

Header parameters

Accept

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

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

OK - returns the taxonomy entry Assignment.
404

Error - the assignment does not exist.
Types
Type Description
TaxonomyEntryAssignment This class represents a taxonomy entry assignment.
TaxonomyEntryAssignmentWrapper JSON object with only a TaxonomyEntryAssignment property.

/taxonomy/{taxonomyName}/entry-assignments/assign-to-content

Assign entry

POST /taxonomy/{taxonomyName}/entry-assignments/assign-to-content

Assigns taxonomy entry to a content item.

Header parameters

Content-Type

Property Value
Type string
Examples application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json
Possible responses
Code Description
201

No Content.
400

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

Error - the user is not authorized to assign this Entry.
Types
Type Description
TaxonomyEntryAssignToContentWrapper JSON object with only a TaxonomyEntryAssignToContent property.

file_copy 

                                {
    "TaxonomyEntryAssignToContent": {
        "content": 130,
        "entries": 
        [
            2, 3
        ]
    }
}
View more

/taxonomy/{taxonomyName}/entry-assignments/unassign-from-content

Unassign entry

POST /taxonomy/{taxonomyName}/entry-assignments/unassign-from-content

Unassigns taxonomy entry from a content item.

Header parameters

Content-Type

Property Value
Type string
Examples application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json
Possible responses
Code Description
201

No Content.
400

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

Error - the user is not authorized to unassign this entry.
Types
Type Description
TaxonomyEntryUnassignFromContentWrapper JSON object with only a TaxonomyEntryUnassignFromContent property.

file_copy 

                                {
    "TaxonomyEntryUnassignFromContent": {
        "content": 130,
        "entries": 
        [
            2, 3
        ]
    }
}
View more

/taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId}

Get Assignments to a Content

GET /taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId}

Gets taxonomy entries assigned to a content item by its ID.

Header parameters

Accept

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

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

OK - returns the assigment collection.
404

Error - the Content does not exists.
Types
Type Description
EntryAssignmentCollection This class represents a taxonomy assignment collection.
EntryAssignmentCollectionWrapper JSON object with only a EntryAssignmentCollection property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<EntryAssignmentCollection media-type="application/vnd.ibexa.api.EntryAssignmentCollection+xml">
    <content media-type="application/vnd.ibexa.api.Content+xml">
        <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/1" remoteId="9459d3c29e15006e45197295722c7ade" id="1">
            <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/>
            <Name>Ibexa Platform</Name>
            <TranslatedName>Ibexa Platform</TranslatedName>
            <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/1/versions"/>
            <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/1/currentversion"/>
            <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/>
            <Locations media-type="applic
View more

file_copy 

                                {
  "EntryAssignmentCollection": {
    "_media-type": "application/vnd.ibexa.api.EntryAssignmentCollection+json",
    "content": {
      "_media-type": "application/vnd.ibexa.api.Content+json",
      "Content": {
        "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
        "_href": "/api/ibexa/v2/content/objects/1",
        "_remoteId": "9459d3c29e15006e45197295722c7ade",
        "_id": 1,
        "ContentType": {
          "_media-type": "application/vnd.ibexa.api.ContentType+json",
          "_href": "/api/ibexa/v2/content/types/1"
        },
        "Name": "Ibexa Platform",
        "TranslatedName": "Ibexa Platform",
        "Versions": {
          "_media-type": "application/vnd.ibexa.api.VersionList+json",
          "_href": "/api/ibexa/v2/content/objects/1/versions"
        },
        "CurrentVersion": {
          "_media-type": "application/vnd.ibexa.api.Version+json",
          "_href": "/api/ibexa/v2/content/objects/1/currentversion"
        },
        "Sectio
View more

Monitoring activity

/activity-log-group/list

List of activity log groups

GET /activity-log-group/list

Lists last activity log groups and their entries.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ActivityLogGroupList+xml application/vnd.ibexa.api.ActivityLogGroupList+json
Query parameters
Property Type Value
offset string

(default: offset=0)
limit string

Maximum number of returned log groups (default: limit=25)

Example: limit=10
filter

List of filters (no filter by default). A filter is a type and parameters depending on this type.

  • type: object_class, parameter: class (a FQCN)
  • type: action, parameter: value (the action)
  • type: logged_at, parameters: value and operator
    • logged_at value value can be anything accepted by DateTimeImmutable
    • logged_at operator value can be one of the following:
Comparison Value
Equal =
Not equal <>
Less than <
Less than or equal <=
Greater than >
Greater than or equal >=

Example: filter[0][type]=object_class&filter[0][class]=Ibexa\Contracts\Core\Repository\Values\Content\Content&filter[1][type]=action&filter[1][value]=create&filter[2][type]=logged_at&filter[2][value]=-1hour&filter[2][operator]=>=
sort

List of sort clause and direction pairs (default: sort[0][type]=logged_at&sort[0][direction]=ASC)

Example: sort[0][type]=logged_at&sort[0][direction]=DESC
Possible responses
Code Description
200

401

Error - the user is not authorized to list activities.
Types
Type Description
ActivityLogGroupList This class represents activity log context groups
ActivityLogGroupListWrapper JSON object with only a ActivityLogGroupList property.
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ActivityLogGroupList media-type="application/vnd.ibexa.api.ActivityLogGroupList+xml" href="/api/ibexa/v2/activity-log-group/list">
 <ActivityLogGroup media-type="application/vnd.ibexa.api.ActivityLogGroup+xml">
  <user_id>14</user_id>
  <logged_at>1707478796</logged_at>
  <ActivityLog media-type="application/vnd.ibexa.api.ActivityLog+xml">
   <object_id>396</object_id>
   <object_class>Ibexa\Contracts\Core\Repository\Values\Content\Content</object_class>
   <action>create</action>
   <data/>
  </ActivityLog>
  <ActivityLog media-type="application/vnd.ibexa.api.ActivityLog+xml">
   <object_id>396</object_id>
   <object_class>Ibexa\Contracts\Core\Repository\Values\Content\Content</object_class>
   <action>publish</action>
   <data/>
  </ActivityLog>
 </ActivityLogGroup>
 <ActivityLogGroup media-type="application/vnd.ibexa.api.ActivityLogGroup+xml">
  <user_id>14</user_id>
  <logged_at>1707475048</logged_at>
  <ActivityLog media-type="application/vn
View more

file_copy 

                                {
    "ActivityLogGroupList": {
        "_media-type": "application\/vnd.ibexa.api.ActivityLogGroupList+json",
        "_href": "\/api\/ibexa\/v2\/activity-log-group\/list",
        "ActivityLogGroups": [
            {
                "_media-type": "application\/vnd.ibexa.api.ActivityLogGroup+json",
                "user_id": 14,
                "logged_at": 1707478796,
                "ActivityLogEntries": [
                    {
                        "_media-type": "application\/vnd.ibexa.api.ActivityLog+json",
                        "object_id": "396",
                        "object_class": "Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content",
                        "action": "create",
                        "data": {}
                    },
                    {
                        "_media-type": "application\/vnd.ibexa.api.ActivityLog+json",
                        "object_id": "396",
                        "object_class": "Ibexa\\Contracts\\Core\\Repository\
View more
List of filtered activity log groups

POST /activity-log-group/list

Lists activity log groups of entries filtered according to the input payload. List input reflects the criteria model of the PHP API. See Activity Log Search reference.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ActivityLogGroupList+xml application/vnd.ibexa.api.ActivityLogGroupList+json

Content-Type

The ActivityLogListInput query schema encoded in XML or JSON format.

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

401

Error - the user is not authorized to list activities.
Types
Type Description
ActivityLogGroupListInput This class represents the activity log group search query's criteria and sort clauses.
ActivityLogGroupListInputWrapper JSON object with only a ActivityLogGroupListInput property.
ActivityLogGroupList This class represents activity log context groups
ActivityLogGroupListWrapper JSON object with only a ActivityLogGroupList property.

file_copy 

                                <?xml version="1.0" encoding="UTF-8" ?>
<ActivityLogListInput>
    <offset>0</offset>
    <limit>10</limit>
    <criteria>
        <criterion type="object_class">
            <class>Ibexa\Contracts\Core\Repository\Values\Content\Content</class>
        </criterion>
        <criterion type="action">
            <value>create</value>
        </criterion>
        <criterion type="logged_at">
            <value>- 1 hour</value>
            <operator>&gt;=</operator>
        </criterion>
    </criteria>
    <sortClauses>
        <sortClause type="logged_at">DESC</sortClause>
    </sortClauses>
</ActivityLogListInput>
View more

file_copy 

                                {
    "ActivityLogGroupListInput": {
        "offset": 0,
        "limit": 10,
        "criteria": [
            {"type": "object_class", "class": "Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content"},
            {"type": "action", "value": ["create"]},
            {"type": "logged_at", "value": "- 1 hour", "operator": ">="}
        ],
        "sortClauses": [
            {"type":  "logged_at", "direction": "DESC"}
        ]
    }
}
View more
Code: 200

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ActivityLogGroupList media-type="application/vnd.ibexa.api.ActivityLogGroupList+xml" href="/api/ibexa/v2/activity-log-group/list">
 <ActivityLogGroup media-type="application/vnd.ibexa.api.ActivityLogGroup+xml">
  <user_id>14</user_id>
  <logged_at>1707478796</logged_at>
  <ActivityLog media-type="application/vnd.ibexa.api.ActivityLog+xml">
   <object_id>396</object_id>
   <object_class>Ibexa\Contracts\Core\Repository\Values\Content\Content</object_class>
   <action>create</action>
   <data/>
  </ActivityLog>
  <ActivityLog media-type="application/vnd.ibexa.api.ActivityLog+xml">
   <object_id>396</object_id>
   <object_class>Ibexa\Contracts\Core\Repository\Values\Content\Content</object_class>
   <action>publish</action>
   <data/>
  </ActivityLog>
 </ActivityLogGroup>
 <ActivityLogGroup media-type="application/vnd.ibexa.api.ActivityLogGroup+xml">
  <user_id>14</user_id>
  <logged_at>1707475048</logged_at>
  <ActivityLog media-type="application/vn
View more

file_copy 

                                {
    "ActivityLogGroupList": {
        "_media-type": "application\/vnd.ibexa.api.ActivityLogGroupList+json",
        "_href": "\/api\/ibexa\/v2\/activity-log-group\/list",
        "ActivityLogGroups": [
            {
                "_media-type": "application\/vnd.ibexa.api.ActivityLogGroup+json",
                "user_id": 14,
                "logged_at": 1707478796,
                "ActivityLogEntries": [
                    {
                        "_media-type": "application\/vnd.ibexa.api.ActivityLog+json",
                        "object_id": "396",
                        "object_class": "Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content",
                        "action": "create",
                        "data": {}
                    },
                    {
                        "_media-type": "application\/vnd.ibexa.api.ActivityLog+json",
                        "object_id": "396",
                        "object_class": "Ibexa\\Contracts\\Core\\Repository\
View more

AI actions

/ai/actions/{actionConfiguration}/execute

/ai/actions/{actionConfiguration}/execute

Execute AI Action

POST /ai/actions/{actionConfiguration}/execute

Executes an AI action using the specified Action Configuration identifier.

Header parameters

Accept

Specifies the expected response type. If set, the list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ai.AltText+json application/vnd.ibexa.api.ai.AltText+xml application/vnd.ibexa.api.ai.RefineText+json application/vnd.ibexa.api.ai.RefineText+xml

Content-Type

Specifies the input type.

Property Value
Type string
Examples application/vnd.ibexa.api.ai.GenerateAltText+json application/vnd.ibexa.api.ai.GenerateAltText+xml application/vnd.ibexa.api.ai.RefineText+json application/vnd.ibexa.api.ai.RefineText+xml
Possible responses
Code Description
200

Action executed successfuly.
400

Error - the request is invalid.
401

Error - the user is not authorized to execute an AI action.
404

Error - the given Action Configuration identifier does not exist.
Types
Type Description
GenerateAltTextWrapper JSON object with only the GenerateAltText property.
RefineTextInputWrapper JSON object with only the RefineText property.
AltTextWrapper JSON object with only the AltText property.
RefineTextWrapper JSON object with only the RefineText property.

file_copy 

                                {
    "GenerateAltText": {
        "Image": {
            "base64": "abcdefghijkl"
        },
        "RuntimeContext": {}
    }
}
View more

file_copy 

                                {
    "RefineText": {
        "Text": {
            "text": "Here are the fastest animals on earth: "
        },
        "RuntimeContext": {}
    }
}
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<GenerateAltText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Image>
        <base64>abcdefghijkl</base64>
    </Image>
    <RuntimeContext />
</GenerateAltText>
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RefineText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Text>
        <text>Here are the fastest animals on earth:</text>
    </Text>
    <RuntimeContext />
</RefineText>
View more
Code: 200

file_copy 

                                {
    "AltText": {
        "_media-type": "application/vnd.ibexa.api.ai.AltText+json",
        "Text": {
            "_media-type": "application/vnd.ibexa.api.ai.Text+json",
            "text": [
                "A close-up of a fluffy orange and white cat peacefully grooming itself, its eyes closed and tongue extended. The background is blurred with soft green tones, creating a serene atmosphere."
            ]
        }
    }
}
View more

file_copy 

                                {
    "RefineText": {
        "_media-type": "application/vnd.ibexa.api.ai.RefineText+json",
        "Text": {
            "_media-type": "application/vnd.ibexa.api.ai.Text+json",
            "text": [
                "Here are some of the fastest animals on earth:\n\n1. Peregrine Falcon: Known for its incredible diving speeds, the peregrine falcon can reach speeds of over 240 miles per hour while hunting its prey.\n\n2. Cheetah: With its sleek build and powerful legs, the cheetah is the fastest land animal, reaching speeds of up to 70 miles per hour in short bursts.\n\n3. Sailfish: Considered the fastest swimmer in the ocean, the sailfish can reach speeds of up to 68 miles per hour while hunting for fish.\n\n4. Pronghorn Antelope: Native to North America, the pronghorn antelope is the fastest land mammal in the Western Hemisphere, capable of running at speeds of up to 60 miles per hour.\n\n5. Black Marlin: One of the fastest fish in the sea, the black marlin can swim at speeds of up t
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<AltText media-type="application/vnd.ibexa.api.ai.AltText+xml">
    <Text media-type="application/vnd.ibexa.api.ai.Text+xml">
        <text>A fluffy orange and white cat is lounging while gently licking its paw. The cat's eyes are closed and it appears relaxed, with a soft focus background.</text>
    </Text>
</AltText>
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<RefineText media-type="application/vnd.ibexa.api.ai.RefineText+xml">
    <Text media-type="application/vnd.ibexa.api.ai.Text+xml">
        <text>Here are some of the fastest animals on earth, demonstrating incredible speed and agility in their natural habitats. The cheetah holds the title for the fastest land animal, reaching speeds of up to 70 miles per hour in short bursts. The peregrine falcon is the fastest bird, diving at speeds of over 240 miles per hour while hunting for prey. In the water, the sailfish is known for its impressive speed, swimming at up to 68 miles per hour to catch fish. These animals have adapted to their environments, using their speed to survive and thrive in the wild.</text>
    </Text>
</RefineText>
View more

/ai/actions

/ai/actions

List action configurations

GET /ai/actions

Returns a list of action configurations.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ai.ActionConfigurationList+json application/vnd.ibexa.api.ai.ActionConfigurationList+xml
Query parameters
Property Type Value
limit integer

The number of results per page.
page integer

The page for which the results should be returned.
enabled integer

Return only enabled (1) or disabled (0) action configurations.
action_type_identifier string

Return action configurations for the specified action type identifier.
query string

Return action configurations with identifier matching the given value, or the name starting with given value.
Possible responses
Code Description
200

Types
Type Description
ActionConfigurationListWrapper Wrapper object for a list of action configurations.
Code: 200

file_copy 

                                {
    "ActionConfigurationList": {
        "_media-type": "application/vnd.ibexa.api.ai.ActionConfigurationList+json",
        "_href": "/api/ibexa/v2/ai/actions",
        "ActionConfiguration": [
            {
                "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
                "identifier": "gen_alt_text",
                "name": "Generate alternative text",
                "description": "",
                "enabled": true,
                "ActionType": {
                    "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
                    "identifier": "generate_alt_text",
                    "name": "Generate alternative text",
                    "inputIdentifier": "image",
                    "outputIdentifier": "text",
                    "options": {
                        "width": 512,
                        "height": 512,
                        "image_quality": 85
                    }
                },
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ActionConfigurationList media-type="application/vnd.ibexa.api.ai.ActionConfigurationList+xml" href="/api/ibexa/v2/ai/actions">
    <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml">
        <identifier>gen_alt_text</identifier>
        <name>Generate alternative text</name>
        <description></description>
        <enabled>1</enabled>
        <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
            <identifier>generate_alt_text</identifier>
            <name>Generate alternative text</name>
            <inputIdentifier>image</inputIdentifier>
            <outputIdentifier>text</outputIdentifier>
            <options>
                <width>512</width>
                <height>512</height>
                <image_quality>85</image_quality>
            </options>
        </ActionType>
        <actionTypeOptions>
            <max_length>140</max_length>
        </actionTypeOptions>
View more
List action configurations (POST)

POST /ai/actions

Returns a list of action configurations, the same data as the GET endpoint.

Header parameters

Accept

Specifies the expected response type. If set, the list is returned in XML or JSON format.

Property Value
Type string
Examples application/vnd.ibexa.api.ai.ActionConfigurationList+json application/vnd.ibexa.api.ai.ActionConfigurationList+xml

Content-Type

Specifies the input type.

Property Value
Type string
Examples application/vnd.ibexa.api.ai.ActionConfigurationListInput+json application/vnd.ibexa.api.ai.ActionConfigurationListInput+xml
Possible responses
Code Description
200

Types
Type Description
ActionConfigurationListInputWrapper Wrapper object for ActionConfigurationListInput.
ActionConfigurationListWrapper Wrapper object for a list of action configurations.

file_copy 

                                {
    "ActionConfigurationListInput": {
        "query": "Proofread",
        "action_type_identifier": "refine_text",
        "enabled": true,
        "limit": 10,
        "page": 1
    }
}
View more

file_copy 

                                <ActionConfigurationListInput media-type="application/vnd.ibexa.api.ai.ActionConfigurationListInput+xml">
    <query>Proofread</query>
    <action_type_identifier>refine_text</action_type_identifier>
    <limit>10</limit>
    <enabled>1</enabled>
    <page>1</page>
</ActionConfigurationListInput>
View more
Code: 200

file_copy 

                                {
    "ActionConfigurationList": {
        "_media-type": "application/vnd.ibexa.api.ai.ActionConfigurationList+json",
        "_href": "/api/ibexa/v2/ai/actions",
        "ActionConfiguration": [
            {
                "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
                "identifier": "gen_alt_text",
                "name": "Generate alternative text",
                "description": "",
                "enabled": true,
                "ActionType": {
                    "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
                    "identifier": "generate_alt_text",
                    "name": "Generate alternative text",
                    "inputIdentifier": "image",
                    "outputIdentifier": "text",
                    "options": {
                        "width": 512,
                        "height": 512,
                        "image_quality": 85
                    }
                },
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ActionConfigurationList media-type="application/vnd.ibexa.api.ai.ActionConfigurationList+xml" href="/api/ibexa/v2/ai/actions">
    <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml">
        <identifier>gen_alt_text</identifier>
        <name>Generate alternative text</name>
        <description></description>
        <enabled>1</enabled>
        <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
            <identifier>generate_alt_text</identifier>
            <name>Generate alternative text</name>
            <inputIdentifier>image</inputIdentifier>
            <outputIdentifier>text</outputIdentifier>
            <options>
                <width>512</width>
                <height>512</height>
                <image_quality>85</image_quality>
            </options>
        </ActionType>
        <actionTypeOptions>
            <max_length>140</max_length>
        </actionTypeOptions>
View more

/ai/actions/{identifier}

Get an action configuration

GET /ai/actions/{identifier}

Returns an action configuration with specified identifier.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ai.ActionConfiguration+json application/vnd.ibexa.api.ai.ActionConfiguration+xml
Possible responses
Code Description
200

Types
Type Description
ActionConfiguration
Code: 200

file_copy 

                                {
    "ActionConfiguration": {
        "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json",
        "identifier": "gen_alt_text",
        "name": "Generate alternative text",
        "description": "",
        "enabled": true,
        "ActionType": {
            "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
            "identifier": "generate_alt_text",
            "name": "Generate alternative text",
            "inputIdentifier": "image",
            "outputIdentifier": "text",
            "options": {
                "width": 512,
                "height": 512,
                "image_quality": 85
            }
        },
        "actionTypeOptions": {
            "max_length": 140
        },
        "actionHandlerIdentifier": "openai-image-to-text",
        "actionHandlerOptions": {
            "max_tokens": 4000,
            "temperature": 1,
            "prompt": "",
            "model": "gpt-4-turbo"
        },
        "createdAt": "2025-02-06T
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml">
    <identifier>gen_alt_text</identifier>
    <name>Generate alternative text</name>
    <description></description>
    <enabled>1</enabled>
    <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
        <identifier>generate_alt_text</identifier>
        <name>Generate alternative text</name>
        <inputIdentifier>image</inputIdentifier>
        <outputIdentifier>text</outputIdentifier>
        <options>
            <width>512</width>
            <height>512</height>
            <image_quality>85</image_quality>
        </options>
    </ActionType>
    <actionTypeOptions>
        <max_length>140</max_length>
    </actionTypeOptions>
    <actionHandlerIdentifier>openai-image-to-text</actionHandlerIdentifier>
    <actionHandlerOptions>
        <max_tokens>4000</max_tokens>
        <temperature>1</temperature>
        <prompt></prompt>
View more

/ai/action-types

/ai/action-types

List action types

GET /ai/action-types

Returns a list of AI action types.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ai.ActionTypeList+json application/vnd.ibexa.api.ai.ActionTypeList+xml
Possible responses
Code Description
200

Types
Type Description
ActionTypeListWrapper JSON object with only the ActionTypeList property.
Code: 200

file_copy 

                                {
    "ActionTypeList": {
        "_media-type": "application/vnd.ibexa.api.ai.ActionTypeList+json",
        "_href": "/api/ibexa/v2/ai/action-types",
        "ActionType": [
            {
                "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
                "identifier": "transcribe_audio",
                "name": "Transcribe audio",
                "inputIdentifier": "audio",
                "outputIdentifier": "text",
                "options": {}
            },
            {
                "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
                "identifier": "generate_alt_text",
                "name": "Generate alternative text",
                "inputIdentifier": "image",
                "outputIdentifier": "text",
                "options": {
                    "width": 512,
                    "height": 512,
                    "image_quality": 85
                }
            },
            {
                "_media-type": "app
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ActionTypeList media-type="application/vnd.ibexa.api.ai.ActionTypeList+xml" href="/api/ibexa/v2/ai/action-types">
    <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
        <identifier>transcribe_audio</identifier>
        <name>Transcribe audio</name>
        <inputIdentifier>audio</inputIdentifier>
        <outputIdentifier>text</outputIdentifier>
        <options/>
    </ActionType>
    <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
        <identifier>generate_alt_text</identifier>
        <name>Generate alternative text</name>
        <inputIdentifier>image</inputIdentifier>
        <outputIdentifier>text</outputIdentifier>
        <options>
            <width>512</width>
            <height>512</height>
            <image_quality>85</image_quality>
        </options>
    </ActionType>
    <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
        <identifier>refine_text</ident
View more

/ai/action-types/{identifier}

Get action type

GET /ai/action-types/{identifier}

Returns the AI action type with given identifier.

Header parameters

Accept

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

Property Value
Type string
Examples application/vnd.ibexa.api.ai.ActionType+json application/vnd.ibexa.api.ai.ActionType+xml
Possible responses
Code Description
200

Types
Type Description
ActionType
Code: 200

file_copy 

                                {
    "ActionType": {
        "_media-type": "application/vnd.ibexa.api.ai.ActionType+json",
        "identifier": "generate_alt_text",
        "name": "Generate alternative text",
        "inputIdentifier": "image",
        "outputIdentifier": "text",
        "options": {
            "width": 512,
            "height": 512,
            "image_quality": 85
        }
    }
}
View more

file_copy 

                                <?xml version="1.0" encoding="UTF-8"?>
<ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
    <identifier>generate_alt_text</identifier>
    <name>Generate alternative text</name>
    <inputIdentifier>image</inputIdentifier>
    <outputIdentifier>text</outputIdentifier>
    <options>
        <width>512</width>
        <height>512</height>
        <image_quality>85</image_quality>
    </options>
</ActionType>
View more

Discounts

/discounts

List discounts

GET /discounts

Returns a list of discounts.

Header parameters

Accept

Specifies the expected response type. Only JSON is supported.

Property Value
Type string
Examples application/vnd.ibexa.api.DiscountList+json
Possible responses
Code Description
200

Discount list returned successfully.
400

Error - the request is invalid.
Types
Type Description
DiscountListWrapper Wrapper object for DiscountList.
Code: 200

file_copy 

                                {
    "DiscountList": {
        "_media-type": "application/vnd.ibexa.api.DiscountList+json",
        "Discount": [
            {
                "_media-type": "application/vnd.ibexa.api.Discount+json",
                "id": 1,
                "identifier": "summersale2025",
                "name": "SummerSale2025",
                "type": "catalog",
                "label": "Summer Sale 2025",
                "labelDescription": "Summer Sale 2025",
                "priority": 1,
                "isEnabled": true,
                "createdAt": "2025-06-10T09:43:42+00:00",
                "updatedAt": "2025-06-10T09:48:23+00:00",
                "startDate": "2025-07-01T09:34:19+00:00",
                "endDate": "2025-07-31T12:00:00+00:00",
                "DiscountExpressionAware": {
                    "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
                    "expressionValues": {
                        "discount_amount": "10"
                    }
View more
Create discount

POST /discounts

Create a discount using the provided input.

Header parameters

Accept

Specifies the expected response type. Only JSON is supported.

Property Value
Type string
Examples application/vnd.ibexa.api.Discount+json

Content-Type

Specifies the input type. Only JSON is supported.

Property Value
Type string
Examples application/vnd.ibexa.api.DiscountCreate+json
Possible responses
Code Description
200

400

Error - the request is invalid.
401

Error - the user is not authorized to execute an AI action.
Types
Type Description
DiscountCreateWrapper Wrapper object for DiscountCreate.
DiscountWrapper Wrapper object for Discount.

file_copy 

                                {
    "DiscountCreate": {
        "identifier": "my_discount",
        "type": "cart",
        "priority": 10,
        "isEnabled": true,
        "userId": 14,
        "rule": {
            "type": "percentage",
            "amount": 10
        },
        "startDate": "2025-04-01 12:12:12",
        "translations": [
            {
                "languageCode": "eng-GB",
                "name": "Another discount",
                "description": "another great discount",
                "label": "another",
                "labelDescription": "another label description"
            }
        ],
        "conditions": [
            {
                "class": "Ibexa\\Discounts\\Value\\DiscountCondition\\IsInCategory",
                "parameters": [["1", "2"]]
            }
        ]
    }
}
View more
Code: 200

file_copy 

                                {
    "Discount": {
        "_media-type": "application/vnd.ibexa.api.Discount+json",
        "id": 2,
        "identifier": "my_discount",
        "name": "Another discount",
        "type": "cart",
        "label": "another",
        "labelDescription": "another label description",
        "priority": 10,
        "isEnabled": true,
        "createdAt": "2025-06-10T11:03:37+00:00",
        "updatedAt": "2025-06-10T11:03:37+00:00",
        "startDate": "2025-04-01T12:12:12+00:00",
        "DiscountExpressionAware": {
            "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
            "expressionValues": {
                "discount_percentage": "10"
            }
        },
        "DiscountConditions": [
            {
                "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
                "expressionValues": {
                    "categories": [
                        "1",
                        "2"
                    ]
View more

/discounts/{id}

/discounts/{id}

Get discount by ID

GET /discounts/{id}

Returns a discount with the specified numerical ID

Header parameters

Accept

Only JSON is supported.

Property Value
Type string
Examples application/vnd.ibexa.api.Discount+json
Possible responses
Code Description
200

Types
Type Description
DiscountWrapper Wrapper object for Discount.
Code: 200

file_copy 

                                {
    "Discount": {
        "_media-type": "application/vnd.ibexa.api.Discount+json",
        "id": 1,
        "identifier": "summersale2025",
        "name": "SummerSale2025",
        "type": "catalog",
        "label": "Summer Sale 2025",
        "labelDescription": "Summer Sale 2025",
        "priority": 1,
        "isEnabled": true,
        "createdAt": "2025-06-10T09:43:42+00:00",
        "updatedAt": "2025-06-10T09:48:23+00:00",
        "startDate": "2025-07-01T09:34:19+00:00",
        "endDate": "2025-07-31T12:00:00+00:00",
        "DiscountExpressionAware": {
            "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
            "expressionValues": {
                "discount_amount": "10"
            }
        },
        "DiscountConditions": [
            {
                "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
                "expressionValues": {
                    "currency_code": "USD"
                }
View more

/discounts/{identifier}

/discounts/{identifier}

Get discount by identifier

GET /discounts/{identifier}

Returns a discount with the specified identifier

Header parameters

Accept

Only JSON is supported.

Property Value
Type string
Examples application/vnd.ibexa.api.Discount+json
Possible responses
Code Description
200

Types
Type Description
DiscountWrapper Wrapper object for Discount.
Code: 200

file_copy 

                                {
    "Discount": {
        "_media-type": "application/vnd.ibexa.api.Discount+json",
        "id": 1,
        "identifier": "summersale2025",
        "name": "SummerSale2025",
        "type": "catalog",
        "label": "Summer Sale 2025",
        "labelDescription": "Summer Sale 2025",
        "priority": 1,
        "isEnabled": true,
        "createdAt": "2025-06-10T09:43:42+00:00",
        "updatedAt": "2025-06-10T09:48:23+00:00",
        "startDate": "2025-07-01T09:34:19+00:00",
        "endDate": "2025-07-31T12:00:00+00:00",
        "DiscountExpressionAware": {
            "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
            "expressionValues": {
                "discount_amount": "10"
            }
        },
        "DiscountConditions": [
            {
                "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
                "expressionValues": {
                    "currency_code": "USD"
                }
View more
Update discount

PATCH /discounts/{identifier}

Updates a discount using the provided input.

Header parameters

Accept

Specifies the expected response type. Only JSON is supported.

Property Value
Type string
Examples application/vnd.ibexa.api.Discount+json

Content-Type

Specifies the input type. Only JSON is supported.

Property Value
Type string
Examples application/vnd.ibexa.api.DiscountUpdate+json
Possible responses
Code Description
200

400

Error - the request is invalid.
401

Error - the user is not authorized to update the discount.
404

Error - the specified discount was not found.
Types
Type Description
DiscountUpdateWrapper Wrapper object for DiscountUpdate.
DiscountWrapper Wrapper object for Discount.

file_copy 

                                {
    "DiscountUpdate": {
        "identifier": "my_discount",
        "conditions": [
            {
                "class": "Ibexa\\Discounts\\Value\\DiscountCondition\\IsInCategory",
                "parameters": [["1", "3"]]
            }
        ]
    }
}
View more
Code: 200

file_copy 

                                {
    "Discount": {
        "_media-type": "application/vnd.ibexa.api.Discount+json",
        "id": 2,
        "identifier": "my_discount",
        "name": "Another discount",
        "type": "cart",
        "label": "another",
        "labelDescription": "another label description",
        "priority": 10,
        "isEnabled": false,
        "createdAt": "2025-06-10T11:03:37+00:00",
        "updatedAt": "2025-06-10T13:05:56+00:00",
        "startDate": "2025-04-01T12:12:12+00:00",
        "DiscountExpressionAware": {
            "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
            "expressionValues": {
                "discount_percentage": "10"
            }
        },
        "DiscountConditions": [
            {
                "_media-type": "application/vnd.ibexa.api.DiscountExpressionAware+json",
                "expressionValues": {
                    "categories": [
                        "1",
                        "3"
                    ]
View more
Delete discount

DELETE /discounts/{identifier}

Deletes a discount

Possible responses
Code Description
204

Discount deleted successfully.
400

Error - the request is invalid.
401

Error - the user is not authorized to update the discount.
404

Error - the specified discount was not found.

/discounts/{identifier}/enable

Enable discount

POST /discounts/{identifier}/enable

Enables a discount with the specified identifier.

Possible responses
Code Description
204

Discount enabled successfully.

/discounts/{identifier}/disable

Disable discount

POST /discounts/{identifier}/disable

Disables a discount with the specified identifier.

Possible responses
Code Description
204

Discount disabled successfully.

Discount Codes

/discounts_codes/{cartIdentifier}/apply

Apply discount to cart

POST /discounts_codes/{cartIdentifier}/apply

Applies a discount associated with given discount code

Header parameters

Accept

Specifies the expected response type. Only JSON is supported.

Property Value
Type string
Examples application/vnd.ibexa.api.DiscountCode+json

Content-Type

Specifies the input type.

Property Value
Type string
Examples application/vnd.ibexa.api.DiscountCode+json
Possible responses
Code Description
200

Discount applied successfully
400

Error - the request is invalid.
404

Error - the given cart identifier was not found, or the discount code does not exist.
429

Error - the request was throttled due to too many requests in a short time.
Types
Type Description
DiscountCodeWrapper Wrapper object for DiscountCode.

file_copy 

                                {
    "DiscountCode": {
        "code": "summer10"
    }
}
View more
Code: 200

file_copy 

                                {
    "DiscountCode": {
        "_media-type": "application\/vnd.ibexa.api.DiscountCode+json",
        "id": 1,
        "code": "summer10",
        "created_at": {
            "date": "2025-06-10 14:14:06.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        }
    }
}
View more

/discounts_codes/{cartIdentifier}/drop

Remove discount from cart

POST /discounts_codes/{cartIdentifier}/drop

Removes the discount associated with given discount code from the cart

Header parameters

Accept

Specifies the expected response type. Only JSON is supported.

Property Value
Type string
Examples application/vnd.ibexa.api.DiscountCode+json

Content-Type

Specifies the input type. Only JSON is supported.

Property Value
Type string
Examples application/vnd.ibexa.api.DiscountCode+json
Possible responses
Code Description
204

Discount code with given discount code was removed from the cart.
400

Error - the request is invalid.
404

Error - the given cart identifier was not found
Types
Type Description
DiscountCodeWrapper Wrapper object for DiscountCode.

file_copy 

                                {
    "DiscountCode": {
        "code": "summer10"
    }
}
View more