logo
API docs by Redocly

Ibexa DXP REST API (5.0.0)

Download OpenAPI specification:

Section

Get Sections

Returns a list of all Sections.

header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "SectionList": {
    }
}

Create new Section

Creates a new Section.

header Parameters
Accept
required
string

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

Content-Type
required
string

The Section input schema encoded in XML or JSON format.

Request Body schema:
optional

The new SectionCreateController resource

required
object (SectionInput)

Responses

Request samples

Content type
{
  • "SectionInput": {
    }
}

Response samples

Content type
{
  • "Section": {
    }
}

Get Section

Returns the Section by given Section ID.

path Parameters
sectionId
required
string
header Parameters
Accept
required
string

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

If-None-match
required
string

ETag

Responses

Response samples

Content type
{
  • "Section": {
    }
}

Delete Section

The given Section is deleted.

path Parameters
sectionId
required
string

Responses

Update a Section

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

path Parameters
sectionId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The Section input schema encoded in XML or JSON.

If-Match
required
string

ETag

Request Body schema:
optional

The updated SectionUpdateController resource

required
object (SectionInput)

Responses

Request samples

Content type
{
  • "SectionInput": {
    }
}

Response samples

Content type
{
  • "Section": {
    }
}

Objects

Load content by remote ID

Loads content item for a given remote ID.

query Parameters
remoteId
required
string

Remote ID of the content item.

Responses

Create content item

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
required
string

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.

Content-Type
required
string

The ContentCreate schema encoded in XML or JSON format.

Request Body schema:
optional

The new ContentCreateController resource

required
object (ContentCreate)

This class is used for creating a new content item.

Responses

Request samples

Content type
{
  • "ContentCreate": {
    }
}

Response samples

Content type
{
  • "Content": {
    }
}

Load content

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).

path Parameters
contentId
required
integer
header Parameters
Accept
required
string
Enum: "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 - 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.
If-None-Match
string

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.

Responses

Response samples

Content type
{
  • "Content": {
    }
}

Delete Content

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

path Parameters
contentId
required
string

Responses

Update content

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

path Parameters
contentId
required
string
header Parameters
Accept
required
string

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

If-match
required
string

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

Content-Type
required
string

The ContentUpdate schema encoded in XML or JSON format.

Request Body schema:
optional

The updated ContentMetadataUpdateController resource

required
object (ContentInfo)

This class provides all version independent information of the content item.

Responses

Request samples

Content type
{
  • "ContentInfo": {
    }
}

Response samples

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

Get current version

Redirects to the current version of the content item.

path Parameters
contentId
required
string

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Create a draft from current version

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

path Parameters
contentId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Hide content item

Makes or keep the content item invisible

path Parameters
contentId
required
string

Responses

Get Locations for content item

Loads all Locations for the given content item.

path Parameters
contentId
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "LocationList": {
    }
}

Create new Location for content item

Creates a new Location for the given content item.

path Parameters
contentId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The LocationCreate schema encoded in XML or JSON format.

Request Body schema:
optional

The new LocationCreateController resource

required
object (LocationCreate)

Responses

Request samples

Content type
{
  • "LocationCreate": {
    }
}

Response samples

Content type
{
  • "Location": {
    }
}

Get Object states of content item

Returns the Object states of a content item

path Parameters
contentId
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "ObjectState": [
    ]
}

Set Object states of content item

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.

path Parameters
contentId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

If-Match
required
string

ETag

Request Body schema:
optional

The updated ObjectStatesForContentUpdateController resource

required
object (ContentObjectStates)

Represents a list of object states.

Responses

Request samples

Content type
{
  • "ContentObjectStates": {
    }
}

Response samples

Content type
{
  • "ContentObjectStates": {
    }
}

Load Relations of content item

Redirects to the Relations of the current version.

path Parameters
contentId
required
string

Responses

Reveal content item

Makes or keep the content item visible

path Parameters
contentId
required
string

Responses

Delete translation (permanently)

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

path Parameters
contentId
required
string
languageCode
required
string

Responses

List 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.

path Parameters
contentId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "VersionList": {
    }
}

Load version

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

path Parameters
contentId
required
string
versionNo
required
string
header Parameters
If-None-Match
required
string

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

Accept
required
string

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

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Create a draft from a version

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

path Parameters
contentId
required
string
versionNo
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Delete content version

Deletes the content version.

path Parameters
contentId
required
string
versionNo
required
string

Responses

Update version

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

path Parameters
contentId
required
string
versionNo
required
string
header Parameters
Accept
required
string

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

If-match
required
string

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

Content-Type
required
string

The VersionUpdate schema encoded in XML or JSON format.

Request Body schema:
optional

The updated ContentVersionUpdateController resource

required
object (VersionUpdate)

This class is used to update a content version.

Responses

Request samples

Content type
{
  • "VersionUpdate": {
    }
}

Response samples

Content type
{
  • "Version": {
    }
}

Load Relations of content item version

Loads the Relations of the given version.

path Parameters
contentId
required
string
versionNo
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "Relations": {
    }
}

Create new Relation

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

path Parameters
contentId
required
string
versionNo
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The RelationCreate schema encoded in XML or JSON format.

Request Body schema:
optional

The new ContentRelationCreateController resource

required
object (RelationCreate)

Responses

Request samples

Content type
{
  • "RelationCreate": {
    }
}

Response samples

Content type
{
  • "Relation": {
    }
}

Load Relation

Loads a Relation for the given content item.

path Parameters
contentId
required
string
versionNo
required
string
relationId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "Relation": {
    }
}

Delete Relation

Deletes a Relation of the given draft.

path Parameters
contentId
required
string
versionNo
required
string
relationId
required
string

Responses

Delete translation from version draft

Removes a translation from a version draft.

path Parameters
contentId
required
string
versionNo
required
string
languageCode
required
string

Responses

Type Groups

Get content type groups

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

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "ContentTypeGroupList": {
    }
}

Create content type group

Creates a new content type group.

header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema:
optional

The new ContentTypeGroupCreateController resource

ContentTypeGroupInput
required
object (ContentTypeGroupInput)

Responses

Request samples

Content type
{
  • "ContentTypeGroupInput": { }
}

Response samples

Content type
{
  • "ContentTypeGroup": {
    }
}

Get content type group

Returns the content type group with provided ID.

path Parameters
contentTypeGroupId
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Delete content type group

Deletes the provided content type group.

path Parameters
contentTypeGroupId
required
string

Responses

Update content type group

Updates a content type group. PATCH or POST with header X-HTTP-Method-Override PATCH.

path Parameters
contentTypeGroupId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

If-Match
required
string

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

Request Body schema:
optional

The updated ContentTypeGroupUpdateController resource

ContentTypeGroupInput
required
object (ContentTypeGroupInput)

Responses

Request samples

Content type
{
  • "ContentTypeGroupInput": { }
}

Response samples

Content type
{
  • "ContentTypeGroup": {
    }
}

List content types for group

Returns a list of content types in the provided group.

path Parameters
contentTypeGroupId
required
string
header Parameters
Accept
required
string

If set, the list of content type info objects or content types (including Field definitions) is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Create content type

Creates a new content type draft in the given content type group.

path Parameters
contentTypeGroupId
required
string
header Parameters
Accept
required
string

If set, the new content type or draft is returned in XML or JSON format.

Content-Type
required
string

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

Request Body schema:
optional

The new ContentTypeCreateController resource

required
object (ContentTypeCreate)

This class is used to create a content type.

Responses

Request samples

Content type
{
  • "ContentTypeCreate": {
    }
}

Response samples

Content type
{
  • "ContentType": {
    }
}

Type

List content types

Returns a list of content types.

header Parameters
Accept
required
string

If set, the list of content type info objects or content types (including Field definitions) is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Get content type

Returns the content type with the provided ID.

path Parameters
contentTypeId
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "ContentType": {
    }
}

Create Draft

Creates a draft and updates it with the given data.

path Parameters
contentTypeId
required
string
header Parameters
Accept
required
string

If set, the new content type draft is returned in XML or JSON format.

Content-Type
required
string

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

Request Body schema:
optional

The new ContentTypeDraftCreateController resource

required
object (ContentTypeUpdate)

This class is used to update a content type.

Responses

Request samples

Content type
{
  • "ContentTypeUpdate": {
    }
}

Response samples

Content type
{
  • "ContentTypeInfo": {
    }
}

Delete content type

Deletes the provided content type.

path Parameters
contentTypeId
required
string

Responses

Get content type draft

Returns the draft of the content type with the provided ID.

path Parameters
contentTypeId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "ContentType": {
    }
}

Delete content type draft

Deletes the provided content type draft.

path Parameters
contentTypeId
required
string

Responses

Update content type draft

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

path Parameters
contentTypeId
required
string
header Parameters
Accept
required
string

If set, the new content type draft is returned in XML or JSON format.

Content-Type
required
string

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

Request Body schema:
optional

The updated ContentTypeDraftUpdateController resource

required
object (ContentTypeUpdate)

This class is used to update a content type.

Responses

Request samples

Content type
{
  • "ContentTypeUpdate": {
    }
}

Response samples

Content type
{
  • "ContentTypeInfo": {
    }
}

Get Draft Field definition list

Returns all Field definitions of the provided content type Draft.

path Parameters
contentTypeId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "FieldDefinitions": {
    }
}

Add content type Draft Field definition

Creates a new Field definition for the given content type.

path Parameters
contentTypeId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema:
optional

The new ContentTypeDraftFieldDefinitionAddController resource

required
object (FieldDefinitionCreate)

Responses

Request samples

Content type
{
  • "FieldDefinitionCreate": {
    }
}

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get content type Draft Field definition

Returns the Field definition by the given ID.

path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Delete content type Draft Field definition

Deletes the provided Field definition.

path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string

Responses

Update content type Draft Field definition

Updates the attributes of a Field definition.

path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema:
optional

The updated ContentTypeDraftFieldDefinitionUpdateController resource

required
object (FieldDefinitionUpdate)

Responses

Request samples

Content type
{
  • "FieldDefinitionUpdate": {
    }
}

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get Field definition list

Returns all Field definitions of the provided content type.

path Parameters
contentTypeId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "FieldDefinitions": {
    }
}

Get Field definition

Returns the Field definition by the given ID.

path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get groups of content type

Returns the content type group to which content type belongs to.

path Parameters
contentTypeId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

Link group to content type

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

path Parameters
contentTypeId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

Unlink group from content type

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

path Parameters
contentTypeId
required
string
id
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

User

Load current User

Loads the current user.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

List Users

Load Users either for a given remote ID or Role.

header Parameters
Accept
required
string

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.

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

Verify Users

Verifies if there are Users matching given filter.

Responses

Load User

Loads User with the given ID.

path Parameters
userId
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

Delete User

Deletes the given User.

path Parameters
userId
required
string

Responses

Update User

Updates a User.

path Parameters
userId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The UserUpdate schema encoded in XML or JSON format.

If-Match
required
string

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

Request Body schema:
optional

The updated UserUpdateController resource

required
object (UserUpdate)

This class is used to update a User.

Responses

Request samples

Content type
{
  • "UserUpdate": {
    }
}

Response samples

Content type
{
  • "User": {
    }
}

Load user drafts

Loads user's drafts

path Parameters
userId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "VersionList": {
    }
}

Load Groups of User

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.

path Parameters
userId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Assign User Group

Assigns the User to a User Group.

path Parameters
userId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Unassign User Group

Unassigns the User from a User Group.

path Parameters
userId
required
string
groupId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Load Roles for User

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

path Parameters
userId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Assign Role to User

Assigns a Role to a user.

path Parameters
userId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The RoleAssignInput schema encoded in XML or JSON format.

Request Body schema:
optional

The new RoleAssignToUserController resource

required
object (RoleAssignInput)

This class represents a Role assign input.

Responses

Request samples

Content type
{
  • "RoleAssignInput": {
    }
}

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load User Role Assignment

Returns a Role assignment to the given User.

path Parameters
userId
required
string
roleId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "RoleAssignment": {
    }
}

Unassign Role from User

The given Role is removed from the user.

path Parameters
userId
required
string
roleId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

View user segments

Return user's segment list.

path Parameters
userId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "UserSegmentList": {
    }
}

Assign Segments to User

Assigns Segments from payload to User given by ID.

path Parameters
userId
required
string
header Parameters
Content-Type
required
string

The UserSegmentAssignInput schema encoded in XML or JSON format.

Request Body schema:
optional

The new UserSegmentAssignController resource

UserSegmentAssignInput
required
any

Responses

Request samples

Content type
{
  • "UserSegmentAssignInput": null
}

Unassign Segment from User

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

path Parameters
userId
required
string
segmentIdentifier
required
string

Responses

User Group

Load User Groups

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

header Parameters
Accept
required
string

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.

Responses

Response samples

Content type
{
  • "UserGroupList": {
    }
}

Get root User Group

Redirects to the root User Group.

Responses

Create a top level User Group

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
required
string

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

Content-Type
required
string

The UserGroupCreate schema encoded in XML or JSON format.

Request Body schema:
optional

The new UserGroupCreateController resource

required
object (UserGroupCreate)

This class is used to create a User Group.

Responses

Request samples

Content type
{
  • "UserGroupCreate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load User Group

Loads User Groups for the given {path}.

path Parameters
path
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "UserGroup": {
    }
}

Delete User Group

The given User Group is deleted.

path Parameters
path
required
string

Responses

Update User Group

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

path Parameters
path
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The UserGroupUpdate schema encoded in XML or JSON format.

If-Match
required
string

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

Request Body schema:
optional

The updated UserGroupUpdateController resource

required
object (UserGroupUpdate)

This class is used to update a User group in the Repository.

Responses

Request samples

Content type
{
  • "UserGroupUpdate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load Roles for User Group

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

path Parameters
path
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Assign Role to User Group

Assigns a Role to a User Group.

path Parameters
path
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The RoleAssignInput schema encoded in XML or JSON format.

Request Body schema:
optional

The new RoleAssignToUserGroupController resource

required
object (RoleAssignInput)

This class represents a Role assign input.

Responses

Request samples

Content type
{
  • "RoleAssignInput": {
    }
}

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load User Group Role Assignment

Returns a Role assignment of the given User Group.

path Parameters
path
required
string
roleId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "RoleAssignment": {
    }
}

Unassign Role from User Group

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

path Parameters
path
required
string
roleId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load subgroups

Returns a list of the subgroups.

path Parameters
path
required
string
header Parameters
Accept
required
string

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.

Responses

Response samples

Content type
{
  • "UserGroupList": {
    }
}

Create User Group

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

path Parameters
path
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The UserGroupCreate schema encoded in XML or JSON format.

Request Body schema:
optional

The new UserGroupCreateController resource

required
object (UserGroupCreate)

This class is used to create a User Group.

Responses

Request samples

Content type
{
  • "UserGroupCreate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load Users of Group

Loads the Users of the Group with the given ID.

path Parameters
path
required
string
header Parameters
Accept
required
string

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.

Responses

Response samples

Content type
{
  • "_media-type": "string",
  • "_href": "string",
  • "User": [
    ]
}

Create User

Creates a new User in the given Group.

path Parameters
path
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The UserCreate schema encoded in XML or JSON format.

Request Body schema:
optional

The new UserCreateController resource

required
object (UserCreate)

This class is used to create a User.

Responses

Request samples

Content type
{
  • "UserCreate": {
    }
}

Response samples

Content type
{
  • "User": {
    }
}

User Role

Load Roles

Returns a list of all Roles.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "RoleList": {
    }
}

Create Role or Role draft

Creates a new Role or Role draft.

header Parameters
Accept
required
string

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

Content-Type
required
string

The RoleInput schema encoded in XML or JSON.

Request Body schema:
optional

The new RoleCreateController resource

required
object (RoleInput)

This class represents a Role input.

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Role

Loads a Role for the given ID.

path Parameters
id
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Create Role Draft

Creates a new Role draft from an existing Role.

path Parameters
id
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The RoleInput schema encoded in XML or JSON.

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Delete Role

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

path Parameters
id
required
string

Responses

Update Role

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

path Parameters
id
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The RoleInput schema encoded in XML or JSON format.

If-Match
required
string

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

Request Body schema:
optional

The updated RoleUpdateController resource

required
object (RoleInput)

This class represents a Role input.

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Role draft

Loads a Role draft by original Role ID.

path Parameters
id
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Delete Role draft

The given Role draft is deleted.

path Parameters
id
required
string

Responses

Update Role draft

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

path Parameters
id
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The RoleInput schema encoded in XML or JSON format.

If-Match
required
string

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

Request Body schema:
optional

The updated RoleDraftUpdateController resource

required
object (RoleInput)

This class represents a Role input.

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Policies

Loads Policies for the given Role.

path Parameters
id
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "PolicyList": {
    }
}

Create Policy

Creates a Policy

path Parameters
id
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema:
optional

The new RolePolicyCreateController resource

required
object (PolicyCreate)

This class is used to create a Policy.

Responses

Request samples

Content type
{
  • "PolicyCreate": {
    }
}

Response samples

Content type
{
  • "Policy": {
    }
}

Delete Policies

All Policies of the given Role are deleted.

path Parameters
id
required
string

Responses

Load Policy

Loads a Policy for the given module and function.

path Parameters
policyId
required
string
roleId
required
string

RolePolicyLoadByIdController identifier

header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "Policy": {
    }
}

Delete Policy

Deletes given Policy.

path Parameters
policyId
required
string
roleId
required
string

RolePolicyDeleteController identifier

Responses

Update Policy

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

path Parameters
policyId
required
string
roleId
required
string

RolePolicyUpdateController identifier

header Parameters
Accept
required
string

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

Content-Type
required
string

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

If-Match
required
string

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

Request Body schema:
optional

The updated RolePolicyUpdateController resource

required
object (PolicyUpdate)

This class is used to update a Policy.

Responses

Request samples

Content type
{
  • "PolicyUpdate": {
    }
}

Response samples

Content type
{
  • "Policy": {
    }
}

User Policy

List Policies for User

Search all Policies which are applied to a given User.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "PolicyList": {
    }
}

Language

Language list

Lists languages

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "LanguageList": {
    }
}

Get language

Retrieves a LanguageLoadByIdController resource.

path Parameters
code
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "Language": {
    }
}

Location

Load Locations by id/remoteId/urlAlias

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

header Parameters
Accept
required
string

Responses

Response samples

Content type
{
  • "Location": {
    }
}

Load Location

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

path Parameters
path
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "Location": {
    }
}

Delete subtree

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.

path Parameters
path
required
string

Responses

Update Location

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.

path Parameters
path
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The LocationUpdate schema encoded in XML or JSON format.

If-Match
required
string

ETag

Request Body schema:
optional

The updated LocationUpdateController resource

required
object (LocationUpdateStruct)

This class is used for updating Location meta data.

Responses

Request samples

Content type
{
  • "LocationUpdate": {
    }
}

Response samples

Content type
{
  • "Location": {
    }
}

Get child Locations.

Loads all child Locations for the given parent Location.

path Parameters
path
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "LocationList": {
    }
}

List URL aliases for Location

Returns the list of URL aliases for a Location.

path Parameters
path
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "UrlAliasRefList": {
    }
}

Object State Groups

List Object state groups

Returns a list of all Object state groups.

header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "ObjectStateGroupList": {
    }
}

Create Object state group

Creates a new Object state group.

header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema:
optional

The new ObjectStateGroupCreateController resource

required
object (ObjectStateGroupCreate)

This class represents a value for creating Object state groups.

Responses

Request samples

Content type
{
  • "ObjectStateGroupCreate": {
    }
}

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

Get Object state group

Returns the Object state group with the provided ID.

path Parameters
objectStateGroupId
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

Delete Object state group

Deletes the given Object state group including Object states.

path Parameters
objectStateGroupId
required
string

Responses

Update Object state group

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

path Parameters
objectStateGroupId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

If-Match
required
string

ETag

Request Body schema:
optional

The updated ObjectStateGroupUpdateController resource

required
object (ObjectStateGroupUpdate)

This class represents a value for updating Object state groups.

Responses

Request samples

Content type
{
  • "ObjectStateGroupUpdate": {
    }
}

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

List Object states

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

path Parameters
objectStateGroupId
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "ObjectStateList": {
    }
}

Create Object state

Creates a new Object state.

path Parameters
objectStateGroupId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema:
optional

The new ObjectStateCreateController resource

required
object (ObjectStateCreate)

This class represents a value for creating Object states.

Responses

Request samples

Content type
{
  • "ObjectStateCreate": {
    }
}

Response samples

Content type
{
  • "ObjectState": {
    }
}

Get Object state

Returns the Object state.

path Parameters
objectStateGroupId
required
string
objectStateId
required
string
header Parameters
Accept
required
string

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

If-None-Match
required
string

ETag

Responses

Response samples

Content type
{
  • "ObjectState": {
    }
}

Delete Object state

Deletes provided Object state.

path Parameters
objectStateGroupId
required
string
objectStateId
required
string

Responses

Update Object state

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

path Parameters
objectStateGroupId
required
string
objectStateId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

If-Match
required
string

ETag

Request Body schema:
optional

The updated ObjectStateUpdateController resource

required
object (ObjectStateUpdate)

This class represents a value for updating Object states.

Responses

Request samples

Content type
{
  • "ObjectStateUpdate": {
    }
}

Response samples

Content type
{
  • "ObjectState": {
    }
}

Trash

List Trash items

Returns a list of all items in the Trash.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "Trash": {
    }
}

Empty Trash

Empties the Trash.

Responses

Get Trash item

Returns the item in Trash with the provided ID.

path Parameters
trashItemid
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "TrashItem": {
    }
}

Delete Trash item

Deletes the provided item from Trash.

path Parameters
trashItemid
required
string

Responses

Url Wildcard

List URL wildcards

Returns a list of URL wildcards.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "UrlWildcardList": {
    }
}

Create URL wildcard

Creates a new URL wildcard.

header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema:
optional

The new URLWildcardCreateController resource

required
object (UrlWildcardCreate)

Creates a new URL wildcard.

Responses

Request samples

Content type
{
  • "URLWildcardCreate": {
    }
}

Response samples

Content type
{
  • "UrlWildcard": {
    }
}

Get URL wildcard

Returns the URL wildcard with the given ID.

path Parameters
wildcardId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "UrlWildcard": {
    }
}

Delete URL wildcard

Deletes the given URL wildcard.

path Parameters
wildcardId
required
string

Responses

Url Alias

List global URL aliases

Returns the list of global URL aliases.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "UrlAliasRefList": {
    }
}

Create URL alias

Creates a URL alias.

header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema:
optional

The new URLAliasCreateController resource

required
object (UrlAliasCreate)

Responses

Request samples

Content type
{
  • "UrlAliasCreate": {
    }
}

Response samples

Content type
{
  • "UrlAlias": {
    }
}

Get URL alias

Returns the URL alias with the given ID.

path Parameters
urlAliasId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "UrlAlias": {
    }
}

Delete URL alias

Deletes the provided URL alias.

path Parameters
urlAliasId
required
string

Responses

Views

Controller for Repository Views (Search, mostly).

Search content

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
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new Views resource

required
object (ViewInput)

This class represents a View input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.View+xml; version=1.1
<?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>
            <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"/>
            <pathString>/1/2/</pathString>
            <depth>1</depth>
            <childCount>8</childCount>
            <remoteId>f3e90596361e31d496d4026eb624c983</remoteId>
            <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/children"/>
            <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/>
            <sortField>PRIORITY</sortField>
            <sortOrder>ASC</sortOrder>
            <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/urlaliases"/>
          </Location>

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

User Session

Create session (login a User)

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
required
string

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

Content-Type
required
string

The SessionInput schema encoded in XML or JSON format.

Cookie
required
string

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

X-CSRF-Token
required
string

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

Request Body schema:
optional

The new SessionCreateController resource

required
object (SessionInput)

This class represents a session input.

Responses

Request samples

Content type
{
  • "SessionInput": {
    }
}

Response samples

Content type
{
  • "Session": {
    }
}

Get current session

Get current user session, if any.

header Parameters
Cookie
required
string

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

Accept
required
string

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

Responses

Response samples

Content type
{
  • "Session": {
    }
}

Delete session (logout a User)

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

path Parameters
sessionId
required
string
header Parameters
Cookie
required
string

{sessionName}={sessionID}

X-CSRF-Token
required
string

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

Responses

Refresh session (deprecated)

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

path Parameters
sessionId
required
string
header Parameters
Cookie
required
string

{sessionName}={sessionID}

X-CSRF-Token
required
string

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

Accept
required
string

Responses

Response samples

Content type
{
  • "Session": {
    }
}

Bookmark

List of bookmarks

Lists bookmarked Locations for the current user.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "BookmarkList": {
    }
}

Create bookmark

Add given Location to bookmarks of the current user.

path Parameters
locationId
required
string

Responses

Delete bookmark

Deletes the given Location from bookmarks of the current user.

path Parameters
locationId
required
string

Responses

Check if Location is bookmarked

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

path Parameters
locationId
required
string

Responses

User Token

Create JWT token

Creates JWT authentication token.

header Parameters
Accept
required
string

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

Content-Type
required
string

The SessionInput schema encoded in XML or JSON format.

Request Body schema:
optional

The new JWT resource

required
object (JWTInput)

This class represents the input for a JWT authentication token

Responses

Request samples

Content type
{
  • "JWTInput": {
    }
}

Response samples

Content type
{
  • "JWT": {
    }
}

Calendar

Calendar list

Calendar event list.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "EventList": {
    }
}

Calendar list grouped by day

Calendar event list grouped by day.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "EventGroupList": {
    }
}

Calendar action

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

path Parameters
eventType
required
string
header Parameters
Content-Type
required
string
Request Body schema:
optional

The new EventExecuteActionController resource

required
object (UnscheduleAction)

This class represents events to unschedule

Responses

Request samples

Content type
{
  • "UnscheduleAction": {
    }
}

Product Attribute

Load attributes (deprecated)

Loads list of all attributes. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attributes/view instead.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "AttributeList": {
    }
}

Create attribute

Creates a new attribute.

header Parameters
Accept
required
string

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

Content-Type
required
string

The attribute schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.AttributeCreate+json
optional

The new AttributeCreateController resource

required
object (AttributeCreate)

This class is used to create an attribute.

Responses

Request samples

Content type
application/vnd.ibexa.api.AttributeCreate+json
{
  • "AttributeCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Attribute+json
{
  • "Attribute": {
    }
}

Delete attribute translation

The given translation is removed from the attribute.

path Parameters
id
required
string
languageCode
required
string

Responses

Filter attributes

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
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new AttributeViewController resource

required
object (AttributeViewInput)

This class represents an attribute view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "AttributeView": {
    }
}

Load attribute

Loads given attribute.

path Parameters
id
required
string
header Parameters
Accept
required
string

Attribute - If set, the given attribute is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "Attribute": {
    }
}

Delete attribute

The given attribute is removed from the attribute group.

path Parameters
id
required
string

Responses

Update attribute

Updates an attribute.

path Parameters
id
required
string
group_id
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema: application/vnd.ibexa.api.AttributeUpdate+json
optional

The updated AttributeUpdateController resource

required
object (AttributeUpdate)

This class is used to update an attribute.

Responses

Request samples

Content type
application/vnd.ibexa.api.AttributeUpdate+json
{
  • "AttributeUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Attribute+json
{
  • "Attribute": {
    }
}

Product Attribute Type

List Attribute Types

Lists all Attribute Types.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "AttributeTypeList": {
    }
}

Get Attribute Type

Gets an Attribute Type by its identifier.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "AttributeType": {
    }
}

Product Attribute Group

Load attribute groups (deprecated)

Returns a list of attribute groups. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attribute_groups/view instead.

header Parameters
Accept
required
string

AttributeGroupList - If set, the attribute group list is returned in XML or JSON format.

Content-Type
required
string

The AttributeGroupListGet schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.AttributeGroupListGet+json
optional
required
object (AttributeGroupListGet)

This class represents an attribute group list request.

Responses

Request samples

Content type
application/vnd.ibexa.api.AttributeGroupListGet+json
{
  • "AttributeGroupListGet": {
    }
}

Response samples

Content type
{
  • "AttributeGroupList": {
    }
}

Create attribute group

Creates a new attribute group.

header Parameters
Accept
required
string

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

Content-Type
required
string

The AttributeGroup schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.AttributeGroupCreate+json
optional

The new AttributeGroupCreateController resource

required
object (AttributeGroupCreate)

This class is used to create an attribute group.

Responses

Request samples

Content type
application/vnd.ibexa.api.AttributeGroupCreate+json
{
  • "AttributeGroupCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.AttributeGroup+json
{
  • "AttributeGroup": {
    }
}

Delete attribute group translation

Deletes given translation from attribute group.

path Parameters
id
required
string
languageCode
required
string

Responses

Filter attribute groups

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
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new AttributeGroupViewController resource

required
object (AttributeGroupViewInput)

This class represents an attribute group view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "AttributeGroupView": {
    }
}

Load attribute group

Returns the given attribute group.

path Parameters
id
required
string
header Parameters
Accept
required
string

AttributeGroupGet - If set, the attribute group List is returned in XML or JSON format.

Content-Type
required
string

An optional AttributeGroupGet schema encoded in XML or JSON format.

Request Body schema:
optional
required
object (AttributeGroupGet)

This class represents an attribute group query.

Responses

Request samples

Content type
{
  • "AttributeGroupGet": {
    }
}

Response samples

Content type
{
  • "AttributeGroup": {
    }
}

Delete attribute group

Deletes an attribute group.

path Parameters
id
required
string

Responses

Update attribute group

Updates an attribute group.

path Parameters
id
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The attribute group update schema is sent in XML or JSON format.

Request Body schema:
optional

The updated AttributeGroupUpdateController resource

required
object (AttributeGroupUpdate)

This class is used to update an attribute group.

Responses

Request samples

Content type
{
  • "AttributeGroupUpdate": {
    }
}

Response samples

Content type
{
  • "AttributeGroup": {
    }
}

Product Catalog

Create catalog

Creates a new catalog.

header Parameters
Accept
required
string

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

Content-Type
required
string

The catalog schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.CatalogCreate+json
optional

The new CatalogCreateController resource

required
object (CatalogCreate)

This class is used to create a catalog.

Responses

Request samples

Content type
application/vnd.ibexa.api.CatalogCreate+json
{
  • "CatalogCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.CatalogCreate+json
{
  • "Catalog": {
    }
}

Copy catalog

Copies a catalog.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema: application/vnd.ibexa.api.CatalogCopy+json
optional

The new CatalogCopyController resource

required
object (CatalogCopy)

This class is used to copy a catalog.

Responses

Request samples

Content type
application/vnd.ibexa.api.CatalogCopy+json
{
  • "CatalogCopy": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Catalog+json
{
  • "Catalog": {
    }
}

Load catalog filters

Loads product filters available for catalogs.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "ProductFilterList": {
    }
}

Load catalog sort clauses

Loads product sort clauses available for catalogs.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "ProductSortClauseList": {
    }
}

Filter catalogs

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
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new CatalogViewController resource

required
object (CatalogViewInput)

This class represents a catalog view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CatalogView": {
    }
}

Load catalog

Loads the given catalog.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "Catalog": {
    }
}

Delete catalog

Deletes the given catalog.

path Parameters
identifier
required
string

Responses

Update catalog

Updates a catalog.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema: application/vnd.ibexa.api.CatalogUpdate+json
optional

The updated CatalogUpdateController resource

required
object (CatalogUpdate)

This class is used to update a catalog.

Responses

Request samples

Content type
application/vnd.ibexa.api.CatalogUpdate+json
{
  • "CatalogUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Catalog+json
{
  • "Catalog": {
    }
}

Filter catalog products

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

path Parameters
identifier
required
string
header Parameters
Accept
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new CatalogProductsViewController resource

required
object (ProductViewInput)

This class represents a product view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductView": {
    }
}

Product Currency

Load currencies

Loads the list of currencies.

header Parameters
Accept
required
string

CurrencyList - If set, the currency list returned in XML or JSON format.

Responses

Response samples

Content type
application/vnd.ibexa.api.CurrencyList+json
{
  • "CurrencyList": {
    }
}

Create currency

Creates a new currency.

header Parameters
Accept
required
string

If set, the new currency is returned in JSON format.

Content-Type
required
string

The Currency schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.CurrencyCreate+json
optional

The new CurrencyCreateController resource

required
object (CurrencyCreate)

This class is used to create currency.

Responses

Request samples

Content type
application/vnd.ibexa.api.CurrencyCreate+json
{
  • "CurrencyCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Currency+json
{
  • "Currency": {
    }
}

Filter currencies

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
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new CurrencyViewController resource

required
object (CurrencyViewInput)

This class represents a currency view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CurrencyView": {
    }
}

Load currency

Loads a currency.

path Parameters
id
required
string
header Parameters
Accept
required
string

Currency - If set, the currency returned in XML or JSON format.

Responses

Response samples

Content type
application/vnd.ibexa.api.Currency+json
{
  • "Currency": {
    }
}

Delete currency

Deletes the given currency.

path Parameters
id
required
string

Responses

Update currency

Updates a currency.

path Parameters
id
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The CurrencyUpdate schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.CurrencyUpdate+json
optional

The updated CurrencyUpdateController resource

required
object (CurrencyUpdate)

This class is used to update currency.

Responses

Request samples

Content type
application/vnd.ibexa.api.CurrencyUpdate+json
{
  • "CurrencyUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Currency+json
{
  • "Currency": {
    }
}

Product Customer Group

Load customer groups

Returns a list of customer groups

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
application/vnd.ibexa.api.CustomerGroupList+json
{
  • "CustomerGroupList": {
    }
}

Create customer group

Creates a new customer group.

header Parameters
Accept
required
string

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

Content-Type
required
string

The CustomerGroupCreate schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.CustomerGroupCreate+json
optional

The new CustomerGroupCreateController resource

required
object (CustomerGroupCreate)

This class is used to create a customer group.

Responses

Request samples

Content type
application/vnd.ibexa.api.CustomerGroupCreate+json
{
  • "CustomerGroupCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.CustomerGroup+json
{
  • "CustomerGroup": {
    }
}

Filter customer groups

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
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new CustomerGroupViewController resource

required
object (CustomerGroupViewInput)

This class represents a customer group view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CustomerGroupView": {
    }
}

Load customer group

Returns a customer group

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
application/vnd.ibexa.api.CustomerGroup+json
{
  • "CustomerGroup": {
    }
}

Delete customer group

Deletes the given customer group.

path Parameters
identifier
required
string

Responses

Update customer group

Updates the given customer group.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The CustomerGroupUpdate schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.CustomerGroupUpdate+json
optional

The updated CustomerGroupUpdateController resource

required
object (CustomerGroupUpdate)

This class is used to update a customer group.

Responses

Request samples

Content type
application/vnd.ibexa.api.CustomerGroupUpdate+json
{
  • "CustomerGroupUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.CustomerGroup+json
{
  • "CustomerGroup": {
    }
}

Load customer group

Returns a customer group

path Parameters
id
required
integer
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
application/vnd.ibexa.api.CustomerGroup+json
{
  • "CustomerGroup": {
    }
}

Product

Load products list (deprecated)

Returns a list of products. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/products/view instead.

header Parameters
Accept
required
string

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

Content-Type
required
string

The product list schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.ProductListGet+json
optional
required
object (ProductListGet)

This class represents a product list GET.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductListGet+json
{
  • "ProductListGet": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.ProductList+json
{
  • "ProductList": {
    }
}

Filter products

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
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new ProductViewController resource

required
object (ProductViewInput)

This class represents a product view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductView": {
    }
}

Load the given product

Loads the given product.

path Parameters
code
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

An optional product schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.ProductGet+json
optional
required
object (ProductGet)

This class represents a product GET.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductGet+json
{
  • "ProductGet": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Product+json
{
  • "Product": {
    }
}

Update product

Updates product.

path Parameters
code
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema: application/vnd.ibexa.api.ProductUpdate+json
optional

The updated ProductUpdateController resource

required
object (ProductUpdate)

This class is used to update a product.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductUpdate+json
{
  • "ProductUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Product+json
{
  • "Product": {
    }
}

Load the list of product prices

Loads the list of product prices.

path Parameters
code
required
string
header Parameters
Accept
required
string

PriceList - if set, the product price list is returned in JSON format.

Responses

Response samples

Content type
application/vnd.ibexa.api.PriceList+json
{
  • "PriceList": {
    }
}

Create product price or custom price

Create product price or custom price.

path Parameters
code
required
string
header Parameters
Accept
required
string

The product price schema encoded in JSON format.

Content-Type
required
string

If set, the new price is returned in JSON format.

Request Body schema:
optional

The new PriceCreateController resource

required
object (CustomPriceCreateStruct)

This class represents a custom price creation structure.

Responses

Request samples

Content type
{
  • "CustomPriceCreateStruct": {
    }
}

Response samples

Content type
{
  • "CustomPrice": {
    }
}

Get price in given currency

Get price in given currency.

path Parameters
code
required
string
currencyCode
required
string
header Parameters
Accept
required
string

If set, gets price in given currency in JSON format.

Responses

Response samples

Content type
application/vnd.ibexa.api.Price+json
{
  • "Price": {
    }
}

Get price in given currency and customer group

Get price in given currency and customer group.

path Parameters
code
required
string
currencyCode
required
string
customerGroupIdentifier
required
string
header Parameters
Accept
required
string

If set, gets price in given currency and customer group in JSON format.

Responses

Response samples

Content type
application/vnd.ibexa.api.CustomPrice+json
{
  • "CustomPrice": {
    }
}

Delete product price

Deletes product price.

path Parameters
code
required
string
id
required
string
header Parameters
Accept
required
string

If set, deletes price of given id.

Content-Type
required
string

Delete product price.

Responses

Update product price

Updates product price.

path Parameters
code
required
string
id
required
string
header Parameters
Accept
required
string

If set, updates product price.

Content-Type
required
string

Update price or custom price for given currency.

Request Body schema:
optional

The updated PriceUpdateController resource

required
object (CustomPriceUpdateStruct)

This class represents a custom price updating structure.

Responses

Request samples

Content type
{
  • "CustomPriceUpdateStruct": {
    }
}

Response samples

Content type
{
  • "CustomPrice": {
    }
}

Delete product

Deletes the given product.

path Parameters
identifier
required
string

Responses

Create product

Creates a new product.

path Parameters
productTypeIdentifier
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The product schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.ProductCreate+json
optional

The new ProductCreateController resource

required
object (ProductCreate)

This class is used to create a product.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductCreate+json
{
  • "ProductCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.ProductCreate+json
{
  • "Product": {
    }
}

Product Type

Load product types (deprecated)

Returns a list of product types. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/product_types/view instead.

header Parameters
Accept
required
string

ProductTypeList - If set, the product type list is returned in XML or JSON format.

Content-Type
required
string

The ProductTypeList schema encoded in XML or JSON format.

Request Body schema:
optional
required
object (ProductTypeListGet)

This class represents a product type list query.

Responses

Request samples

Content type
{
  • "ProductTypeListGet": {
    }
}

Response samples

Content type
{
  • "ProductTypeList": {
    }
}

Create product type

Creates a new product type.

header Parameters
Accept
required
string

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

Content-Type
required
string

The ProductType schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.ProductTypeCreate+json
optional

The new ProductTypeCreateController resource

required
object (ProductTypeCreate)

This class is used to create a product type.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductTypeCreate+json
{
  • "ProductTypeCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.ProductType+json
{
  • "ProductType": {
    }
}

Check product type usage

Checks whether the product type is in use.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

Responses

Response samples

Content type
{
  • "ProductTypeUsage": {
    }
}

Filter product types

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
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new ProductTypeViewController resource

required
object (ProductTypeViewInput)

This class represents a product type view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductTypeView": {
    }
}

Load product type

Returns the given product type.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

Responses

Response samples

Content type
{
  • "ProductTypeUsage": {
    }
}

Delete product type

Deletes the given product type.

path Parameters
id
required
string

Responses

Update product type

Updates product type.

path Parameters
id
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

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

Request Body schema: application/vnd.ibexa.api.ProductTypeUpdate+json
optional

The updated ProductTypeUpdateController resource

required
object (ProductTypeUpdate)

This class is used to update a product type.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductTypeUpdate+json
{
  • "ProductTypeUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.ProductType+json
{
  • "ProductType": {
    }
}

Product Variant

Load product variant

Loads the given product variant.

path Parameters
code
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
application/vnd.ibexa.api.ProductVariant+json
{
  • "ProductVariant": {
    }
}

Generate product variants

Generates new product variants based on selected (discriminator) attributes.

path Parameters
baseProductCode
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The product variant schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.ProductVariantGenerate+json
optional

The new ProductVariantGenereateController resource

required
object (ProductVariantGenerate)

This class is used to generate a product variant.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductVariantGenerate+json
{
  • "ProductVariantGenerate": {
    }
}

Filter product variants

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

path Parameters
baseProductCode
required
string
header Parameters
Accept
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new ProductVariantViewController resource

required
object (ProductVariantViewInput)

This class represents a product variant view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductVariantView": {
    }
}

Create product variant

Creates a new product variant.

path Parameters
baseProductCode
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The product variant schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.ProductVariantCreate+json
optional

The new ProductVariantCreateController resource

required
object (ProductVariantCreate)

This class is used to create a product variant.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductVariantCreate+json
{
  • "ProductVariantCreate": {
    }
}

Delete product variant

Deletes the given product variant.

path Parameters
code
required
string

Responses

Update product variant

Updates product variant.

path Parameters
code
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The product variant update schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.ProductVariantUpdate+json
optional

The updated ProductVariantUpdateController resource

required
object (ProductVariantUpdate)

This class is used to update a product variant.

Responses

Request samples

Content type
application/vnd.ibexa.api.ProductVariantUpdate+json
{
  • "ProductVariantUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.ProductVariant+json
{
  • "ProductVariant": {
    }
}

Product Region

Load regions

Loads the list of regions.

header Parameters
Accept
required
string

RegionList - If set, the regions list returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "RegionList": {
    }
}

Filter regions

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
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new RegionViewController resource

required
object (RegionViewInput)

This class represents a region view input.

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "RegionView": {
    }
}

Load region

Loads a region by its identifier

path Parameters
identifier
required
string
header Parameters
Accept
required
string

Responses

Response samples

Content type
{
  • "Region": {
    }
}

Product Vat

Load VAT region

Loads a VAT category for the given region.

path Parameters
region
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
application/vnd.ibexa.api.VatCategoryList+json
{
  • "VatCategoryList": {
    }
}

Load VAT specific region

Loads a VAT category for the given identifier.

path Parameters
region
required
string
identifier
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
application/vnd.ibexa.api.VatCategory+json
{
  • "VatCategory": {
    }
}

Taxonomy

Delete Entries

Bulk removes several taxonomy entries.

path Parameters
taxonomyName
required
string
header Parameters
Content-Type
required
string

Target Entries schema encoded in XML or JSON format.

Request Body schema:
optional
required
object (TaxonomyEntryBulkRemove)

This class is used to bulk remove taxonomy entries.

Responses

Request samples

Content type
{
  • "TaxonomyEntryBulkRemove": {
    }
}

Move Entries

Bulk move several taxonomy entries relative to sibling.

path Parameters
taxonomyName
required
string
header Parameters
Content-Type
required
string

The Entry moves schema encoded in XML or JSON format.

Request Body schema:
optional

The new TaxonomyEntryBulkMoveController resource

required
object (TaxonomyEntryBulkMove)

This class is used to bulk move taxonomy entries.

Responses

Request samples

Content type
{
  • "TaxonomyEntryBulkMove": {
    }
}

Get Assignment by ID

Gets taxonomy entry Assignment by its ID.

path Parameters
taxonomyName
required
string
id
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "TaxonomyEntryAssignment": {
    }
}

Assign entry

Assigns taxonomy entry to a content item.

path Parameters
taxonomyName
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json
optional

The new TaxonomyEntryAssignmentAssignController resource

required
object (TaxonomyEntryAssignToContent)

This class is used to assign taxonomy entry to content.

Responses

Request samples

Content type
application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json
{
  • "TaxonomyEntryAssignToContent": {
    }
}

Get Assignments to a Content

Gets taxonomy entries assigned to a content item by its ID.

path Parameters
taxonomyName
required
string
contentId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "EntryAssignmentCollection": {
    }
}

Unassign entry

Unassigns taxonomy entry from a content item.

path Parameters
taxonomyName
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json
optional

The new TaxonomyEntryAssignmentUnassignController resource

required
object (TaxonomyEntryUnassignFromContent)

This class is used to unassign taxonomy entry from content.

Responses

Request samples

Content type
application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json
{
  • "TaxonomyEntryUnassignFromContent": {
    }
}

Get Entry by Content ID

Loads taxonomy Entry by its Content ID.

path Parameters
taxonomyName
required
string
contentId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Get Entry by identifier

Loads taxonomy Entry by its Entry identifier.

path Parameters
taxonomyName
required
string
identifier
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Get Entry by ID

Loads taxonomy Entry by its Entry ID.

path Parameters
taxonomyName
required
string
id
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Segmentation

List segment groups

Lists segment groups.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "SegmentGroupList": {
    }
}

Load segment group

Loads segment group.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "SegmentGroup": {
    }
}

List segment group's segments

Lists segment group's segments.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "SegmentList": {
    }
}

Load segment

Loads the identified segment.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

If set, the segment is returned in XML or JSON

Responses

Response samples

Content type
{
  • "Segment": {
    }
}

Corporate Account

Root Resource

Provides basic information about Corporate Account endpoints and configuration.

header Parameters
Accept
required
string

If set, helps to determine response format.

Responses

Response samples

Content type
{
  • "CorporateAccountRoot": {
    }
}

Read list of companies

Returns paginated list of available companies.

header Parameters
Accept
required
string

If set, helps to determine response format.

Responses

Response samples

Content type
{
  • "CompanyList": {
    }
}

Create a company

Creates a CompanyCreateController resource.

header Parameters
Accept
required
string

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

Content-Type
required
string

The CompanyCreate schema encoded in XML or JSON format.

Request Body schema:
optional

The new CompanyCreateController resource

required
object (CompanyCreate)

This class is used to create a company.

Responses

Request samples

Content type
{
  • "CompanyCreate": {
    }
}

Response samples

Content type
{
  • "Company": {
    }
}

Get company

Returns the company by given company ID.

path Parameters
companyId
required
string
header Parameters
Accept
required
string

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

If-None-match
required
string

ETag

Responses

Response samples

Content type
{
  • "Company": {
    }
}

Delete company

The given company is deleted.

path Parameters
companyId
required
string
header Parameters
Accept
required
string

If set, in the case of an error the error message is returned in XML or JSON format.

X-CSRF-Token
required
string

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

Responses

Update a company

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

path Parameters
companyId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The company input schema encoded in XML or JSON.

If-Match
required
string

ETag

Request Body schema:
optional

The updated CompanyUpdateController resource

required
object (CompanyUpdate)

This class is used to update a Company.

Responses

Request samples

Content type
{
  • "CompanyUpdate": {
    }
}

Response samples

Content type
{
  • "Company": {
    }
}

Read list of company members

Returns paginated list of a given company members.

path Parameters
companyId
required
string
query Parameters
filter[DateMetadataCriterion][Target]
string
Enum: "created" "modified" "published"
filter[DateMetadataCriterion][Operator]
string
Enum: "eq" "gt" "gte" "lt" "lte"
filter[DateMetadataCriterion][Value]
integer

DateTime as a UNIX timestamp

sort[ContentName]
string
Enum: "ascending" "descending"
sort[DatePublished]
string
Enum: "ascending" "descending"
sort[DateModified]
string
Enum: "ascending" "descending"
offset
integer
limit
integer
header Parameters
Accept
required
string
Enum: "application/vnd.ibexa.api.MemberList+xml" "application/vnd.ibexa.api.MemberList+json"

If set, helps to determine response format.

Responses

Response samples

Content type
{
  • "MemberList": {
    }
}

Create a company member

Creates a company member.

path Parameters
companyId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The CompanyCreate schema encoded in XML or JSON format.

Request Body schema:
optional

The new MemberCreateController resource

required
object (MemberCreate)

This class is used to create a member.

Responses

Request samples

Content type
{
  • "MemberCreate": {
    }
}

Response samples

Content type
{
  • "Member": {
    }
}

Get company member

Returns the company member by given member ID.

path Parameters
companyId
required
string
memberId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "Member": {
    }
}

Delete company member

The given company member is deleted.

path Parameters
companyId
required
string
memberId
required
string
header Parameters
Accept
required
string

If set, in the case of an error the error message is returned in XML or JSON format.

X-CSRF-Token
required
string

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

Responses

Update a company member

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

path Parameters
companyId
required
string
memberId
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The company input schema encoded in XML or JSON.

If-Match
required
string

ETag

Request Body schema:
optional

The updated MemberUpdateController resource

required
object (MemberUpdate)

This class is used to update a member.

Responses

Request samples

Content type
{
  • "MemberUpdate": {
    }
}

Response samples

Content type
{
  • "Member": {
    }
}

Read list of sales representatives

Returns paginated list of available sales representatives.

header Parameters
Accept
required
string

If set, helps to determine response format.

Responses

Response samples

Content type
{
  • "SalesRepresentativesList": {
    }
}

Activity Log

List of activity log groups

Lists last activity log groups and their entries.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "ActivityLogGroupList": {
    }
}

Cart

Create Cart

Creates Cart from payload.

header Parameters
Content-Type
required
string

The CartCreate schema encoded in XML or JSON format.

Accept
required
string

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

Request Body schema:
optional

The new CartCreateController resource

required
object (CartCreate)

This class represents a new Cart to create

Responses

Request samples

Content type
{
  • "CartCreate": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Filter carts

Executes a query and returns a View including the results.

header Parameters
Accept
required
string

The CartView schema is returned in XML or JSON format.

Content-Type
required
string

The CartViewInput schema is posted in XML or JSON format.

Request Body schema:
optional

The new CartViewController resource

required
object (CartViewInput)

This class represents a cart view input.

Responses

Request samples

Content type
{
  • "CartViewInput": {
    }
}

Response samples

Content type
{
  • "CartView": {
    }
}

Get Cart

Gets Cart by its identifier.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

The Cart is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "Cart": {
    }
}

Delete Cart

Deletes Cart by its identifier.

path Parameters
identifier
required
string

Responses

Update Cart's metadata

Updates identified Cart's metadata from payload.

path Parameters
identifier
required
string
header Parameters
Content-Type
required
string

The CartMetadataUpdate schema encoded in XML or JSON format.

Accept
required
string

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

Request Body schema:
optional

The updated CartUpdateController resource

required
object (CartMetadataUpdate)

This class represents the update of cart metadata.

Responses

Request samples

Content type
{
  • "CartMetadataUpdate": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Empty Cart

Empties the given Cart.

path Parameters
identifier
required
string

Responses

Add Entry to Cart

Adds an entry to the cart referenced by its identifier

path Parameters
identifier
required
string
header Parameters
Content-Type
required
string

The CartEntryAdd schema encoded in XML or JSON format.

Accept
required
string

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

Request Body schema:
optional

The new CartEntryCreateController resource

required
object (CartEntryAdd)

This class represents a cart entry

Responses

Request samples

Content type
{
  • "CartEntryAdd": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Remove Entry from Cart

Removes the given entry from the given Cart.

path Parameters
identifier
required
string
entryId
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "Cart": {
    }
}

Update Entry from Cart

Updates the given entry from the given Cart.

path Parameters
identifier
required
string
entryId
required
string
header Parameters
Content-Type
required
string

The CartEntryUpdate schema encoded in XML or JSON format.

Accept
required
string

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

Request Body schema:
optional

The updated CartEntryUpdateController resource

required
object (CartEntryUpdate)

Responses

Request samples

Content type
{
  • "CartEntryUpdate": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Cart Summary

Gets a summary of the given Cart.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "CartSummary": {
    }
}

Orders

Cancel order

Cancels the given order.

path Parameters
id
required
string

Responses

Load order by identifier

Loads an order by its identifier (UUID).

path Parameters
identifier
required
string
header Parameters
Accept
required
string

Order - If set, the order returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "Order": {
    }
}

Load order by ID

Loads an order by its numerical ID.

path Parameters
id
required
string
header Parameters
Accept
required
string

Order - If set, the order returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "Order": {
    }
}

Update order

Updates an order.

path Parameters
id
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The OrderUpdate schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.OrderUpdate+json
optional

The updated OrderUpdateController resource

required
object (OrderUpdate)

This class is used to update order.

Responses

Request samples

Content type
application/vnd.ibexa.api.OrderUpdate+json
{
  • "OrderUpdate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Order+json
{
  • "Order": {
    }
}

Load orders

Loads a list of orders.

header Parameters
Accept
required
string

OrderList - If set, the orders list returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "OrderList": {
    }
}

Create order

Creates a new order.

header Parameters
Accept
required
string

If set, the new order is returned in JSON format.

Content-Type
required
string

The Order schema encoded in XML or JSON format.

Request Body schema: application/vnd.ibexa.api.OrderCreate+json
optional

The new OrderCreateController resource

required
object (OrderCreate)

This class is used to create order.

Responses

Request samples

Content type
application/vnd.ibexa.api.OrderCreate+json
{
  • "OrderCreate": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.Order+json
{
  • "Order": {
    }
}

Payments

Create payment method

Creates a PaymentMethodCreateController resource.

header Parameters
Accept
required
string

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

Content-Type
required
string

The Payment Method input schema encoded in XML or JSON.

Request Body schema:
optional

The new PaymentMethodCreateController resource

required
object (PaymentMethodCreateStruct)

Responses

Request samples

Content type
{
  • "PaymentMethodCreateStruct": {
    }
}

Response samples

Content type
{
  • "PaymentMethod": {
    }
}

List payment methods

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
required
string

The view in XML or JSON format.

Content-Type
required
string

The view input in XML or JSON format.

Request Body schema:
optional

The new PaymentMethodFindController resource

required
object (PaymentMethodViewInput)

Responses

Request samples

Content type
{
  • "PaymentMethodViewInput": {
    }
}

Response samples

Content type
{
  • "PaymentMethodView": {
    }
}

Load payment method by identifier

Loads an payment method by its identifier.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

Payment Method - If set, the payment method returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "PaymentMethod": {
    }
}

Delete payment method

Removes the PaymentMethodDeleteController resource.

path Parameters
identifier
required
string

Responses

Update payment method

Updates the PaymentMethodUpdateController resource.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The Payment Method input schema encoded in XML or JSON.

Request Body schema:
optional

The updated PaymentMethodUpdateController resource

required
object (PaymentMethodUpdateStruct)

Responses

Request samples

Content type
{
  • "PaymentMethodUpdateStructParser": {
    }
}

Response samples

Content type
{
  • "PaymentMethod": {
    }
}

Load payment method by id

Loads an payment method by its id.

path Parameters
id
required
string
header Parameters
Accept
required
string

Payment Method - If set, the payment method returned in XML or JSON format.

Responses

Response samples

Content type
application/vnd.ibexa.api.PaymentMethod+json
{
  • "PaymentMethod": {
    }
}

Shipping

Load shipments

Loads a list of shipments.

header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "ShipmentRefList": {
    }
}

Load a single shipment based on its identifier

Loads a single shipment based on its identifier.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Responses

Response samples

Content type
{
  • "Shipment": {
    }
}

Delete shipment

Deletes a shipment.

path Parameters
identifier
required
string

Responses

Update shipment

Updates a shipment.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

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

Content-Type
required
string

The ShipmentUpdate schema encoded in XML or JSON format.

Request Body schema:
optional

The updated ShipmentUpdateController resource

required
object (ShipmentUpdate)

This class represents the update of a shipment.

Responses

Request samples

Content type
{
  • "ShipmentUpdate": {
    }
}

Response samples

Content type
{
  • "Shipment": {
    }
}

Load shipping methods types

Loads shipping methods types.

header Parameters
Accept
required
string

Shipping method type reference - if set, the shipping method is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "ShippingMethodTypesList": {
    }
}

Load shipping method type based on its identifier

Loads shipping methods type based on their identifiers.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

Shipping method type - if set, the shipping method is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "ShippingMethodType": {
    }
}

Load shipping methods

Loads shipping methods.

header Parameters
Accept
required
string

Shipping method reference - if set, the shipping method is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "ShippingMethodRefList": {
    }
}

Load shipping method based on its identifier

Loads shipping method based on its identifier.

path Parameters
identifier
required
string
header Parameters
Accept
required
string

Shipping method - if set, the shipping method is returned in XML or JSON format.

Responses

Response samples

Content type
{
  • "ShippingMethod": {
    }
}