{ "openapi": "3.1.0", "info": { "x-logo": { "url": "https://doc.ibexa.co/en/latest/images/ibexa-dxp-logo.png" }, "title": "Ibexa DXP REST API", "description": "", "version": "6.0.0" }, "servers": [ { "url": "/api/ibexa/v2", "description": "Current server" } ], "paths": { "/activity-log-group/list": { "get": { "operationId": "api_activity-log-grouplist_get", "tags": [ "Activity Log" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ActivityLogGroupList+json": { "schema": { "$ref": "#/components/schemas/ActivityLogGroupListWrapper" }, "example": { "ActivityLogGroupList": { "_media-type": "application/vnd.ibexa.api.ActivityLogGroupList+json", "_href": "/api/ibexa/v2/activity-log-group/list", "ActivityLogGroups": [ { "_media-type": "application/vnd.ibexa.api.ActivityLogGroup+json", "user_id": 14, "logged_at": 1707478796, "ActivityLogEntries": [ { "_media-type": "application/vnd.ibexa.api.ActivityLog+json", "object_id": "396", "object_class": "Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content", "action": "create", "data": [] }, { "_media-type": "application/vnd.ibexa.api.ActivityLog+json", "object_id": "396", "object_class": "Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content", "action": "publish", "data": [] } ] }, { "_media-type": "application/vnd.ibexa.api.ActivityLogGroup+json", "user_id": 14, "logged_at": 1707475048, "ActivityLogEntries": [ { "_media-type": "application/vnd.ibexa.api.ActivityLog+json", "object_id": "395", "object_class": "Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content", "action": "create", "data": [] }, { "_media-type": "application/vnd.ibexa.api.ActivityLog+json", "object_id": "395", "object_class": "Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content", "action": "publish", "data": [] } ] } ] } } }, "application/vnd.ibexa.api.ActivityLogGroupList+xml": { "schema": { "$ref": "#/components/schemas/ActivityLogGroupList" }, "example": "\n\n \n 14\n 1707478796\n \n 396\n Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content\n create\n \n \n \n 396\n Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content\n publish\n \n \n \n \n 14\n 1707475048\n \n 395\n Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content\n create\n \n \n \n 395\n Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content\n publish\n \n \n \n\n" } } }, "401": { "description": "Error - the user is not authorized to list activities." } }, "summary": "List of activity log groups", "description": "Lists last activity log groups and their entries.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/bookmark": { "get": { "operationId": "api_bookmark_get", "tags": [ "Bookmark" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.BookmarkList+json": { "schema": { "$ref": "#/components/schemas/BookmarkListWrapper" }, "example": { "BookmarkList": { "_media-type": "application/vnd.ibexa.api.BookmarkList+json", "count": 3, "items": [ { "_media-type": "application/vnd.ibexa.api.Bookmark+json", "__href": "/api/ibexa/v2/bookmark/65", "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/57/65", "id": 65, "priority": 0, "hidden": false, "invisible": false, "explicitlyHidden": false, "ParentLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/57" }, "pathString": "/1/2/57/65/", "depth": 3, "childCount": 0, "remoteId": "aa538e305aea472eb221ce23d1cc4b50", "Children": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/locations/1/2/57/65/children" }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/63" }, "sortField": "PATH", "sortOrder": "ASC", "UrlAliases": { "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", "_href": "/api/ibexa/v2/content/locations/1/2/57/65/urlaliases" }, "ContentInfo": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/63", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/63", "_remoteId": "211e99934c8fef5900e4813b96ec5c87", "_id": 63, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2" }, "Name": "Art3", "TranslatedName": "Art3", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/63/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/63/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/63/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2021-06-28T11:34:17+00:00", "publishedDate": "2021-06-28T11:34:17+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": false, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/63/objectstates" } } } } }, { "_media-type": "application/vnd.ibexa.api.Bookmark+json", "__href": "/api/ibexa/v2/bookmark/68", "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/58/68", "id": 68, "priority": 0, "hidden": false, "invisible": false, "explicitlyHidden": false, "ParentLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/58" }, "pathString": "/1/2/58/68/", "depth": 3, "childCount": 0, "remoteId": "b8cc4627dbc3ca693c85b6b06a8f7492", "Children": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/locations/1/2/58/68/children" }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/67" }, "sortField": "PUBLISHED", "sortOrder": "DESC", "UrlAliases": { "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", "_href": "/api/ibexa/v2/content/locations/1/2/58/68/urlaliases" }, "ContentInfo": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/67", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/67", "_remoteId": "180adb876af5755d65c1a362fcd619c8", "_id": 67, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/45" }, "Name": "Tip1", "TranslatedName": "Tip1", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/67/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/67/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/67/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2021-06-28T11:36:21+00:00", "publishedDate": "2021-06-28T11:36:21+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/67/objectstates" } } } } }, { "_media-type": "application/vnd.ibexa.api.Bookmark+json", "__href": "/api/ibexa/v2/bookmark/59", "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/59", "id": 59, "priority": 0, "hidden": false, "invisible": false, "explicitlyHidden": false, "ParentLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2" }, "pathString": "/1/2/59/", "depth": 2, "childCount": 3, "remoteId": "fd949fc2eed1fff847d73021ff1a6ea9", "Children": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/children" }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/58" }, "sortField": "PATH", "sortOrder": "ASC", "UrlAliases": { "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/urlaliases" }, "ContentInfo": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/58", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/58", "_remoteId": "00b513aae54036a16e00fb3365c4b5f3", "_id": 58, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1" }, "Name": "Dog Breed Catalog", "TranslatedName": "Dog Breed Catalog", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/58/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/58/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/58/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2021-06-28T11:23:10+00:00", "publishedDate": "2021-06-28T11:23:10+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/58/objectstates" } } } } } ] } } }, "application/vnd.ibexa.api.BookmarkList+xml": { "schema": { "$ref": "#/components/schemas/BookmarkList" }, "example": "\n\n 3\n \n \n 65\n 0\n false\n false\n false\n \n /1/2/57/65/\n 3\n 0\n aa538e305aea472eb221ce23d1cc4b50\n \n \n PATH\n ASC\n \n \n \n \n Art3\n Art3\n \n \n
\n \n \n 2021-06-28T11:34:17+00:00\n 2021-06-28T11:34:17+00:00\n eng-GB\n 1\n false\n false\n PUBLISHED\n \n \n \n \n \n \n \n 68\n 0\n false\n false\n false\n \n /1/2/58/68/\n 3\n 0\n b8cc4627dbc3ca693c85b6b06a8f7492\n \n \n PUBLISHED\n DESC\n \n \n \n \n Tip1\n Tip1\n \n \n
\n \n \n 2021-06-28T11:36:21+00:00\n 2021-06-28T11:36:21+00:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n \n \n \n \n \n 59\n 0\n false\n false\n false\n \n /1/2/59/\n 2\n 3\n fd949fc2eed1fff847d73021ff1a6ea9\n \n \n PATH\n ASC\n \n \n \n \n Dog Breed Catalog\n Dog Breed Catalog\n \n \n
\n \n \n 2021-06-28T11:23:10+00:00\n 2021-06-28T11:23:10+00:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n \n \n \n\n" } } }, "401": { "description": "Error - the user is not authorized to list bookmarks." } }, "summary": "List of bookmarks", "description": "Lists bookmarked Locations for the current user.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/bookmark/{locationId}": { "post": { "operationId": "api_bookmark_locationId_post", "tags": [ "Bookmark" ], "responses": { "201": { "description": "Created." }, "401": { "description": "Error - the user is not authorized to given Location." }, "404": { "description": "Error - the given Location does not exist." }, "409": { "description": "Error - Location is already bookmarked." } }, "summary": "Create bookmark", "description": "Add given Location to bookmarks of the current user.", "parameters": [ { "name": "locationId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new BookmarkCreateController resource", "content": [], "required": false }, "deprecated": false }, "delete": { "operationId": "api_bookmark_locationId_delete", "tags": [ "Bookmark" ], "responses": { "204": { "description": "Deleted - no content." }, "401": { "description": "Error - the user is not authorized for the given Location." }, "404": { "description": "Error - the given Location does not exist / is not bookmarked." } }, "summary": "Delete bookmark", "description": "Deletes the given Location from bookmarks of the current user.", "parameters": [ { "name": "locationId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "head": { "operationId": "api_bookmark_locationId_head", "tags": [ "Bookmark" ], "responses": { "200": { "description": "OK - bookmarked." }, "401": { "description": "Error - the user is not authorized for the given Location." }, "404": { "description": "Error - the given Location does not exist / is not bookmarked." } }, "summary": "Check if Location is bookmarked", "description": "Checks if the given Location is bookmarked by the current user.", "parameters": [ { "name": "locationId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/calendar/event": { "get": { "operationId": "api_calendarevent_get", "tags": [ "Calendar" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.EventList+json": { "schema": { "$ref": "#/components/schemas/EventListWrapper" }, "example": { "EventList": { "_media-type": "application/vnd.ibexa.api.EventList+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597104000&end=1598745600&count=10", "totalCount": 5, "events": [] } } }, "application/vnd.ibexa.api.EventList+xml": { "schema": { "$ref": "#/components/schemas/EventList" }, "example": "\n\n 5\n\n" } } } }, "summary": "Calendar list", "description": "Calendar event list.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the calendar event list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/calendar/event/grouped-by-day": { "get": { "operationId": "api_calendareventgrouped-by-day_get", "tags": [ "Calendar" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.EventGroupList+json": { "schema": { "$ref": "#/components/schemas/EventGroupListWrapper" }, "example": { "EventGroupList": { "_media-type": "application/vnd.ibexa.api.EventGroupList+json", "groups": [ { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597104000&end=1597190400&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1597104000", "endDate": "1597190400" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597190400&end=1597276800&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1597190400", "endDate": "1597276800" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597276800&end=1597363200&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1597276800", "endDate": "1597363200" }, "totalCount": 1, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597363200&end=1597449600&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1597363200", "endDate": "1597449600" }, "totalCount": 1, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597449600&end=1597536000&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1597449600", "endDate": "1597536000" }, "totalCount": 1, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597536000&end=1597622400&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1597536000", "endDate": "1597622400" }, "totalCount": 1, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597622400&end=1597708800&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1597622400", "endDate": "1597708800" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597708800&end=1597795200&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1597708800", "endDate": "1597795200" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597795200&end=1597881600&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1597795200", "endDate": "1597881600" }, "totalCount": 1, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597881600&end=1597968000&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1597881600", "endDate": "1597968000" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1597968000&end=1598054400&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1597968000", "endDate": "1598054400" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1598054400&end=1598140800&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1598054400", "endDate": "1598140800" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1598140800&end=1598227200&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1598140800", "endDate": "1598227200" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1598227200&end=1598313600&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1598227200", "endDate": "1598313600" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1598313600&end=1598400000&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1598313600", "endDate": "1598400000" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1598400000&end=1598486400&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1598400000", "endDate": "1598486400" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1598486400&end=1598572800&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1598486400", "endDate": "1598572800" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1598572800&end=1598659200&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1598572800", "endDate": "1598659200" }, "totalCount": 0, "events": [] }, { "_media-type": "application/vnd.ibexa.api.EventGroup+json", "_currentPage": "/api/ibexa/v2/calendar/event?start=1598659200&end=1598745600&count=10", "DateRange": { "_media-type": "application/vnd.ibexa.api.DateRange+json", "startDate": "1598659200", "endDate": "1598745600" }, "totalCount": 0, "events": [] } ] } } }, "application/vnd.ibexa.api.EventGroupList+xml": { "schema": { "$ref": "#/components/schemas/EventGroupList" }, "example": "\n\n \n \n 1597104000\n 1597190400\n \n 0\n \n \n \n 1597190400\n 1597276800\n \n 0\n \n \n \n 1597276800\n 1597363200\n \n 1\n \n \n \n 1597363200\n 1597449600\n \n 1\n \n \n \n 1597449600\n 1597536000\n \n 1\n \n \n \n 1597536000\n 1597622400\n \n 1\n \n \n \n 1597622400\n 1597708800\n \n 0\n \n \n \n 1597708800\n 1597795200\n \n 0\n \n \n \n 1597795200\n 1597881600\n \n 1\n \n \n \n 1597881600\n 1597968000\n \n 0\n \n \n \n 1597968000\n 1598054400\n \n 0\n \n \n \n 1598054400\n 1598140800\n \n 0\n \n \n \n 1598140800\n 1598227200\n \n 0\n \n \n \n 1598227200\n 1598313600\n \n 0\n \n \n \n 1598313600\n 1598400000\n \n 0\n \n \n \n 1598400000\n 1598486400\n \n 0\n \n \n \n 1598486400\n 1598572800\n \n 0\n \n \n \n 1598572800\n 1598659200\n \n 0\n \n \n \n 1598659200\n 1598745600\n \n 0\n \n\n" } } } }, "summary": "Calendar list grouped by day", "description": "Calendar event list grouped by day.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the calendar event list grouped by day is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/calendar/event/{eventType}": { "post": { "operationId": "api_calendarevent_eventType_post", "tags": [ "Calendar" ], "responses": { "204": { "description": "No Content - the action has been unscheduled." } }, "summary": "Calendar action", "description": "A calendar action that e.g. reschedules or unschedules calendar events. The event type should always be copied from an event.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "eventType", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new EventExecuteActionController resource", "content": { "application/vnd.ibexa.api.calendar.future_hide.UnscheduleAction+json": { "schema": { "$ref": "#/components/schemas/UnscheduleActionWrapper" }, "example": { "UnscheduleAction": { "events": [ "future_publication:2" ] } } }, "application/vnd.ibexa.api.calendar.future_publication.UnscheduleAction+json": { "schema": { "$ref": "#/components/schemas/UnscheduleActionWrapper" }, "example": { "UnscheduleAction": { "events": [ "future_publication:2" ] } } } }, "required": false }, "deprecated": false } }, "/cart": { "post": { "operationId": "api_cart_post", "tags": [ "Cart" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Cart+json": { "schema": { "$ref": "#/components/schemas/CartWrapper" }, "example": { "Cart": { "_media-type": "application/vnd.ibexa.api.Cart+json", "id": 12, "identifier": "fafccc4b-cce1-40d7-8d23-29ad41638581", "name": "Default", "createdAt": "2023-10-12T10:02:51+00:00", "updatedAt": "2023-10-12T10:02:51+00:00", "owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true }, "entries": [] } } }, "application/vnd.ibexa.api.Cart+xml": { "schema": { "$ref": "#/components/schemas/Cart" } } } }, "400": { "description": "Error - The input does not match the input schema definition." } }, "summary": "Create Cart", "description": "Creates Cart from payload.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The CartCreate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Accept", "in": "header", "description": "If set, the created Cart is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CartCreateController resource", "content": { "application/vnd.ibexa.api.CartCreate+json": { "schema": { "$ref": "#/components/schemas/CartCreateWrapper" }, "example": { "CartCreate": { "name": "Default", "currencyCode": "EUR", "context": { "foo": "bar" } } } }, "application/vnd.ibexa.api.CartCreate+xml": { "schema": { "$ref": "#/components/schemas/CartCreate" } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/cart/view": { "post": { "operationId": "api_cartview_post", "tags": [ "Cart" ], "responses": { "200": { "description": "OK - returns a view and its results", "content": { "application/vnd.ibexa.api.CartView+json": { "schema": { "$ref": "#/components/schemas/CartViewWrapper" } }, "application/vnd.ibexa.api.CartView+xml": { "schema": { "$ref": "#/components/schemas/CartView" } } } } }, "summary": "Filter carts", "description": "Executes a query and returns a View including the results.", "parameters": [ { "name": "Accept", "in": "header", "description": "The CartView schema is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The CartViewInput schema is posted in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CartViewController resource", "content": { "application/vnd.ibexa.api.CartViewInput+json": { "schema": { "$ref": "#/components/schemas/CartViewInputWrapper" }, "example": { "CartViewInput": { "identifier": "loadUserCarts", "CartQuery": { "offset": 0, "limit": 10, "ownerId": 123 } } } }, "application/vnd.ibexa.api.CartViewInput+xml": { "schema": { "$ref": "#/components/schemas/CartViewInput" } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/cart/{identifier}": { "get": { "operationId": "api_cart_identifier_get", "tags": [ "Cart" ], "responses": { "200": { "description": "OK - return the cart", "content": { "application/vnd.ibexa.api.Cart+json": { "schema": { "$ref": "#/components/schemas/CartWrapper" }, "example": { "Cart": { "_media-type": "application/vnd.ibexa.api.Cart+json", "id": 12, "identifier": "fafccc4b-cce1-40d7-8d23-29ad41638581", "name": "Default", "createdAt": "2023-10-12T10:02:51+00:00", "updatedAt": "2023-10-12T10:02:51+00:00", "owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true }, "entries": [] } } }, "application/vnd.ibexa.api.Cart+xml": { "schema": { "$ref": "#/components/schemas/Cart" } } } }, "401": { "description": "Error - the user is not authorized to get this cart." }, "404": { "description": "Error - The identifier do not match any Cart." } }, "summary": "Get Cart", "description": "Gets Cart by its identifier.", "parameters": [ { "name": "Accept", "in": "header", "description": "The Cart is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "delete": { "operationId": "api_cart_identifier_delete", "tags": [ "Cart" ], "responses": { "204": { "description": "CartDeleteController resource deleted" } }, "summary": "Delete Cart", "description": "Deletes Cart by its identifier.", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "patch": { "operationId": "api_cart_identifier_patch", "tags": [ "Cart" ], "responses": { "200": { "description": "OK - return the updated cart", "content": { "application/vnd.ibexa.api.Cart+json": { "schema": { "$ref": "#/components/schemas/CartWrapper" } }, "application/vnd.ibexa.api.Cart+xml": { "schema": { "$ref": "#/components/schemas/Cart" } } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update this cart." }, "404": { "description": "Error - The identifier do not match any cart." } }, "summary": "Update Cart's metadata", "description": "Updates identified Cart's metadata from payload.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The CartMetadataUpdate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Accept", "in": "header", "description": "If set, the updated Cart is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated CartUpdateController resource", "content": { "application/vnd.ibexa.api.CartMetadataUpdate+json": { "schema": { "$ref": "#/components/schemas/CartMetadataUpdateWrapper" } }, "application/vnd.ibexa.api.CartMetadataUpdate+xml": { "schema": { "$ref": "#/components/schemas/CartMetadataUpdate" } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/cart/{identifier}/empty": { "post": { "operationId": "api_cart_identifierempty_post", "tags": [ "Cart" ], "responses": { "204": { "description": "No Content - Cart emptied." }, "401": { "description": "Error - The user is not authorized to empty this Cart." }, "404": { "description": "Error - Cart not found." } }, "summary": "Empty Cart", "description": "Empties the given Cart.", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CartEmptyController resource", "content": [], "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/cart/{identifier}/entry": { "post": { "operationId": "api_cart_identifierentry_post", "tags": [ "Cart" ], "responses": { "200": { "description": "OK - return the updated cart", "content": { "application/vnd.ibexa.api.Cart+json": { "schema": { "$ref": "#/components/schemas/CartWrapper" } }, "application/vnd.ibexa.api.Cart+xml": { "schema": { "$ref": "#/components/schemas/Cart" } } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to add an entry to this cart." }, "404": { "description": "Error - The identifier do not match any cart." } }, "summary": "Add Entry to Cart", "description": "Adds an entry to the cart referenced by its identifier", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The CartEntryAdd schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Accept", "in": "header", "description": "If set, the updated Cart is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CartEntryCreateController resource", "content": { "application/vnd.ibexa.api.CartEntryAdd+json": { "schema": { "$ref": "#/components/schemas/CartEntryAddWrapper" } }, "application/vnd.ibexa.api.CartEntryAdd+xml": { "schema": { "$ref": "#/components/schemas/CartEntryAdd" } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/cart/{identifier}/entry/{entryId}": { "delete": { "operationId": "api_cart_identifierentry_entryId_delete", "tags": [ "Cart" ], "responses": { "200": { "description": "OK - return the updated cart", "content": { "application/vnd.ibexa.api.Cart+json": { "schema": { "$ref": "#/components/schemas/CartWrapper" } }, "application/vnd.ibexa.api.Cart+xml": { "schema": { "$ref": "#/components/schemas/Cart" } } } }, "401": { "description": "Error - the user is not authorized to remove an entry from this cart." }, "404": { "description": "Error - the identifiers don't match any cart or entry." }, "204": { "description": "CartEntryRemoveController resource deleted" } }, "summary": "Remove Entry from Cart", "description": "Removes the given entry from the given Cart.", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "entryId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Accept", "in": "header", "description": "If set, the updated Cart is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "patch": { "operationId": "api_cart_identifierentry_entryId_patch", "tags": [ "Cart" ], "responses": { "200": { "description": "OK - return the updated cart", "content": { "application/vnd.ibexa.api.Cart+json": { "schema": { "$ref": "#/components/schemas/CartWrapper" } }, "application/vnd.ibexa.api.Cart+xml": { "schema": { "$ref": "#/components/schemas/Cart" } } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update an entry of this cart." }, "404": { "description": "Error - the identifiers don't match any cart or entry." } }, "summary": "Update Entry from Cart", "description": "Updates the given entry from the given Cart.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The CartEntryUpdate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "entryId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Accept", "in": "header", "description": "If set, the updated Cart is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated CartEntryUpdateController resource", "content": { "application/vnd.ibexa.api.CartEntryUpdate+json": { "schema": { "$ref": "#/components/schemas/CartEntryUpdateWrapper" } }, "application/vnd.ibexa.api.CartEntryUpdate+xml": { "schema": { "$ref": "#/components/schemas/CartEntryUpdate" } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/cart/{identifier}/move-entries-to-shopping-list": { "post": { "operationId": "api_cart_identifiermove-entries-to-shopping-list_post", "tags": [ "Cart" ], "responses": { "200": { "description": "OK - returns the shopping list with added cart entries", "content": { "application/vnd.ibexa.api.ShoppingList+json": { "schema": { "$ref": "#/components/schemas/ShoppingListWrapper" } }, "application/vnd.ibexa.api.ShoppingList+xml": { "schema": { "$ref": "#/components/schemas/ShoppingList" } } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to move cart entries to shopping list." }, "404": { "description": "Error - the cart identifier doesn't match any existing resource." } }, "summary": "Move Selected Cart Entries to Default Shopping List", "description": "Moves selected entries from the given Cart to the default Shopping List (save for later). After moving, selected entries are removed from the cart.", "parameters": [ { "name": "identifier", "in": "path", "description": "The Cart identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new MoveCartEntriesToShoppingListController resource", "content": { "application/vnd.ibexa.api.CartEntryIdentifiers+json": { "schema": { "$ref": "#/components/schemas/CartEntryIdentifiersWrapper" }, "example": { "$ref": "#/components/examples/CartEntryIdentifiersJsonExample" } }, "application/vnd.ibexa.api.CartEntryIdentifiers+xml": { "schema": { "$ref": "#/components/schemas/CartEntryIdentifiers" }, "example": { "$ref": "#/components/examples/CartEntryIdentifiersXmlExample" } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/cart/{identifier}/move-entries-to-shopping-list/{shoppingListIdentifier}": { "post": { "operationId": "api_cart_identifiermove-entries-to-shopping-list_shoppingListIdentifier_post", "tags": [ "Cart" ], "responses": { "200": { "description": "OK - returns the shopping list with added cart entries", "content": { "application/vnd.ibexa.api.ShoppingList+json": { "schema": { "$ref": "#/components/schemas/ShoppingListWrapper" } }, "application/vnd.ibexa.api.ShoppingList+xml": { "schema": { "$ref": "#/components/schemas/ShoppingList" } } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to move cart entries to shopping list." }, "404": { "description": "Error - the cart or shopping list don't match any existing resource." } }, "summary": "Move Selected Cart Entries to Specific Shopping List", "description": "Moves selected entries from the given Cart to the specified Shopping List (save for later). After moving, selected entries are removed from the cart.", "parameters": [ { "name": "identifier", "in": "path", "description": "The Cart identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "shoppingListIdentifier", "in": "path", "description": "The Shopping List identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new MoveCartEntriesToShoppingListController resource", "content": { "application/vnd.ibexa.api.CartEntryIdentifiers+json": { "schema": { "$ref": "#/components/schemas/CartEntryIdentifiersWrapper" }, "example": { "$ref": "#/components/examples/CartEntryIdentifiersJsonExample" } }, "application/vnd.ibexa.api.CartEntryIdentifiers+xml": { "schema": { "$ref": "#/components/schemas/CartEntryIdentifiers" }, "example": { "$ref": "#/components/examples/CartEntryIdentifiersXmlExample" } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/cart/{identifier}/move-to-shopping-list": { "post": { "operationId": "api_cart_identifiermove-to-shopping-list_post", "tags": [ "Cart" ], "responses": { "200": { "description": "OK - returns the shopping list with added cart entries", "content": { "application/vnd.ibexa.api.ShoppingList+json": { "schema": { "$ref": "#/components/schemas/ShoppingListWrapper" } }, "application/vnd.ibexa.api.ShoppingList+xml": { "schema": { "$ref": "#/components/schemas/ShoppingList" } } } }, "401": { "description": "Error - the user is not authorized to move cart to shopping list." }, "404": { "description": "Error - the cart identifier doesn't match any existing resource." } }, "summary": "Move Cart to Default Shopping List", "description": "Moves all entries from the given Cart to the default Shopping List (save for later). After moving, entries are removed from the cart.", "parameters": [ { "name": "identifier", "in": "path", "description": "The Cart identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "No payload required", "content": [], "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/cart/{identifier}/move-to-shopping-list/{shoppingListIdentifier}": { "post": { "operationId": "api_cart_identifiermove-to-shopping-list_shoppingListIdentifier_post", "tags": [ "Cart" ], "responses": { "200": { "description": "OK - returns the shopping list with added cart entries", "content": { "application/vnd.ibexa.api.ShoppingList+json": { "schema": { "$ref": "#/components/schemas/ShoppingListWrapper" } }, "application/vnd.ibexa.api.ShoppingList+xml": { "schema": { "$ref": "#/components/schemas/ShoppingList" } } } }, "401": { "description": "Error - the user is not authorized to move cart to shopping list." }, "404": { "description": "Error - the cart or shopping list identifier doesn't match any existing resource." } }, "summary": "Move Cart to Specific Shopping List", "description": "Moves all entries from the given Cart to the specified Shopping List (save for later). After moving, entries are removed from the cart.", "parameters": [ { "name": "identifier", "in": "path", "description": "The Cart identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "shoppingListIdentifier", "in": "path", "description": "The Shopping List identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "No payload required", "content": [], "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/cart/{identifier}/summary": { "get": { "operationId": "api_cart_identifiersummary_get", "tags": [ "Cart" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.CartSummary+json": { "schema": { "$ref": "#/components/schemas/CartSummaryWrapper" }, "example": { "CartSummary": { "_media-type": "application/vnd.ibexa.api.CartSummary+json", "_href": "/api/ibexa/v2/cart/fdfb2e95-b0b9-4f17-b0cc-08d4d2cfd8f1/summary", "id": 1, "identifier": "fdfb2e95-b0b9-4f17-b0cc-08d4d2cfd8f1", "name": "Updated", "createdAt": "2023-01-10T12:48:40+00:00", "updatedAt": "2023-01-10T12:49:10+00:00", "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "SummaryEntryCollection": { "_media-type": "application/vnd.ibexa.api.SummaryEntryCollection+json", "count": "1", "SummaryEntry": [ { "_media-type": "application/vnd.ibexa.api.CartSummaryEntry+json", "identifier": "ddf3d7bf-ca17-4eff-8265-2d7e00877a91", "id": 1, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Flipper Zero" } ] }, "quantity": 2, "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "RestPrice": { "_media-type": "application/vnd.ibexa.api.RestPrice+json", "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "100", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true } }, "formatted": "\u20ac1.00" } }, "PriceInclVat": { "_media-type": "application/vnd.ibexa.api.PriceInclVat+json", "RestPrice": { "_media-type": "application/vnd.ibexa.api.RestPrice+json", "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "12300", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true } }, "formatted": "\u20ac123.00" } }, "SubtotalPrice": { "_media-type": "application/vnd.ibexa.api.SubtotalPrice+json", "RestPrice": { "_media-type": "application/vnd.ibexa.api.RestPrice+json", "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "20000", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true } }, "formatted": "\u20ac200.00" } }, "SubtotalPriceInclVat": { "_media-type": "application/vnd.ibexa.api.SubtotalPriceInclVat+json", "RestPrice": { "_media-type": "application/vnd.ibexa.api.RestPrice+json", "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "24600", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true } }, "formatted": "\u20ac246.00" } }, "VatCategory": { "_media-type": "application/vnd.ibexa.api.VatCategory+json", "identifier": "default", "region": "poland", "vatValue": 23 }, "Product": { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "0001", "name": "Flipper Zero", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "tool", "name": "Tool", "AttributeAssignmentList": [] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/67", "_remoteId": "3a12e8a3480143ce0159a55e152533b1", "_id": 67, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/50" }, "Name": "Flipper Zero", "TranslatedName": "Flipper Zero", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/67/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/67/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/67/versions/1", "VersionInfo": { "id": 527, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2023-01-10T12:44:41+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-01-10T12:44:41+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Flipper Zero" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/67" } }, "Fields": { "field": [ { "id": 300, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Flipper Zero" }, { "id": 301, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 1, "code": "0001", "attributes": [] } }, { "id": 302, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 303, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } }, { "id": 304, "fieldDefinitionIdentifier": "category", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", "fieldValue": { "taxonomy_entries": [ 3 ], "taxonomy": "product_categories" } }, { "id": 305, "fieldDefinitionIdentifier": "field_63bd5d67f1817", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_seo", "fieldValue": "" } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/67/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/67/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-01-10T12:44:41+00:00", "publishedDate": "2023-01-10T12:44:41+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/67/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1673354681, "updated_at": 1673354681, "AttributesList": [], "Availability": { "_media-type": "application/vnd.ibexa.api.Availability+json", "is_available": true, "stock": 100, "is_infinite": false }, "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "100.00", "base_amount": "100.00", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true }, "money": "10000", "base_money": "10000" } } } ] }, "TotalPrice": { "_media-type": "application/vnd.ibexa.api.Price+json", "RestPrice": { "_media-type": "application/vnd.ibexa.api.RestPrice+json", "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "20000", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true } }, "formatted": "\u20ac200.00" } }, "TotalPriceInclVat": { "_media-type": "application/vnd.ibexa.api.Price+json", "RestPrice": { "_media-type": "application/vnd.ibexa.api.RestPrice+json", "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "24600", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true } }, "formatted": "\u20ac246.00" } }, "vatCategorySummary": [ { "_media-type": "application/vnd.ibexa.api.VatCategorySummary+json", "VatCategory": { "_media-type": "application/vnd.ibexa.api.VatCategory+json", "identifier": "default", "region": "poland", "vatValue": 23 }, "RestPrice": { "_media-type": "application/vnd.ibexa.api.RestPrice+json", "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "4600", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true } }, "formatted": "\u20ac46.00" } } ], "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true } } } }, "application/vnd.ibexa.api.CartSummary+xml": { "schema": { "$ref": "#/components/schemas/CartSummary" } } } }, "401": { "description": "Error - The user is not authorized to read this Cart." }, "404": { "description": "Error - Cart not found." } }, "summary": "Cart Summary", "description": "Gets a summary of the given Cart.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Cart Summary is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/collaboration/sessions": { "post": { "operationId": "api_collaborationsessions_post", "tags": [ "Collaboration Sessions" ], "responses": { "201": { "description": "Session created", "content": { "application/vnd.ibexa.api.ExampleSession+json": { "schema": { "$ref": "#/components/schemas/ExampleSessionWrapper" }, "example": { "CollaborationSession": { "_media-type": "application/vnd.ibexa.api.ExampleSession+json", "createdAt": "2023-11-15T10:30:00+00:00", "id": 123, "token": "abc123def456ghi789", "updatedAt": "2023-11-15T14:45:00+00:00", "ParticipantList": { "_media-type": "application/vnd.ibexa.api.ParticipantList+json", "Participants": [ { "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "_media-type": "application/vnd.ibexa.api.InternalParticipant+json", "createdAt": "2023-11-15T10:30:00+00:00", "id": 1, "name": "John Doe", "scope": "edit", "updatedAt": "2023-11-15T10:30:00+00:00" }, { "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json", "createdAt": "2023-11-15T11:00:00+00:00", "email": "guest@example.com", "id": 2, "name": "guest@example.com", "scope": "view", "updatedAt": "2023-11-15T11:00:00+00:00" } ] }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "subject": "Project Collaboration Session", "isActive": true, "hasPublicLink": false } } }, "application/vnd.ibexa.api.ExampleSession+xml": { "schema": { "$ref": "#/components/schemas/ExampleSessionWrapper" }, "example": "\n\n 123\n abc123def456ghi789\n 2023-11-15T10:30:00+00:00\n 2023-11-15T14:45:00+00:00\n \n \n 1\n John Doe\n edit\n \n 2023-11-15T10:30:00+00:00\n 2023-11-15T10:30:00+00:00\n \n \n 2\n guest@example.com\n view\n guest@example.com\n 2023-11-15T11:00:00+00:00\n 2023-11-15T11:00:00+00:00\n \n \n \n Project Collaboration Session\n true\n false\n\n\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create sessions." } }, "summary": "Create collaboration session", "description": "Creates a new collaboration session with participants and returns the session details.", "parameters": [], "requestBody": { "description": "Session creation payload", "content": { "application/vnd.ibexa.api.ExampleSessionCreate+json": { "schema": { "$ref": "#/components/schemas/ExampleSessionCreate" }, "example": { "ExampleSessionCreate": { "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "ParticipantListCreate": { "_media-type": "application/vnd.ibexa.api.ParticipantListCreate+json", "ParticipantCreate": [ { "_media-type": "application/vnd.ibexa.api.InternalParticipantCreate+json", "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "scope": "view" }, { "_media-type": "application/vnd.ibexa.api.ExternalParticipantCreate+json", "email": "user@link.invalid", "scope": "view" } ] }, "subject": "example" } } }, "application/vnd.ibexa.api.ExampleSessionCreate+xml": { "schema": { "$ref": "#/components/schemas/ExampleSessionCreate" }, "example": "\n\n \n \n \n \n view\n \n \n \n \n user@link.invalid\n view\n \n \n example\n\n\n" } }, "required": false }, "deprecated": false } }, "/collaboration/sessions/{sessionToken}": { "get": { "operationId": "api_collaborationsessions_sessionToken_get", "tags": [ "Collaboration Sessions" ], "responses": { "200": { "description": "Session", "content": { "application/vnd.ibexa.api.ExampleSession+json": { "schema": { "$ref": "#/components/schemas/ExampleSessionWrapper" }, "example": { "CollaborationSession": { "_media-type": "application/vnd.ibexa.api.ExampleSession+json", "createdAt": "2023-11-15T10:30:00+00:00", "id": 123, "token": "abc123def456ghi789", "updatedAt": "2023-11-15T14:45:00+00:00", "ParticipantList": { "_media-type": "application/vnd.ibexa.api.ParticipantList+json", "Participants": [ { "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "_media-type": "application/vnd.ibexa.api.InternalParticipant+json", "createdAt": "2023-11-15T10:30:00+00:00", "id": 1, "name": "John Doe", "scope": "edit", "updatedAt": "2023-11-15T10:30:00+00:00" }, { "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json", "createdAt": "2023-11-15T11:00:00+00:00", "email": "guest@example.com", "id": 2, "name": "guest@example.com", "scope": "view", "updatedAt": "2023-11-15T11:00:00+00:00" } ] }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "subject": "Project Collaboration Session", "isActive": true, "hasPublicLink": false } } }, "application/vnd.ibexa.api.ExampleSession+xml": { "schema": { "$ref": "#/components/schemas/ExampleSessionWrapper" }, "example": "\n\n 123\n abc123def456ghi789\n 2023-11-15T10:30:00+00:00\n 2023-11-15T14:45:00+00:00\n \n \n 1\n John Doe\n edit\n \n 2023-11-15T10:30:00+00:00\n 2023-11-15T10:30:00+00:00\n \n \n 2\n guest@example.com\n view\n guest@example.com\n 2023-11-15T11:00:00+00:00\n 2023-11-15T11:00:00+00:00\n \n \n \n Project Collaboration Session\n true\n false\n\n\n" } } }, "404": { "description": "Error - the session does not exist." }, "401": { "description": "Error - the user is not authorized to access this session." } }, "summary": "Get collaboration session", "description": "Retrieves a collaboration session by its token.", "parameters": [ { "name": "sessionToken", "in": "path", "description": "The session token to retrieve.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_collaborationsessions_sessionToken_delete", "tags": [ "Collaboration Sessions" ], "responses": { "204": { "description": "Session deleted" }, "404": { "description": "Error - the session does not exist." }, "401": { "description": "Error - the user is not authorized to delete this session." } }, "summary": "Delete collaboration session", "description": "Deletes a collaboration session and removes all associated data.", "parameters": [ { "name": "sessionToken", "in": "path", "description": "The session token to delete.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_collaborationsessions_sessionToken_patch", "tags": [ "Collaboration Sessions" ], "responses": { "200": { "description": "Updated session", "content": { "application/vnd.ibexa.api.ExampleSession+json": { "schema": { "$ref": "#/components/schemas/ExampleSessionWrapper" }, "example": { "CollaborationSession": { "_media-type": "application/vnd.ibexa.api.ExampleSession+json", "createdAt": "2023-11-15T10:30:00+00:00", "id": 123, "token": "abc123def456ghi789", "updatedAt": "2023-11-15T14:45:00+00:00", "ParticipantList": { "_media-type": "application/vnd.ibexa.api.ParticipantList+json", "Participants": [ { "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "_media-type": "application/vnd.ibexa.api.InternalParticipant+json", "createdAt": "2023-11-15T10:30:00+00:00", "id": 1, "name": "John Doe", "scope": "edit", "updatedAt": "2023-11-15T10:30:00+00:00" }, { "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json", "createdAt": "2023-11-15T11:00:00+00:00", "email": "guest@example.com", "id": 2, "name": "guest@example.com", "scope": "view", "updatedAt": "2023-11-15T11:00:00+00:00" } ] }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "subject": "Project Collaboration Session", "isActive": true, "hasPublicLink": false } } }, "application/vnd.ibexa.api.ExampleSession+xml": { "schema": { "$ref": "#/components/schemas/ExampleSessionWrapper" }, "example": "\n\n 123\n abc123def456ghi789\n 2023-11-15T10:30:00+00:00\n 2023-11-15T14:45:00+00:00\n \n \n 1\n John Doe\n edit\n \n 2023-11-15T10:30:00+00:00\n 2023-11-15T10:30:00+00:00\n \n \n 2\n guest@example.com\n view\n guest@example.com\n 2023-11-15T11:00:00+00:00\n 2023-11-15T11:00:00+00:00\n \n \n \n Project Collaboration Session\n true\n false\n\n\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "404": { "description": "Error - the session does not exist." }, "401": { "description": "Error - the user is not authorized to update this session." } }, "summary": "Update collaboration session", "description": "Updates collaboration session properties.", "parameters": [ { "name": "sessionToken", "in": "path", "description": "The session token to update.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "Session update payload", "content": { "application/vnd.ibexa.api.ExampleSessionUpdate+json": { "schema": { "$ref": "#/components/schemas/ExampleSessionUpdate" }, "example": { "ExampleSessionUpdate": { "hasPublicLink": true } } }, "application/vnd.ibexa.api.ExampleSessionUpdate+xml": { "schema": { "$ref": "#/components/schemas/ExampleSessionUpdate" }, "example": "\n\n true\n\n\n" } }, "required": false }, "deprecated": false } }, "/collaboration/sessions/{sessionToken}/invitations": { "post": { "operationId": "api_collaborationsessions_sessionTokeninvitations_post", "tags": [ "Collaboration Sessions" ], "responses": { "201": { "description": "Invitation created", "content": { "application/vnd.ibexa.api.Invitation+json": { "schema": { "$ref": "#/components/schemas/InvitationWrapper" } }, "application/vnd.ibexa.api.Invitation+xml": { "schema": { "$ref": "#/components/schemas/InvitationWrapper" } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "404": { "description": "Error - the session does not exist." }, "401": { "description": "Error - the user is not authorized to create invitations for this session." } }, "summary": "Create invitation in collaboration session", "description": "Creates an invitation for a participant to join a collaboration session.", "parameters": [ { "name": "sessionToken", "in": "path", "description": "The session token.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "Invitation creation payload", "content": { "application/vnd.ibexa.api.InvitationCreate+json": { "schema": { "$ref": "#/components/schemas/InvitationCreate" }, "example": { "InvitationCreate": { "email": "external.user@example.com", "Sender": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "context": { "single_value": "value", "simple_array": [ "test", "value1", "value2", "value3", "value4", "value5" ], "extended_array": { "foo": "foo_value", "bar": "bar_value", "baz": "baz_value" } } } } }, "application/vnd.ibexa.api.InvitationCreate+xml": { "schema": { "$ref": "#/components/schemas/InvitationCreate" }, "example": "\n\n \n \n anonymous@link.invalid\n \n \n test\n value1\n value2\n value3\n value4\n value5\n \n value\n \n bar_value\n baz_value\n foo_value\n \n \n\n\n" } }, "required": false }, "deprecated": false } }, "/collaboration/sessions/{sessionToken}/participants": { "get": { "operationId": "api_collaborationsessions_sessionTokenparticipants_get", "tags": [ "Collaboration Sessions" ], "responses": { "200": { "description": "Participants list", "content": { "application/vnd.ibexa.api.ParticipantList+json": { "schema": { "$ref": "#/components/schemas/ParticipantListWrapper" }, "example": { "ParticipantList": { "Participants": [ { "User": { "_href": "/api/ibexa/v2/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" }, "_media-type": "application/vnd.ibexa.api.InternalParticipant+json", "createdAt": "2023-11-15T10:30:00+00:00", "id": 1, "name": "John Doe", "scope": "edit", "updatedAt": "2023-11-15T10:30:00+00:00" }, { "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json", "createdAt": "2023-11-15T11:00:00+00:00", "email": "guest@example.com", "id": 2, "name": "guest@example.com", "scope": "view", "updatedAt": "2023-11-15T11:00:00+00:00" } ], "_media-type": "application/vnd.ibexa.api.ParticipantList+json" } } }, "application/vnd.ibexa.api.ParticipantList+xml": { "schema": { "$ref": "#/components/schemas/ParticipantListWrapper" }, "example": "\n\n \n 1\n John Doe\n edit\n \n 2023-11-15T10:30:00+00:00\n 2023-11-15T10:30:00+00:00\n \n \n 2\n guest@example.com\n view\n guest@example.com\n 2023-11-15T11:00:00+00:00\n 2023-11-15T11:00:00+00:00\n \n\n\n" } } }, "404": { "description": "Error - the session does not exist." }, "401": { "description": "Error - the user is not authorized to access this session." } }, "summary": "List collaboration session participants", "description": "Retrieves a list of all participants in a collaboration session.", "parameters": [ { "name": "sessionToken", "in": "path", "description": "The session token.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_collaborationsessions_sessionTokenparticipants_post", "tags": [ "Collaboration Sessions" ], "responses": { "200": { "description": "Participants list", "content": { "application/vnd.ibexa.api.ParticipantList+json": { "schema": { "$ref": "#/components/schemas/ParticipantListWrapper" }, "example": { "ParticipantList": { "Participants": [ { "User": { "_href": "/api/ibexa/v2/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" }, "_media-type": "application/vnd.ibexa.api.InternalParticipant+json", "createdAt": "2023-11-15T10:30:00+00:00", "id": 1, "name": "John Doe", "scope": "edit", "updatedAt": "2023-11-15T10:30:00+00:00" }, { "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json", "createdAt": "2023-11-15T11:00:00+00:00", "email": "guest@example.com", "id": 2, "name": "guest@example.com", "scope": "view", "updatedAt": "2023-11-15T11:00:00+00:00" } ], "_media-type": "application/vnd.ibexa.api.ParticipantList+json" } } }, "application/vnd.ibexa.api.ParticipantList+xml": { "schema": { "$ref": "#/components/schemas/ParticipantListWrapper" }, "example": "\n\n \n 1\n John Doe\n edit\n \n 2023-11-15T10:30:00+00:00\n 2023-11-15T10:30:00+00:00\n \n \n 2\n guest@example.com\n view\n guest@example.com\n 2023-11-15T11:00:00+00:00\n 2023-11-15T11:00:00+00:00\n \n\n\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "404": { "description": "Error - the session does not exist." }, "401": { "description": "Error - the user is not authorized to modify this session." } }, "summary": "Add participants to collaboration session", "description": "Adds new participants to an existing collaboration session.", "parameters": [ { "name": "sessionToken", "in": "path", "description": "The session token.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "Participant list creation payload", "content": { "application/vnd.ibexa.api.ParticipantListCreate+json": { "schema": { "$ref": "#/components/schemas/ParticipantListCreate" }, "example": { "ParticipantListCreate": { "ParticipantCreate": [ { "_media-type": "application/vnd.ibexa.api.InternalParticipantCreate+json", "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "scope": "view" }, { "_media-type": "application/vnd.ibexa.api.ExternalParticipantCreate+json", "email": "user@link.invalid", "scope": "view" } ] } } }, "application/vnd.ibexa.api.ParticipantListCreate+xml": { "schema": { "$ref": "#/components/schemas/ParticipantListCreate" }, "example": "\n\n \n view\n \n \n \n \n user@link.invalid\n view\n \n\n\n" } }, "required": false }, "deprecated": false } }, "/collaboration/sessions/{sessionToken}/participants/{participantId}": { "delete": { "operationId": "api_collaborationsessions_sessionTokenparticipants_participantId_delete", "tags": [ "Collaboration Sessions" ], "responses": { "204": { "description": "Participant removed" }, "404": { "description": "Error - the session or participant does not exist." }, "401": { "description": "Error - the user is not authorized to modify this session." } }, "summary": "Remove participant from collaboration session", "description": "Removes a participant from a collaboration session.", "parameters": [ { "name": "sessionToken", "in": "path", "description": "The session token.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "participantId", "in": "path", "description": "The participant ID to remove.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_collaborationsessions_sessionTokenparticipants_participantId_patch", "tags": [ "Collaboration Sessions" ], "responses": { "200": { "description": "Updated participant", "content": { "application/vnd.ibexa.api.ExternalParticipant+json": { "schema": { "$ref": "#/components/schemas/ExternalParticipantWrapper" } }, "application/vnd.ibexa.api.ExternalParticipant+xml": { "schema": { "$ref": "#/components/schemas/ExternalParticipantWrapper" } }, "application/vnd.ibexa.api.InternalParticipant+json": { "schema": { "$ref": "#/components/schemas/InternalParticipantWrapper" } }, "application/vnd.ibexa.api.InternalParticipant+xml": { "schema": { "$ref": "#/components/schemas/InternalParticipantWrapper" } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "404": { "description": "Error - the session or participant does not exist." }, "401": { "description": "Error - the user is not authorized to modify this session." } }, "summary": "Update participant in collaboration session", "description": "Updates properties of a participant in a collaboration session.", "parameters": [ { "name": "sessionToken", "in": "path", "description": "The session token.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "participantId", "in": "path", "description": "The participant ID to update.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "Participant update payload", "content": { "application/vnd.ibexa.api.ExternalParticipantUpdate+json": { "schema": { "$ref": "#/components/schemas/ExternalParticipantUpdate" }, "example": { "ExternalParticipantUpdate": { "scope": "view" } } }, "application/vnd.ibexa.api.ExternalParticipantUpdate+xml": { "schema": { "$ref": "#/components/schemas/ExternalParticipantUpdate" }, "example": "\n\n view\n\n\n" }, "application/vnd.ibexa.api.InternalParticipantUpdate+json": { "schema": { "$ref": "#/components/schemas/InternalParticipantUpdate" }, "example": { "InternalParticipantUpdate": { "scope": "view" } } }, "application/vnd.ibexa.api.InternalParticipantUpdate+xml": { "schema": { "$ref": "#/components/schemas/InternalParticipantUpdate" }, "example": "\n\n view\n\n\n" } }, "required": false }, "deprecated": false } }, "/ai/action-types": { "get": { "operationId": "api_aiaction-types_get", "tags": [ "Connector AI" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ai.ActionTypeList+json": { "schema": { "$ref": "#/components/schemas/ActionTypeList" }, "example": { "ActionTypeList": { "_media-type": "application/vnd.ibexa.api.ai.ActionTypeList+json", "_href": "/api/ibexa/v2/ai/action-types", "ActionType": [ { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "generate_alt_text", "name": "Generate alternative text", "inputIdentifier": "image", "outputIdentifier": "text", "options": { "width": 512, "height": 512, "image_quality": 85 } }, { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "refine_text", "name": "Refine text", "inputIdentifier": "text", "outputIdentifier": "text", "options": [] } ] } } }, "application/vnd.ibexa.api.ai.ActionTypeList+xml": { "schema": { "$ref": "#/components/schemas/ActionTypeList" }, "example": "\n\n \n generate_alt_text\n Generate alternative text\n image\n text\n \n 512\n 512\n 85\n \n \n \n refine_text\n Refine text\n text\n text\n \n \n\n" } } } }, "summary": "Get action types list.", "description": "Returns action types list.", "parameters": [], "deprecated": false } }, "/ai/action-types/{identifier}": { "get": { "operationId": "api_aiaction-types_identifier_get", "tags": [ "Connector AI" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ai.ActionType+json": { "schema": { "$ref": "#/components/schemas/ActionType" }, "example": { "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "generate_alt_text", "name": "Generate alternative text", "inputIdentifier": "image", "outputIdentifier": "text", "options": { "width": 512, "height": 512, "image_quality": 85 } } } }, "application/vnd.ibexa.api.ai.ActionType+xml": { "schema": { "$ref": "#/components/schemas/ActionType" }, "example": "\n\n generate_alt_text\n Generate alternative text\n image\n text\n \n 512\n 512\n 85\n \n\n" } } }, "406": { "description": "Error - an action type of the given unique identifier is not found." } }, "summary": "Get an action type by its unique identifier.", "description": "Returns an action type by its unique string identifier.", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false, "example": "generate_alt_text" } ], "deprecated": false } }, "/ai/actions": { "get": { "operationId": "api_aiactions_get", "tags": [ "Connector AI" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ai.ActionConfigurationList+json": { "schema": { "$ref": "#/components/schemas/ActionConfigurationList" }, "example": { "ActionConfigurationList": { "_media-type": "application/vnd.ibexa.api.ai.ActionConfigurationList+json", "_href": "/api/ibexa/v2/ai/actions", "ActionConfiguration": [ { "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json", "identifier": "rewrite_with_friendly_tone", "name": "Rewrite in friendly tone", "description": "", "enabled": true, "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "refine_text", "name": "Refine text", "inputIdentifier": "text", "outputIdentifier": "text", "options": [] }, "actionTypeOptions": [], "actionHandlerIdentifier": "openai-text-to-text", "actionHandlerOptions": { "max_tokens": 4000, "temperature": 1, "prompt": "Rewrite text in friendly tone. Preserve meaning and crucial information.", "model": "gpt-4-turbo" }, "createdAt": "2025-08-07T13:16:47+02:00", "updatedAt": "2025-08-07T13:16:47+02:00" }, { "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json", "identifier": "rewrite_with_professional_tone", "name": "Rewrite in professional tone", "description": "", "enabled": true, "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "refine_text", "name": "Refine text", "inputIdentifier": "text", "outputIdentifier": "text", "options": [] }, "actionTypeOptions": [], "actionHandlerIdentifier": "openai-text-to-text", "actionHandlerOptions": { "max_tokens": 4000, "temperature": 1, "prompt": "Rewrite text in professional tone. Preserve meaning and crucial information.", "model": "gpt-4-turbo" }, "createdAt": "2025-08-07T13:16:47+02:00", "updatedAt": "2025-08-07T13:16:47+02:00" }, { "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json", "identifier": "summarize_text", "name": "Summarize", "description": "", "enabled": true, "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "refine_text", "name": "Refine text", "inputIdentifier": "text", "outputIdentifier": "text", "options": [] }, "actionTypeOptions": [], "actionHandlerIdentifier": "openai-text-to-text", "actionHandlerOptions": { "max_tokens": 4000, "temperature": 1, "prompt": "Summarize text into one sentence. Preserve meaning and crucial information.", "model": "gpt-4-turbo" }, "createdAt": "2025-08-07T13:16:47+02:00", "updatedAt": "2025-08-07T13:16:47+02:00" }, { "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json", "identifier": "expand_text", "name": "Expand text", "description": "", "enabled": true, "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "refine_text", "name": "Refine text", "inputIdentifier": "text", "outputIdentifier": "text", "options": [] }, "actionTypeOptions": [], "actionHandlerIdentifier": "openai-text-to-text", "actionHandlerOptions": { "max_tokens": 4000, "temperature": 1, "prompt": "Expand the given text by 25%. Preserve meaning and crucial information.", "model": "gpt-4-turbo" }, "createdAt": "2025-08-07T13:16:47+02:00", "updatedAt": "2025-08-07T13:16:47+02:00" }, { "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json", "identifier": "shorten_text", "name": "Shorten text", "description": "", "enabled": true, "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "refine_text", "name": "Refine text", "inputIdentifier": "text", "outputIdentifier": "text", "options": [] }, "actionTypeOptions": [], "actionHandlerIdentifier": "openai-text-to-text", "actionHandlerOptions": { "max_tokens": 4000, "temperature": 1, "prompt": "Shorten the given text by 25%. Preserve meaning and crucial information.", "model": "gpt-4-turbo" }, "createdAt": "2025-08-07T13:16:47+02:00", "updatedAt": "2025-08-07T13:16:47+02:00" }, { "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json", "identifier": "proofread", "name": "Proofread", "description": "", "enabled": true, "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "refine_text", "name": "Refine text", "inputIdentifier": "text", "outputIdentifier": "text", "options": [] }, "actionTypeOptions": [], "actionHandlerIdentifier": "openai-text-to-text", "actionHandlerOptions": { "max_tokens": 4000, "temperature": 1, "prompt": "Rewrite given text to identify and fix grammatical and punctuation errors. Preserve meaning and crucial information.", "model": "gpt-4-turbo" }, "createdAt": "2025-08-07T13:16:47+02:00", "updatedAt": "2025-08-07T13:16:47+02:00" }, { "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json", "identifier": "improve_readability", "name": "Improve readability", "description": "", "enabled": true, "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "refine_text", "name": "Refine text", "inputIdentifier": "text", "outputIdentifier": "text", "options": [] }, "actionTypeOptions": [], "actionHandlerIdentifier": "openai-text-to-text", "actionHandlerOptions": { "max_tokens": 4000, "temperature": 1, "prompt": "Rewrite this content to improve readability. Preserve meaning and crucial information.", "model": "gpt-4-turbo" }, "createdAt": "2025-08-07T13:16:47+02:00", "updatedAt": "2025-08-07T13:16:47+02:00" }, { "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json", "identifier": "gen_alt_text", "name": "Generate alternative text", "description": "", "enabled": true, "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "generate_alt_text", "name": "Generate alternative text", "inputIdentifier": "image", "outputIdentifier": "text", "options": { "width": 512, "height": 512, "image_quality": 85 } }, "actionTypeOptions": { "max_length": 140 }, "actionHandlerIdentifier": "openai-image-to-text", "actionHandlerOptions": { "max_tokens": 4000, "temperature": 1, "prompt": "", "model": "gpt-4-turbo" }, "createdAt": "2025-08-07T13:16:47+02:00", "updatedAt": "2025-08-07T13:16:47+02:00" } ] } } }, "application/vnd.ibexa.api.ai.ActionConfigurationList+xml": { "schema": { "$ref": "#/components/schemas/ActionConfigurationList" }, "example": "\n\n \n rewrite_with_friendly_tone\n Rewrite in friendly tone\n \n 1\n \n refine_text\n Refine text\n text\n text\n \n \n \n openai-text-to-text\n \n 4000\n 1\n Rewrite text in friendly tone. Preserve meaning and crucial information.\n gpt-4-turbo\n \n 2025-08-07T13:16:47+02:00\n 2025-08-07T13:16:47+02:00\n \n \n rewrite_with_professional_tone\n Rewrite in professional tone\n \n 1\n \n refine_text\n Refine text\n text\n text\n \n \n \n openai-text-to-text\n \n 4000\n 1\n Rewrite text in professional tone. Preserve meaning and crucial information.\n gpt-4-turbo\n \n 2025-08-07T13:16:47+02:00\n 2025-08-07T13:16:47+02:00\n \n \n summarize_text\n Summarize\n \n 1\n \n refine_text\n Refine text\n text\n text\n \n \n \n openai-text-to-text\n \n 4000\n 1\n Summarize text into one sentence. Preserve meaning and crucial information.\n gpt-4-turbo\n \n 2025-08-07T13:16:47+02:00\n 2025-08-07T13:16:47+02:00\n \n \n expand_text\n Expand text\n \n 1\n \n refine_text\n Refine text\n text\n text\n \n \n \n openai-text-to-text\n \n 4000\n 1\n Expand the given text by 25%. Preserve meaning and crucial information.\n gpt-4-turbo\n \n 2025-08-07T13:16:47+02:00\n 2025-08-07T13:16:47+02:00\n \n \n shorten_text\n Shorten text\n \n 1\n \n refine_text\n Refine text\n text\n text\n \n \n \n openai-text-to-text\n \n 4000\n 1\n Shorten the given text by 25%. Preserve meaning and crucial information.\n gpt-4-turbo\n \n 2025-08-07T13:16:47+02:00\n 2025-08-07T13:16:47+02:00\n \n \n proofread\n Proofread\n \n 1\n \n refine_text\n Refine text\n text\n text\n \n \n \n openai-text-to-text\n \n 4000\n 1\n Rewrite given text to identify and fix grammatical and punctuation errors. Preserve meaning and crucial information.\n gpt-4-turbo\n \n 2025-08-07T13:16:47+02:00\n 2025-08-07T13:16:47+02:00\n \n \n improve_readability\n Improve readability\n \n 1\n \n refine_text\n Refine text\n text\n text\n \n \n \n openai-text-to-text\n \n 4000\n 1\n Rewrite this content to improve readability. Preserve meaning and crucial information.\n gpt-4-turbo\n \n 2025-08-07T13:16:47+02:00\n 2025-08-07T13:16:47+02:00\n \n \n gen_alt_text\n Generate alternative text\n \n 1\n \n generate_alt_text\n Generate alternative text\n image\n text\n \n 512\n 512\n 85\n \n \n \n 140\n \n openai-image-to-text\n \n 4000\n 1\n \n gpt-4-turbo\n \n 2025-08-07T13:16:47+02:00\n 2025-08-07T13:16:47+02:00\n \n\n" } } } }, "summary": "Get action configuration list.", "description": "Returns action configuration list.", "parameters": [], "deprecated": false }, "post": { "operationId": "api_aiactions_post", "tags": [ "Connector AI" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ai.ActionConfigurationList+json": { "schema": { "$ref": "#/components/schemas/ActionConfigurationList" }, "example": { "ActionConfigurationList": { "_media-type": "application/vnd.ibexa.api.ai.ActionConfigurationList+json", "_href": "/api/ibexa/v2/ai/actions", "ActionConfiguration": [ { "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json", "identifier": "rewrite_with_professional_tone", "name": "Rewrite in professional tone", "description": "", "enabled": true, "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "refine_text", "name": "Refine text", "inputIdentifier": "text", "outputIdentifier": "text", "options": [] }, "actionTypeOptions": [], "actionHandlerIdentifier": "openai-text-to-text", "actionHandlerOptions": { "max_tokens": 4000, "temperature": 1, "prompt": "Rewrite text in professional tone. Preserve meaning and crucial information.", "model": "gpt-4-turbo" }, "createdAt": "2025-08-07T13:16:47+02:00", "updatedAt": "2025-08-07T13:16:47+02:00" }, { "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json", "identifier": "rewrite_with_friendly_tone", "name": "Rewrite in friendly tone", "description": "", "enabled": true, "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "refine_text", "name": "Refine text", "inputIdentifier": "text", "outputIdentifier": "text", "options": [] }, "actionTypeOptions": [], "actionHandlerIdentifier": "openai-text-to-text", "actionHandlerOptions": { "max_tokens": 4000, "temperature": 1, "prompt": "Rewrite text in friendly tone. Preserve meaning and crucial information.", "model": "gpt-4-turbo" }, "createdAt": "2025-08-07T13:16:47+02:00", "updatedAt": "2025-08-07T13:16:47+02:00" } ] } } }, "application/vnd.ibexa.api.ai.ActionConfigurationList+xml": { "schema": { "$ref": "#/components/schemas/ActionConfigurationList" }, "example": "\n\n \n rewrite_with_professional_tone\n Rewrite in professional tone\n \n 1\n \n refine_text\n Refine text\n text\n text\n \n \n \n openai-text-to-text\n \n 4000\n 1\n Rewrite text in professional tone. Preserve meaning and crucial information.\n gpt-4-turbo\n \n 2025-08-07T13:16:47+02:00\n 2025-08-07T13:16:47+02:00\n \n \n rewrite_with_friendly_tone\n Rewrite in friendly tone\n \n 1\n \n refine_text\n Refine text\n text\n text\n \n \n \n openai-text-to-text\n \n 4000\n 1\n Rewrite text in friendly tone. Preserve meaning and crucial information.\n gpt-4-turbo\n \n 2025-08-07T13:16:47+02:00\n 2025-08-07T13:16:47+02:00\n \n\n" } } } }, "summary": "Query action configuration list.", "description": "Returns action configuration list based on the given query.", "parameters": [ { "name": "X-Csrf-Token", "in": "header", "description": "CSRF token obtained during the authentication.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ActionConfigurationListController resource", "content": { "application/vnd.ibexa.api.ai.ActionConfigurationListInput+json": { "schema": { "$ref": "#/components/schemas/ActionConfigurationListInput" }, "example": { "ActionConfigurationListInput": { "query": "Rewrite", "action_type_identifier": "refine_text", "enabled": true, "limit": 25, "page": 1 } } }, "application/vnd.ibexa.api.ai.ActionConfigurationListInput+xml": { "schema": { "$ref": "#/components/schemas/ActionConfigurationListInput" }, "example": "\n\n Rewrite\n refine_text\n 1\n 25\n 1\n\n" } }, "required": false }, "deprecated": false } }, "/ai/actions/{actionConfigurationIdentifier}/execute": { "post": { "operationId": "api_aiactions_actionConfigurationIdentifierexecute_post", "tags": [ "Connector AI" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ai.AltText+json": { "schema": { "$ref": "#/components/schemas/AltText" }, "example": { "AltText": { "_media-type": "application/vnd.ibexa.api.ai.AltText+json", "Text": { "_media-type": "application/vnd.ibexa.api.ai.Text+json", "text": [ "Blurred image of an open laptop on a desk with paperwork and another laptop in the background." ] } } } }, "application/vnd.ibexa.api.ai.AltText+xml": { "schema": { "$ref": "#/components/schemas/AltText" }, "example": "\n\n \n Sunlit home office with an open laptop, papers, and a blurred background.\n \n\n" }, "application/vnd.ibexa.api.ai.Text+json": { "schema": { "$ref": "#/components/schemas/Text" }, "example": { "Text": { "_media-type": "application/vnd.ibexa.api.ai.Text+json", "text": [ "Hello, how have you been spending your day?" ] } } }, "application/vnd.ibexa.api.ai.Text+xml": { "schema": { "$ref": "#/components/schemas/Text" }, "example": "\n\n Hello, I hope you are well. How have you been spending your day?\n\n" } } }, "400": { "description": "Error - if the provided input or action configuration is invalid or the given action cannot be performed for any reason.", "content": { "application/vnd.ibexa.api.ai.ErrorMessage+json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } }, "application/vnd.ibexa.api.ai.ErrorMessage+xml": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } } } }, "summary": "Execute the given AI action", "description": "Executes the given AI Action using configured ActionConfiguration or ActionHandler, if passed. Might consume AI agent resources.", "parameters": [ { "name": "actionConfigurationIdentifier", "in": "path", "description": "Configured action name (obtain by listing the configured actions via GET `/api/ibexa/v2/ai/actions` endpoint).", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false, "examples": { "rewrite_with_friendly_tone": { "value": "rewrite_with_friendly_tone" }, "rewrite_with_professional_tone": { "value": "rewrite_with_professional_tone" }, "summarize_text": { "value": "summarize_text" }, "expand_text": { "value": "expand_text" }, "shorten_text": { "value": "shorten_text" }, "proofread": { "value": "proofread" }, "improve_readability": { "value": "improve_readability" }, "gen_alt_text": { "value": "gen_alt_text" } } }, { "name": "X-Csrf-Token", "in": "header", "description": "CSRF token obtained during the authentication.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "Input to execute the action. An Input type must match the action type.", "content": { "application/vnd.ibexa.api.ai.GenerateAltText+json": { "schema": { "$ref": "#/components/schemas/GenerateAltText" }, "example": { "GenerateAltText": { "Image": { "base64": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wgARCACMANIDAREAAhEBAxEB/8QAGwAAAQUBAQAAAAAAAAAAAAAAAgABAwQFBgf/xAAaAQADAQEBAQAAAAAAAAAAAAAAAQIDBAUG/9oADAMBAAIQAxAAAAGj879HLORzrbyvP6FbydDfkx/Qx6rzu/uu/wAieoCWCoSmQ4nQ4iSrZ642HVm5vNCNvo7z6nbhq57ZvTpO5NpgjoZFcVZto06SueWpFMU2GgQnB5ThymXXyU628pQIrvr5NfXlr56H0qXSHarTpzptK56aucJoFTJiMQYECBwQ3Q0nnS6siKs5ykree/pXT5tp5Q52ukl0iCNPJ33ZWuL3n7TzxKIRimIC0mkJA4JN1UU15LezY06JZndw6fQ+ry5VATS6CS5FPis+/id5y9cO9xfdZyI2ELlNO5QISGhunnTp49u7GFmi1lfW479xv5pqRll1IqTtZ+PR5Ptvibc7Vn7Tw72nKcpy7lOUDNONISrDNOP2rHRnpaPN1eiYnTVyGpZE/bm7EKOL8/nr817OWrcd9z6+ic7Ny7l6lmmEmkCTZVy9aZF203jNZpXrnDehMEk0mn6XI7TS44rMz6PE+zPG2wmF7bwdGoS7lOU0zlgTEiNVwu2kBWeVQT6TDbouLphw6ZpTydd7Hh0MumMoaiKlwWhwnVyg56zLTvsGDmYnSUlSiFEEmuUGW/nXRpnjea1401sdLXF2LLe3FPJ3XvfOZfD2UTXn90CI5UbzuKbrmxUSubdRZcw1AptFDcZk6cxpdN1IVXL6Dn06TC7riQTiCbQCnFNZ7dDSLCkrytExtE5Koo2o6mGlCyNgjrlWIuSalnTTit6QmWHkTWJw+gLoRiMBDUC5zOrk0FnM5JoiVSz9AWnYgYdendTvZ001bl6SbyDNDLx+bujdQUqNRf0x0KjKx2y9cj1ynEmmadJgBqS1fueictLkY8t03TdU6GhjL5Hk9YiIbintjta87NC1dJnFMmhG07SAE4JdWXUmoQu1Ni5ussMJUIylmjhOP0yahqK9RVuWamFbJkcWUpQuwSgwRsEZCZNIYGQLbUSsVlpFma4/DrdyLkakhC0TmUUoics04p0WZcyaBgYcQxBJsN0IcBUDqNujLmAyRcu0Qk07mRowNJNAwWSpWJc8t0xHGANshxmnG6gKjbwanQgmQ7QOTFKKQTUjE4iAk0IKI2C1Yl2s2hiMBsxhwOq7daj/xAAnEAACAgICAgEFAAMBAAAAAAABAgADBBEFEhATIRQVICIwBiMxMv/aAAgBAQABBQKrJVa0yVi5C7+oSPeheq1N51qkYhHusYSg/wCv+N1nWW5aJHzXaM2/HF1/Diai8dTBx9M+30z7fVPtdM+10x+IoM+zUAni03WOq/x5i3qincBm4vy3HJpGmoPG9SzIrQZHM1JOK5L6s/0P/OZs3fXNzcoG2xhpT4Hi8bTLFi2sJh3nFy6rBZX/ADtOkzbO+Wp+O0BnHr2vq+K/A8GctjxhLZ/juZ3r3/PNfrU3dXD7gMScUu/zyq+9eUvptsMxcg4+TjWi2r+XIN+llQaW4021crcEcQuqvyac9jfq5hn+O5nwD/LOb9oZlddLjsBiAVVewT2ie0fgZlVeyvkKfReZjWmi/BvF9P8ABzpcm7dweZGSFlKNY+Ona659QOZ2M2YwaG1hBf8ANmUihc2p5zqewmtp6mnD5j48XLXr9ckpyxaRufMclRVaXljamS2qmPzZeTKadldLMD/3c27Vg8FhLE7yzHPU8Y2xiJQbKjkFeKUReMrlfH0w4eOIuHjiV0VpPiFfA0I+mmX8y7ASyLx/SeixYQRONX9acSlwMGufRVz6Oue2eyB9x9GWVK0+kqBFdaxbli2GMnY9IewBssEN9qg5NkN9hnuslmUSBepgYwWAz/swUDWeoQFlgsnsXxub8Hwy/ASIdTtN+CnYWYlkGDcZ9vun2y0x+MbqnCiyLwipPtw6/QfriYrUj58ECdRO0P8A1n1GyJi1vaGoRF9naW/Uh1fkJ25HW+VmuXnr5Qz6fkJ9DmtBxWWZTxAErrrpX3177E+d+dTUDzvGbcQ0o45OmNyOJYKszCrn11EXKqae9Z71nuWe5Z7hDfDfZGstMastFpKEXXLFyxFvVp2EBEZwIG3N+NxviH9oy6gG4qfIWBYHKwXRTvwTOzTRM9c6a8b8FRB2EF7LGsWyUsFntH46nWDwJqag+ILiItgPnc7eNzfk/MKCEETbxW3+WoPw1Os1AxEW2dgfGvx3DCZuVmL+Ag/gfG4rGA+NeTDCZuf/xAAnEQACAgICAQMEAwEAAAAAAAAAAQIRAxIQEyEUIDAxQEFhBCIyUf/aAAgBAwEBPwHuWosiFkQppjyI2RnmjA/7E34Mq/t8WPHt5YsZqlzneqIMsf8AJ/R6qR6uR6tnq/0eq/R3p/gWSP8Aw7Uybt/Fi8IsviHk/lSEWPirI4ZSFgivqycItXH4LLL5QuLGzH4RnfkXD4xOpErGXTJRp+6/dEvleWPxEyeZPl8IhLaIyRF7Ir4LL4iKRsNmMyOl78M6ZPwSYpaux/GuKPKMZnfj3xP9RGMxytUP4kLhkfBNOTo6mdTOp+xGORkVMZGVP40JmwhGBfVlI1RqhOIsSY8CFjNaZk8ocTVkX+OWyy+ckqYuLEIRi8RQuVFkJ6nanxp+RxNUUPloocRcThYuFyiWecT1kz1sz1uQ6jrHChWUzRmrGyzc2Gy/fYmJm1CyDUZDxnXLiubHxP6/JZZsbc2zZmvNk8up3N8Sx2dR1miNEao1RSLQ3xXvsvhjJ3+DrZpJDjI1kas62dbOtmjNGdZ1nWikUaGrK5RRXFj91cX8FFFcao0Os0NfsaK4r30X9jfw395//8QAJhEAAgIBAwQCAwEBAAAAAAAAAAECERIDEBMgITAxQVEEFCJAYf/aAAgBAgEBPwGehJyJfjsehI4ZEdKVEtOR+LpuzXX8Gmv6I+KcqGOxLbTWUiW1GBxnEcbOJiTj6G5MXYXiasaKKH2R+OvklshF0ch/TO8H5WJEyiiZpKoj2W00RqhEo5KhPyMS7DRRRL2Lskh7LaRHsxETVjTvyVbHEcKGiQlch70LaSId0JEo5Kiq7eOPvdxTJwaIrv1yNJ06FtrQ+fHBbolI9IyMjLdjH2NN2tmrRKNOvFGPYoxGT9Gp9Ds7nccZGbMmJSl6HCXyaXYssnDIwZgxwa6YKz53YzUJ+xj2lqoas9EdfAlruQp0c7OdnLJmbMn9llljZZDUrbMzMltqexQUj9dH6qP1UZmZkWKRyGRgYlFCRSEkYmKMUYDgUNFDVmJ6MzPwJ9S2sssyY7KKHErZ9FGAtKzhQ0Rml7OWByx+jmRzI5v+HM/oWq38Ccn8CW2aLsrpaMUVsiJZ2OxaM0jmic0Tmic0TmRznOczORnIxahmZFl9S2vazIyKsx6O21l9FmRkLUaJTsy6r6LL2xK8llleOyyyjErw0UP/AAteL//EADAQAAECAwUHAwQDAQAAAAAAAAEAAhEhMQMQEiAwBCIyQVFhcROBkTM0gqEjUHKS/9oACAEBAAY/AqX1VVVVuZPmhpSUzErd3Qp3R6mF9FRUVFwqimFIITMlDSEKnK3xHNvOCgzeKcHCDhrBvTIEfjKYJzXuJubaCnNBw56rz3yN7TQzYxf6LzvNpqO8Il2Rx9s5Cc03NtB7oOHPTIukpqSb3noY23+i40ppwv7oQQHQAaBCcOVzXjkmuGkboBYnpgTR755uC4hFRAuosDgYKJKqt2+KpeXFQaouuc7oEe0s0GlEvtCYqI4lhMAuK6gUCqBboF81S7DyUnEKRBXCphR6lR55aLoqrjKjjf8AK4nfKlFUKiRdIqBU1VVUnKDhFSfD/SjD3CrcRCUFK6ejCOXhiv4wSOhVMKo0e6m5qOJ4MOyiXPHkLctnqDnYvKlhCON4LuoGjiMmd0XOfABbk2qNiLMjo5fR2X9qTdlH4qVpYD8F9zZD8FPbB7MU9tf7Bff26nt1v/0o2207RadsUFBoAUAYnsuUNPFbNc7sqOUHxPkI+m3D4aqH4UlRUvopNUg1fUh4C3rRxUbO0cFPC/8AS3mlqkRnnq0U1XNJxW9dXVkp6siq/wBv/8QAJhAAAgEDBAEEAwEAAAAAAAAAAAERITFREEFhcYEgkbHBMKHw0f/aAAgBAQABPyF1qlkKqY3VIo9EG0SNJSqSRYpYe0jY2P1tpaBh49FJ8C4x5aWNkzYXgSaYFhgTgjftG12exgUsKVKJkjuJI7AbG/wMQaGDGIFq3V/2CaqGiVGJoeSel4Cv5bcDYx6Mb9bwxVayRtNpHt24Ka/i0RpQ1ZobQkhJ7siY2S6Oo4WUkobG9G/wSBWqlBALiRnAAWDxI/QWUU2gkkS6Jn5CWiSfwybAZAzLkWlHpOTd2i+RPFidEhECXyH+EE7HK0T9g1eUkkk/h7JQ2Yeq0jollC1Inbyf6+hMkkjVJRNCqtByd64JEL8DdCdfIkVNEcVEhgO5bHA2H7+henVjCnauh7VVOgw2O6oymZQiSfTJMsieKCIliTdNhGyEcnI+J2/vCHtxZDmIEolE1Ye4Mm1AI4XEJyLhkqikeWVPto3SCnaRasZ9G5ReGQ2JPPgXM1bkcGy5MRFBJIRFW+CnokhbNpwMtBbGMbQ818iRCcmeCarUWdSfQJcSWQbXCOBWox4qGthYBr2zSBb+2DR3LgcVF2UPJ8ITfJJsxB3ksUHELnoG6+A3lBTMkZYlQrjFi3cCfn3E3QP7DK4RyRKw5RUJxlFaWPoXUkWKMfRIwhdHa7UUpJOCVQ6lCJNlLjRi+C9OVyYRzEUHEYb0JZFNlSpFccO41IEwnJbGwNk6Lv2YdMmM/Yn7jKOw7yiVLUmk2LoP0DtOT3A3wDq38QnUGb3P0iQhvYKBJeScjG2jgOqrMZKHLWwpInS22hVjgVU2JZOG05FZaGX6Nmj+cktQeRIvazJ8BDaIG5fGCT8LPleHvlin6IQ3O/uWtxVDsF2MtZk6E1pAiZHKGEcGPeAJYi2EuCkZvDR40x33BOswY4+jCwswWJjVsyjcQf6G2Hkv4nzID8yvybUPcIU/dF6QnaBvDYux6E5oKFA4dJDJVBLWqYRRggFVHJlRClMqMVhiW5IaPcLabKolglO4zsjYwyobS3XkW/6OQkuNEIStVGqsNAnohpZ3tYOmnZjkpGG3MkyrRMRXHV1QUQWsiGUaEhSIYYkjfzKIkJjLJGxN6H1jRnGm3oI0WqIEGhMnR6ZjQxoNCGHHEz//2gAMAwEAAgADAAAAEIYi+VZ+Ndf03ptaHA3sA0vGKiAxcf0JgkWk4FIfyv686UM0LT4YtCOWtZiJ+LmoV1aIdpLEfJAVQ1isgFKPHwK+ZjftYRScC3SR1snp8vNuvxJgzsFsNzKOR6K8LGfMhsOMobK/QI2G8+02rSuJ49xArEzFZz1Is55eJrJyJfsqUM2T5P8Ak1kdG38bXJNr5ejJmIkgw7iIOt83GqzfS0wqf/1xs0+xWQw6Oes6WodtgWzgWehQzf8A/8QAJhEBAQEAAgICAQIHAAAAAAAAAQARECExQVFhILHwMHGBkaHB0f/aAAgBAwEBPxDGZPFmvdT3NtzzI6GCHO5BBBH4PBwAMOo9aXYNv6KWHXFTwJ+IvoL6yV7HE+XDukQ3ZQQR+WQ4DFu62U+/0nyLC8Lwxf6GmIeIIjg438BvA1lhlvIHZaE/ffDZzGS3d56jHbfD544IILZZm22ww3lHa3ZcJdEtZaI4Uzxg+8hG6N8nDJllttt4EGWSHmNPVrDXeNTruzhZtvN+G7ctuNZeyWWWWW222GGcdzd8kxOrw/mSTjbeFjL3+ycrtHqUssssttsMM5QyMy34wIep5CeCFk48crs5d7JZZZbbbbYZcDiKut5xOvzn9oT1PwX0THGxkYhpY+YHQwpJpA1LLASJFsSkSh4GU8ji/ffLJU5xjyId9wdgSEiGSsrAzU9Mc8wFvG6wyhhu5kzgdWXOYPcN9z/eI9S8y8S1wTdZjYWcEMcg13JPd4gl9N9Vpsb7gy6mKXYYiWWWXnvjLYeBDF2hL+UBwdIMMlyb4R3bsCETuJ6Tj3Y9tl7/AFn5D/P/AGz4Uf2WMPo4FwMMRbCtyylDNVjsEnzJW/u+2fn/AAaE+7PzAQXgkvmfiyVogjbHvkWeBdnhkmdlq3eAskODLHNlt6s+uBjgsssszLMySWW2xZyZwDjI6iAscFlm2WZnh4yzjYYm8jDDDDwG2WZ4Zmf4BFtvJFvH/8QAJREBAQEAAgIDAAIBBQAAAAAAAQARECExQSBRYXGxoTDR4fDx/9oACAECAQE/EPOrT5iEG+IXhE9Q9JN0lj6lt5yyyzhOhJf22sYGwRu6tlt8sbu/A9TKebyyExYepHPlklnGyyJ08p2P1P7hZCEgdyPUevqQGujKM/HLLLLJLwvfDm79Xc/b/X/vHIxbGz7AlB969DbbzllllkkkOrCbN1nBDYP4D/nkIhpLounDrvht+OWWWWSRgI06k8uA3SS1WeCCTbPsvK4gVSlqI4CyyyyySG7ttLwvUh3ZN+uHgLJhpduhBZuYiCD5N7JJIML0nVuj9yJNmAuuCu7ThiPJk4hHOWWTYRhHhhLE2zBKLNhTQ4SvEox0nQ2YuxdmcfkIGBsZ6jLtm4gslDYdBd3CFkES26QK7nGBdO3ll+XCe5H2WkG+WKG28Tj1dgyF3Yfuz7tPc4zz+F2m2nu19372/dj6jc/qwtpmXfrLd1jPuLhHmvSgcH5R9ZDySPGynmcXiNk8WsEebN3zkcHVuDJZEQPqT7LX6tfUM9Qx6OFL6lD0y182z1KJgXVt5jcQuz1YGrYORGT8L/sy/F/xfk/4/wBrfpcDwH9r0Qk93RIcT9JWWckGF5gXSQ+bJKvMIvynyiw9X5R9XE/XI9Ev0Ssp5j3EPuC+HjlsSb4lzgLPq7R1Grc4k7SPKzJnwbniMzq22WGQ4beAtWvAiI4PtZw7HBo+Z14lnG/6Itvi44IeRjv4EOJDMVd2/B4DkBJyckfEYbbBgk+ORBZf/8QAJhABAAIBBAEFAQADAQAAAAAAAQARITFBUWFxEIGRobHRweHw8f/aAAgBAQABPxBQcu1XMDcftL7RnciVogijUrXYhByZsaua7HJLPB9ccWEIQYMpSJMrtHvnC2FK/ae8XoTVW2FVXlgrH5jL+/UuKxycQQH4oL+EKMfET+MSxNsJaD2iKqnxEo59BAt2lYaCj1BYw9SXET0NjTVZl5VVdWYCOUSBnWDh6r86Pp+pcMctoMQywOiAkTW4XYLHH5hDm4bvlCSyVgLixehfqQhLF1DJwdHa/wCpjGO252RgdEPdhOFFg8D/AHMyMHEEf6wCbRaSKWbJaVFSDBcphgBEPVF9BYS5cGDBhtvaVdYU+2P7KKFoqC8TOM2L2MfdTmJt98/5mREzDUI1MDVJlo2hiK3kj2ZuHMMizSMsLcIJFJcuXBlQ7j9R2F5J2wNqcTLay2ljgFKx2v8AyEOwaHUyJcoII2JcEUahRIWvYhrFuAAG8DbFFeoety5fpcPtSkvMLl1Yuolb5yVQXxEHZXjGPt6Iw9BAVGXEVt/tEVuW3H3CrupxAJHDFfqsWXLlytPBM1cqFlimyWG0iHEYlRFinTvRf4jlEKNSdxAJR6A5hXmyokAQxmjjhDDc3gBQTrHKSkWLLl+jxlDurHDLlERpbwVCN2VptKoCBXgy/kZXVj5Fo+vkm7Y41TswTFs2jtW6pX6jd2I6C3WxLXMN8zBvG6dYpD+JP9NhTZt46QdmzRdJWm4IgZrvAMkSmEGLKYbEscA1mIVHLUV3GTCZ0sojvXTG0yvXnaCQEwJd9eX/AMZYy0C8go/UapE1LYQ2lTLyO0r1TUIXJVraB6mSkyjKyua7m34j+T7JmGC1p5YQuXuQKnHiJPt5LyhEWyNdQUZBFqIloKKbgEvtRYW2XTLwc5wYoFBvnKM30SJg873f0ZaRuYNu4Js0Vy/2C3fv+z/owXXN3BH+MfsqOZn5niCIceUbm/VkoSkvIjfgSCY3mJd3YrpDaIhgOIxbZGqW6OzMEB1slUiOCyZz1GyAe6K/qZcg2/oZWz1z7gs1bn5R/tCwntDEAOyXKibasBZ/jDLsWiqZj/HK+yBWh2Z9ELFSzOsyB1JY9yxqy+ILxg94TinmOzAVNIY3FcwOG/eLieIYmvVRA67XYNUfUkfI18PzO9BF1FYsuvyWC9C/eq/bikeAiPyMs3BRXrNAasJdNjfZz8wOjC11jxtUogDIlrwv6lAZsMiQUwc2qhgpXt13gmagGgp7mrD2nQ/MA4NPC6xGVDe37idTIt/iPFEv6lSvW7F667gMasAARhtpALjusRs/XUKd8ojA8s3/AFQtOFD/AFLJ8EYmhqf9tZX+KD/MTIzkI1BF2pPyMiA/42gtKapnzq+4WEzKbXlZfeKbWdh5rSIhea6kp/Awe5AbyxhlDF9idDBAC2HcmKxuHWNO8OGDdFfaOsCAKYK4IgIuTR+SvodQU7xBbA1uMUOhBEzK8BEbfxEbcoHHyEUwTqIP0pEXXcqf5MWA4A/bmU8047LLcgfkgNEm9P8ACOCrmqfJDjxl0wHb2iGEwi9zT59FSzUOzY5ltRUlEfDNKL7Q1dTvDq4sMuwbSjrDF44YihX3DMOYYZ0mSzZSTJiGfhhOa/MA0zyykreIaw6JUyGTkifEcLZFdrkg4YNKRuBR2ynR+YnmDSt41U5J1SiGZwy9SRvJGOGXaREatSVgLOZSZL9FB5RXoMYYk2xO2aaNTsuAURO4xwW6meedj5gBmPRi2SswsVMymAtxDqXaQDeK9ZbG2gzFkUwkllGuE6kT4YxpLmpADpEXDCRwywYFaynMwcxQuDEGEzGzKrga0mjiZwg1Moh2gwplxKJmELmevoDioiZjl5hBzG9zP//Z" }, "RuntimeContext": [] } } }, "application/vnd.ibexa.api.ai.GenerateAltText+xml": { "schema": { "$ref": "#/components/schemas/GenerateAltText" }, "example": "\n\n \n data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wgARCACMANIDAREAAhEBAxEB/8QAGwAAAQUBAQAAAAAAAAAAAAAAAgABAwQFBgf/xAAaAQADAQEBAQAAAAAAAAAAAAAAAQIDBAUG/9oADAMBAAIQAxAAAAGj879HLORzrbyvP6FbydDfkx/Qx6rzu/uu/wAieoCWCoSmQ4nQ4iSrZ642HVm5vNCNvo7z6nbhq57ZvTpO5NpgjoZFcVZto06SueWpFMU2GgQnB5ThymXXyU628pQIrvr5NfXlr56H0qXSHarTpzptK56aucJoFTJiMQYECBwQ3Q0nnS6siKs5ykree/pXT5tp5Q52ukl0iCNPJ33ZWuL3n7TzxKIRimIC0mkJA4JN1UU15LezY06JZndw6fQ+ry5VATS6CS5FPis+/id5y9cO9xfdZyI2ELlNO5QISGhunnTp49u7GFmi1lfW479xv5pqRll1IqTtZ+PR5Ptvibc7Vn7Tw72nKcpy7lOUDNONISrDNOP2rHRnpaPN1eiYnTVyGpZE/bm7EKOL8/nr817OWrcd9z6+ic7Ny7l6lmmEmkCTZVy9aZF203jNZpXrnDehMEk0mn6XI7TS44rMz6PE+zPG2wmF7bwdGoS7lOU0zlgTEiNVwu2kBWeVQT6TDbouLphw6ZpTydd7Hh0MumMoaiKlwWhwnVyg56zLTvsGDmYnSUlSiFEEmuUGW/nXRpnjea1401sdLXF2LLe3FPJ3XvfOZfD2UTXn90CI5UbzuKbrmxUSubdRZcw1AptFDcZk6cxpdN1IVXL6Dn06TC7riQTiCbQCnFNZ7dDSLCkrytExtE5Koo2o6mGlCyNgjrlWIuSalnTTit6QmWHkTWJw+gLoRiMBDUC5zOrk0FnM5JoiVSz9AWnYgYdendTvZ001bl6SbyDNDLx+bujdQUqNRf0x0KjKx2y9cj1ynEmmadJgBqS1fueictLkY8t03TdU6GhjL5Hk9YiIbintjta87NC1dJnFMmhG07SAE4JdWXUmoQu1Ni5ussMJUIylmjhOP0yahqK9RVuWamFbJkcWUpQuwSgwRsEZCZNIYGQLbUSsVlpFma4/DrdyLkakhC0TmUUoics04p0WZcyaBgYcQxBJsN0IcBUDqNujLmAyRcu0Qk07mRowNJNAwWSpWJc8t0xHGANshxmnG6gKjbwanQgmQ7QOTFKKQTUjE4iAk0IKI2C1Yl2s2hiMBsxhwOq7daj/xAAnEAACAgICAgEFAAMBAAAAAAABAgADBBEFEhATIRQVICIwBiMxMv/aAAgBAQABBQKrJVa0yVi5C7+oSPeheq1N51qkYhHusYSg/wCv+N1nWW5aJHzXaM2/HF1/Diai8dTBx9M+30z7fVPtdM+10x+IoM+zUAni03WOq/x5i3qincBm4vy3HJpGmoPG9SzIrQZHM1JOK5L6s/0P/OZs3fXNzcoG2xhpT4Hi8bTLFi2sJh3nFy6rBZX/ADtOkzbO+Wp+O0BnHr2vq+K/A8GctjxhLZ/juZ3r3/PNfrU3dXD7gMScUu/zyq+9eUvptsMxcg4+TjWi2r+XIN+llQaW4021crcEcQuqvyac9jfq5hn+O5nwD/LOb9oZlddLjsBiAVVewT2ie0fgZlVeyvkKfReZjWmi/BvF9P8ABzpcm7dweZGSFlKNY+Ona659QOZ2M2YwaG1hBf8ANmUihc2p5zqewmtp6mnD5j48XLXr9ckpyxaRufMclRVaXljamS2qmPzZeTKadldLMD/3c27Vg8FhLE7yzHPU8Y2xiJQbKjkFeKUReMrlfH0w4eOIuHjiV0VpPiFfA0I+mmX8y7ASyLx/SeixYQRONX9acSlwMGufRVz6Oue2eyB9x9GWVK0+kqBFdaxbli2GMnY9IewBssEN9qg5NkN9hnuslmUSBepgYwWAz/swUDWeoQFlgsnsXxub8Hwy/ASIdTtN+CnYWYlkGDcZ9vun2y0x+MbqnCiyLwipPtw6/QfriYrUj58ECdRO0P8A1n1GyJi1vaGoRF9naW/Uh1fkJ25HW+VmuXnr5Qz6fkJ9DmtBxWWZTxAErrrpX3177E+d+dTUDzvGbcQ0o45OmNyOJYKszCrn11EXKqae9Z71nuWe5Z7hDfDfZGstMastFpKEXXLFyxFvVp2EBEZwIG3N+NxviH9oy6gG4qfIWBYHKwXRTvwTOzTRM9c6a8b8FRB2EF7LGsWyUsFntH46nWDwJqag+ILiItgPnc7eNzfk/MKCEETbxW3+WoPw1Os1AxEW2dgfGvx3DCZuVmL+Ag/gfG4rGA+NeTDCZuf/xAAnEQACAgICAQMEAwEAAAAAAAAAAQIRAxIQEyEUIDAxQEFhBCIyUf/aAAgBAwEBPwHuWosiFkQppjyI2RnmjA/7E34Mq/t8WPHt5YsZqlzneqIMsf8AJ/R6qR6uR6tnq/0eq/R3p/gWSP8Aw7Uybt/Fi8IsviHk/lSEWPirI4ZSFgivqycItXH4LLL5QuLGzH4RnfkXD4xOpErGXTJRp+6/dEvleWPxEyeZPl8IhLaIyRF7Ir4LL4iKRsNmMyOl78M6ZPwSYpaux/GuKPKMZnfj3xP9RGMxytUP4kLhkfBNOTo6mdTOp+xGORkVMZGVP40JmwhGBfVlI1RqhOIsSY8CFjNaZk8ocTVkX+OWyy+ckqYuLEIRi8RQuVFkJ6nanxp+RxNUUPloocRcThYuFyiWecT1kz1sz1uQ6jrHChWUzRmrGyzc2Gy/fYmJm1CyDUZDxnXLiubHxP6/JZZsbc2zZmvNk8up3N8Sx2dR1miNEao1RSLQ3xXvsvhjJ3+DrZpJDjI1kas62dbOtmjNGdZ1nWikUaGrK5RRXFj91cX8FFFcao0Os0NfsaK4r30X9jfw395//8QAJhEAAgIBAwQCAwEBAAAAAAAAAAECERIDEBMgITAxQVEEFCJAYf/aAAgBAgEBPwGehJyJfjsehI4ZEdKVEtOR+LpuzXX8Gmv6I+KcqGOxLbTWUiW1GBxnEcbOJiTj6G5MXYXiasaKKH2R+OvklshF0ch/TO8H5WJEyiiZpKoj2W00RqhEo5KhPyMS7DRRRL2Lskh7LaRHsxETVjTvyVbHEcKGiQlch70LaSId0JEo5Kiq7eOPvdxTJwaIrv1yNJ06FtrQ+fHBbolI9IyMjLdjH2NN2tmrRKNOvFGPYoxGT9Gp9Ds7nccZGbMmJSl6HCXyaXYssnDIwZgxwa6YKz53YzUJ+xj2lqoas9EdfAlruQp0c7OdnLJmbMn9llljZZDUrbMzMltqexQUj9dH6qP1UZmZkWKRyGRgYlFCRSEkYmKMUYDgUNFDVmJ6MzPwJ9S2sssyY7KKHErZ9FGAtKzhQ0Rml7OWByx+jmRzI5v+HM/oWq38Ccn8CW2aLsrpaMUVsiJZ2OxaM0jmic0Tmic0TmRznOczORnIxahmZFl9S2vazIyKsx6O21l9FmRkLUaJTsy6r6LL2xK8llleOyyyjErw0UP/AAteL//EADAQAAECAwUHAwQDAQAAAAAAAAEAAhEhMQMQEiAwBCIyQVFhcROBkTM0gqEjUHKS/9oACAEBAAY/AqX1VVVVuZPmhpSUzErd3Qp3R6mF9FRUVFwqimFIITMlDSEKnK3xHNvOCgzeKcHCDhrBvTIEfjKYJzXuJubaCnNBw56rz3yN7TQzYxf6LzvNpqO8Il2Rx9s5Cc03NtB7oOHPTIukpqSb3noY23+i40ppwv7oQQHQAaBCcOVzXjkmuGkboBYnpgTR755uC4hFRAuosDgYKJKqt2+KpeXFQaouuc7oEe0s0GlEvtCYqI4lhMAuK6gUCqBboF81S7DyUnEKRBXCphR6lR55aLoqrjKjjf8AK4nfKlFUKiRdIqBU1VVUnKDhFSfD/SjD3CrcRCUFK6ejCOXhiv4wSOhVMKo0e6m5qOJ4MOyiXPHkLctnqDnYvKlhCON4LuoGjiMmd0XOfABbk2qNiLMjo5fR2X9qTdlH4qVpYD8F9zZD8FPbB7MU9tf7Bff26nt1v/0o2207RadsUFBoAUAYnsuUNPFbNc7sqOUHxPkI+m3D4aqH4UlRUvopNUg1fUh4C3rRxUbO0cFPC/8AS3mlqkRnnq0U1XNJxW9dXVkp6siq/wBv/8QAJhAAAgEDBAEEAwEAAAAAAAAAAAERITFREEFhcYEgkbHBMKHw0f/aAAgBAQABPyF1qlkKqY3VIo9EG0SNJSqSRYpYe0jY2P1tpaBh49FJ8C4x5aWNkzYXgSaYFhgTgjftG12exgUsKVKJkjuJI7AbG/wMQaGDGIFq3V/2CaqGiVGJoeSel4Cv5bcDYx6Mb9bwxVayRtNpHt24Ka/i0RpQ1ZobQkhJ7siY2S6Oo4WUkobG9G/wSBWqlBALiRnAAWDxI/QWUU2gkkS6Jn5CWiSfwybAZAzLkWlHpOTd2i+RPFidEhECXyH+EE7HK0T9g1eUkkk/h7JQ2Yeq0jollC1Inbyf6+hMkkjVJRNCqtByd64JEL8DdCdfIkVNEcVEhgO5bHA2H7+henVjCnauh7VVOgw2O6oymZQiSfTJMsieKCIliTdNhGyEcnI+J2/vCHtxZDmIEolE1Ye4Mm1AI4XEJyLhkqikeWVPto3SCnaRasZ9G5ReGQ2JPPgXM1bkcGy5MRFBJIRFW+CnokhbNpwMtBbGMbQ818iRCcmeCarUWdSfQJcSWQbXCOBWox4qGthYBr2zSBb+2DR3LgcVF2UPJ8ITfJJsxB3ksUHELnoG6+A3lBTMkZYlQrjFi3cCfn3E3QP7DK4RyRKw5RUJxlFaWPoXUkWKMfRIwhdHa7UUpJOCVQ6lCJNlLjRi+C9OVyYRzEUHEYb0JZFNlSpFccO41IEwnJbGwNk6Lv2YdMmM/Yn7jKOw7yiVLUmk2LoP0DtOT3A3wDq38QnUGb3P0iQhvYKBJeScjG2jgOqrMZKHLWwpInS22hVjgVU2JZOG05FZaGX6Nmj+cktQeRIvazJ8BDaIG5fGCT8LPleHvlin6IQ3O/uWtxVDsF2MtZk6E1pAiZHKGEcGPeAJYi2EuCkZvDR40x33BOswY4+jCwswWJjVsyjcQf6G2Hkv4nzID8yvybUPcIU/dF6QnaBvDYux6E5oKFA4dJDJVBLWqYRRggFVHJlRClMqMVhiW5IaPcLabKolglO4zsjYwyobS3XkW/6OQkuNEIStVGqsNAnohpZ3tYOmnZjkpGG3MkyrRMRXHV1QUQWsiGUaEhSIYYkjfzKIkJjLJGxN6H1jRnGm3oI0WqIEGhMnR6ZjQxoNCGHHEz//2gAMAwEAAgADAAAAEIYi+VZ+Ndf03ptaHA3sA0vGKiAxcf0JgkWk4FIfyv686UM0LT4YtCOWtZiJ+LmoV1aIdpLEfJAVQ1isgFKPHwK+ZjftYRScC3SR1snp8vNuvxJgzsFsNzKOR6K8LGfMhsOMobK/QI2G8+02rSuJ49xArEzFZz1Is55eJrJyJfsqUM2T5P8Ak1kdG38bXJNr5ejJmIkgw7iIOt83GqzfS0wqf/1xs0+xWQw6Oes6WodtgWzgWehQzf8A/8QAJhEBAQEAAgICAQIHAAAAAAAAAQARECExQVFhILHwMHGBkaHB0f/aAAgBAwEBPxDGZPFmvdT3NtzzI6GCHO5BBBH4PBwAMOo9aXYNv6KWHXFTwJ+IvoL6yV7HE+XDukQ3ZQQR+WQ4DFu62U+/0nyLC8Lwxf6GmIeIIjg438BvA1lhlvIHZaE/ffDZzGS3d56jHbfD544IILZZm22ww3lHa3ZcJdEtZaI4Uzxg+8hG6N8nDJllttt4EGWSHmNPVrDXeNTruzhZtvN+G7ctuNZeyWWWWW222GGcdzd8kxOrw/mSTjbeFjL3+ycrtHqUssssttsMM5QyMy34wIep5CeCFk48crs5d7JZZZbbbbYZcDiKut5xOvzn9oT1PwX0THGxkYhpY+YHQwpJpA1LLASJFsSkSh4GU8ji/ffLJU5xjyId9wdgSEiGSsrAzU9Mc8wFvG6wyhhu5kzgdWXOYPcN9z/eI9S8y8S1wTdZjYWcEMcg13JPd4gl9N9Vpsb7gy6mKXYYiWWWXnvjLYeBDF2hL+UBwdIMMlyb4R3bsCETuJ6Tj3Y9tl7/AFn5D/P/AGz4Uf2WMPo4FwMMRbCtyylDNVjsEnzJW/u+2fn/AAaE+7PzAQXgkvmfiyVogjbHvkWeBdnhkmdlq3eAskODLHNlt6s+uBjgsssszLMySWW2xZyZwDjI6iAscFlm2WZnh4yzjYYm8jDDDDwG2WZ4Zmf4BFtvJFvH/8QAJREBAQEAAgIDAAIBBQAAAAAAAQARECExQSBRYXGxoTDR4fDx/9oACAECAQE/EPOrT5iEG+IXhE9Q9JN0lj6lt5yyyzhOhJf22sYGwRu6tlt8sbu/A9TKebyyExYepHPlklnGyyJ08p2P1P7hZCEgdyPUevqQGujKM/HLLLLJLwvfDm79Xc/b/X/vHIxbGz7AlB969DbbzllllkkkOrCbN1nBDYP4D/nkIhpLounDrvht+OWWWWSRgI06k8uA3SS1WeCCTbPsvK4gVSlqI4CyyyyySG7ttLwvUh3ZN+uHgLJhpduhBZuYiCD5N7JJIML0nVuj9yJNmAuuCu7ThiPJk4hHOWWTYRhHhhLE2zBKLNhTQ4SvEox0nQ2YuxdmcfkIGBsZ6jLtm4gslDYdBd3CFkES26QK7nGBdO3ll+XCe5H2WkG+WKG28Tj1dgyF3Yfuz7tPc4zz+F2m2nu19372/dj6jc/qwtpmXfrLd1jPuLhHmvSgcH5R9ZDySPGynmcXiNk8WsEebN3zkcHVuDJZEQPqT7LX6tfUM9Qx6OFL6lD0y182z1KJgXVt5jcQuz1YGrYORGT8L/sy/F/xfk/4/wBrfpcDwH9r0Qk93RIcT9JWWckGF5gXSQ+bJKvMIvynyiw9X5R9XE/XI9Ev0Ssp5j3EPuC+HjlsSb4lzgLPq7R1Grc4k7SPKzJnwbniMzq22WGQ4beAtWvAiI4PtZw7HBo+Z14lnG/6Itvi44IeRjv4EOJDMVd2/B4DkBJyckfEYbbBgk+ORBZf/8QAJhABAAIBBAEFAQADAQAAAAAAAQARITFBUWFxEIGRobHRweHw8f/aAAgBAQABPxBQcu1XMDcftL7RnciVogijUrXYhByZsaua7HJLPB9ccWEIQYMpSJMrtHvnC2FK/ae8XoTVW2FVXlgrH5jL+/UuKxycQQH4oL+EKMfET+MSxNsJaD2iKqnxEo59BAt2lYaCj1BYw9SXET0NjTVZl5VVdWYCOUSBnWDh6r86Pp+pcMctoMQywOiAkTW4XYLHH5hDm4bvlCSyVgLixehfqQhLF1DJwdHa/wCpjGO252RgdEPdhOFFg8D/AHMyMHEEf6wCbRaSKWbJaVFSDBcphgBEPVF9BYS5cGDBhtvaVdYU+2P7KKFoqC8TOM2L2MfdTmJt98/5mREzDUI1MDVJlo2hiK3kj2ZuHMMizSMsLcIJFJcuXBlQ7j9R2F5J2wNqcTLay2ljgFKx2v8AyEOwaHUyJcoII2JcEUahRIWvYhrFuAAG8DbFFeoety5fpcPtSkvMLl1Yuolb5yVQXxEHZXjGPt6Iw9BAVGXEVt/tEVuW3H3CrupxAJHDFfqsWXLlytPBM1cqFlimyWG0iHEYlRFinTvRf4jlEKNSdxAJR6A5hXmyokAQxmjjhDDc3gBQTrHKSkWLLl+jxlDurHDLlERpbwVCN2VptKoCBXgy/kZXVj5Fo+vkm7Y41TswTFs2jtW6pX6jd2I6C3WxLXMN8zBvG6dYpD+JP9NhTZt46QdmzRdJWm4IgZrvAMkSmEGLKYbEscA1mIVHLUV3GTCZ0sojvXTG0yvXnaCQEwJd9eX/AMZYy0C8go/UapE1LYQ2lTLyO0r1TUIXJVraB6mSkyjKyua7m34j+T7JmGC1p5YQuXuQKnHiJPt5LyhEWyNdQUZBFqIloKKbgEvtRYW2XTLwc5wYoFBvnKM30SJg873f0ZaRuYNu4Js0Vy/2C3fv+z/owXXN3BH+MfsqOZn5niCIceUbm/VkoSkvIjfgSCY3mJd3YrpDaIhgOIxbZGqW6OzMEB1slUiOCyZz1GyAe6K/qZcg2/oZWz1z7gs1bn5R/tCwntDEAOyXKibasBZ/jDLsWiqZj/HK+yBWh2Z9ELFSzOsyB1JY9yxqy+ILxg94TinmOzAVNIY3FcwOG/eLieIYmvVRA67XYNUfUkfI18PzO9BF1FYsuvyWC9C/eq/bikeAiPyMs3BRXrNAasJdNjfZz8wOjC11jxtUogDIlrwv6lAZsMiQUwc2qhgpXt13gmagGgp7mrD2nQ/MA4NPC6xGVDe37idTIt/iPFEv6lSvW7F667gMasAARhtpALjusRs/XUKd8ojA8s3/AFQtOFD/AFLJ8EYmhqf9tZX+KD/MTIzkI1BF2pPyMiA/42gtKapnzq+4WEzKbXlZfeKbWdh5rSIhea6kp/Awe5AbyxhlDF9idDBAC2HcmKxuHWNO8OGDdFfaOsCAKYK4IgIuTR+SvodQU7xBbA1uMUOhBEzK8BEbfxEbcoHHyEUwTqIP0pEXXcqf5MWA4A/bmU8047LLcgfkgNEm9P8ACOCrmqfJDjxl0wHb2iGEwi9zT59FSzUOzY5ltRUlEfDNKL7Q1dTvDq4sMuwbSjrDF44YihX3DMOYYZ0mSzZSTJiGfhhOa/MA0zyykreIaw6JUyGTkifEcLZFdrkg4YNKRuBR2ynR+YnmDSt41U5J1SiGZwy9SRvJGOGXaREatSVgLOZSZL9FB5RXoMYYk2xO2aaNTsuAURO4xwW6meedj5gBmPRi2SswsVMymAtxDqXaQDeK9ZbG2gzFkUwkllGuE6kT4YxpLmpADpEXDCRwywYFaynMwcxQuDEGEzGzKrga0mjiZwg1Moh2gwplxKJmELmevoDioiZjl5hBzG9zP//Z\n \n \n\n" }, "application/vnd.ibexa.api.ai.RefineText+json": { "schema": { "$ref": "#/components/schemas/RefineText" }, "example": { "RefineText": { "Text": { "text": [ "Hey, wassup. What you've been doing the whole day?" ] }, "RuntimeContext": [] } } }, "application/vnd.ibexa.api.ai.RefineText+xml": { "schema": { "$ref": "#/components/schemas/RefineText" }, "example": "\n\n \n Hey, wassup. What you've been doing the whole day?\n \n \n\n" } }, "required": false }, "deprecated": false } }, "/ai/actions/{identifier}": { "get": { "operationId": "api_aiactions_identifier_get", "tags": [ "Connector AI" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ai.ActionConfiguration+json": { "schema": { "$ref": "#/components/schemas/ActionConfiguration" }, "example": { "ActionConfiguration": { "_media-type": "application/vnd.ibexa.api.ai.ActionConfiguration+json", "identifier": "rewrite_with_friendly_tone", "name": "Rewrite in friendly tone", "description": "", "enabled": true, "ActionType": { "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", "identifier": "refine_text", "name": "Refine text", "inputIdentifier": "text", "outputIdentifier": "text", "options": [] }, "actionTypeOptions": [], "actionHandlerIdentifier": "openai-text-to-text", "actionHandlerOptions": { "max_tokens": 4000, "temperature": 1, "prompt": "Rewrite text in friendly tone. Preserve meaning and crucial information.", "model": "gpt-4-turbo" }, "createdAt": "2025-08-07T13:16:47+02:00", "updatedAt": "2025-08-07T13:18:00+02:00" } } }, "application/vnd.ibexa.api.ai.ActionConfiguration+xml": { "schema": { "$ref": "#/components/schemas/ActionConfiguration" }, "example": "\n\n rewrite_with_friendly_tone\n Rewrite in friendly tone\n \n 1\n \n refine_text\n Refine text\n text\n text\n \n \n \n openai-text-to-text\n \n 4000\n 1\n Rewrite text in friendly tone. Preserve meaning and crucial information.\n gpt-4-turbo\n \n 2025-08-07T13:16:47+02:00\n 2025-08-07T13:16:47+02:00\n\n" } } }, "404": { "description": "Error - an action configuration of the given unique identifier is not found." }, "401": { "description": "Error \u2013 the user doesn't have access to the given action configuration" } }, "summary": "Get an action configuration by its unique identifier.", "description": "Returns an action configuration by its unique string identifier.", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false, "example": "rewrite_with_friendly_tone" } ], "deprecated": false } }, "/corporate": { "get": { "operationId": "api_corporate_get", "tags": [ "Corporate Account" ], "responses": { "200": { "description": "List of Link objects to specific Corporate Account REST resources", "content": { "application/vnd.ibexa.api.CorporateAccountRoot+json": { "schema": { "$ref": "#/components/schemas/CorporateAccountRootWrapper" }, "example": { "CorporateAccountRoot": { "_media-type": "application/vnd.ibexa.api.CorporateAccountRoot+json", "links": [ { "_media-type": "application/vnd.ibexa.api.CompaniesList+json", "_rel": "ca-companies", "_href": "/api/ibexa/v2/corporate/companies" }, { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_rel": "ca-types", "_href": "/api/ibexa/v2/content/typegroups?identifier=corporate_account" }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_rel": "ca-types-company", "_href": "/api/ibexa/v2/content/types/48" }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_rel": "ca-types-member", "_href": "/api/ibexa/v2/content/types/47" }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_rel": "ca-types-address", "_href": "/api/ibexa/v2/content/types/49" }, { "_media-type": "application/vnd.ibexa.api.SalesRepresentativesList+json", "_rel": "ca-sales-representatives", "_href": "/api/ibexa/v2/corporate/sales-representatives" }, { "_media-type": "application/vnd.ibexa.api.Role+json", "_rel": "ca-role-admin", "_href": "/api/ibexa/v2/user/roles/14" }, { "_media-type": "application/vnd.ibexa.api.Role+json", "_rel": "ca-role-buyer", "_href": "/api/ibexa/v2/user/roles/15" } ] } } }, "application/vnd.ibexa.api.CorporateAccountRoot+xml": { "schema": { "$ref": "#/components/schemas/CorporateAccountRoot" }, "example": "\n\n \n \n \n \n \n \n \n \n\n" } } } }, "summary": "Root Resource", "description": "Provides basic information about Corporate Account endpoints and configuration.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, helps to determine response format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/corporate/companies": { "get": { "operationId": "api_corporatecompanies_get", "tags": [ "Corporate Account" ], "responses": { "200": { "description": "Company list containing Company objects.", "content": { "application/vnd.ibexa.api.CompanyList+json": { "schema": { "$ref": "#/components/schemas/CompanyListWrapper" }, "example": { "CompanyList": { "_media-type": "application/vnd.ibexa.api.CompanyList+json", "companies": [ { "_media-type": "application/vnd.ibexa.api.Company+json", "id": 66, "name": "Ibexa AS", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/66", "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377", "_id": 66, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/48" }, "Name": "Ibexa AS", "TranslatedName": "Ibexa AS", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/66/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/versions/1", "VersionInfo": { "id": 593, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2023-04-03T13:09:40+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-03T13:09:40+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Ibexa AS" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/66" } }, "Fields": { "field": [ { "id": 295, "fieldDefinitionIdentifier": "active", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_boolean", "fieldValue": true }, { "id": 296, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Ibexa AS" }, { "id": 297, "fieldDefinitionIdentifier": "vat", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "123 456 789" }, { "id": 298, "fieldDefinitionIdentifier": "website", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "https://ibexa.co" }, { "id": 299, "fieldDefinitionIdentifier": "customer_group", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_customer_group", "fieldValue": { "customer_group_id": 1 } }, { "id": 300, "fieldDefinitionIdentifier": "sales_rep", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 14, "destinationContentHref": "/api/ibexa/v2/content/objects/14" } }, { "id": 301, "fieldDefinitionIdentifier": "contact", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 74, "destinationContentHref": "/api/ibexa/v2/content/objects/74" } }, { "id": 302, "fieldDefinitionIdentifier": "default_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 69, "destinationContentHref": "/api/ibexa/v2/content/objects/69" } }, { "id": 303, "fieldDefinitionIdentifier": "billing_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_address", "fieldValue": { "name": "Headquarters", "country": "NO", "fields": { "region": "Company HQ location region", "locality": "Company HQ location city", "street": "Company HQ location street and building", "postal_code": "00000", "email": "company@email.invalid", "phone_number": "+47 000 000 000" } } }, { "id": 305, "fieldDefinitionIdentifier": "members", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 67, "destinationContentHref": "/api/ibexa/v2/content/objects/67" } }, { "id": 304, "fieldDefinitionIdentifier": "address_book", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 68, "destinationContentHref": "/api/ibexa/v2/content/objects/68" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/66/versions/6/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/67" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/66/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-03T13:09:40+02:00", "publishedDate": "2023-03-31T14:33:36+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/66/objectstates" } }, "billingAddress": { "name": "Headquarters", "country": "NO", "fields": { "region": "Company HQ location region", "locality": "Company HQ location city", "street": "Company HQ location street and building", "postal_code": "00000", "email": "company@email.invalid", "phone_number": "+47 000 000 000" } }, "contactId": 74, "salesRepresentativeId": 80, "defaultAddressId": 69, "addressBookId": 68, "membersId": 67, "MemberList": { "_media-type": "application/vnd.ibexa.api.MemberList+json", "_href": "/api/ibexa/v2/corporate/companies/66/members" }, "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/67" }, "locationPath": "/1/65/67/", "isActive": true }, { "_media-type": "application/vnd.ibexa.api.Company+json", "id": 75, "name": "QNTM Group AB", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/75", "_remoteId": "1d7eaec5b4371f7a35f253d15ecd5258", "_id": 75, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/48" }, "Name": "QNTM Group AB", "TranslatedName": "QNTM Group AB", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/75/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/75/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/75/versions/3", "VersionInfo": { "id": 546, "versionNo": 3, "status": "PUBLISHED", "modificationDate": "2023-03-31T15:24:49+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-03-31T15:24:49+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "QNTM Group AB" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/75" } }, "Fields": { "field": [ { "id": 341, "fieldDefinitionIdentifier": "active", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_boolean", "fieldValue": true }, { "id": 342, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "QNTM Group AB" }, { "id": 343, "fieldDefinitionIdentifier": "vat", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "123 456 789" }, { "id": 344, "fieldDefinitionIdentifier": "website", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "https://ibexa.co" }, { "id": 345, "fieldDefinitionIdentifier": "customer_group", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_customer_group", "fieldValue": { "customer_group_id": 1 } }, { "id": 346, "fieldDefinitionIdentifier": "sales_rep", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 14, "destinationContentHref": "/api/ibexa/v2/content/objects/14" } }, { "id": 347, "fieldDefinitionIdentifier": "contact", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": null } }, { "id": 348, "fieldDefinitionIdentifier": "default_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": null } }, { "id": 349, "fieldDefinitionIdentifier": "billing_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_address", "fieldValue": { "name": null, "country": null, "fields": [] } }, { "id": 351, "fieldDefinitionIdentifier": "members", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 76, "destinationContentHref": "/api/ibexa/v2/content/objects/76" } }, { "id": 350, "fieldDefinitionIdentifier": "address_book", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 77, "destinationContentHref": "/api/ibexa/v2/content/objects/77" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/75/versions/3/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/76" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/75/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-03-31T15:24:49+02:00", "publishedDate": "2023-03-31T15:24:48+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 3, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/75/objectstates" } }, "billingAddress": { "name": null, "country": null, "fields": [] }, "contactId": null, "salesRepresentativeId": 14, "defaultAddressId": null, "addressBookId": 77, "membersId": 76, "MemberList": { "_media-type": "application/vnd.ibexa.api.MemberList+json", "_href": "/api/ibexa/v2/corporate/companies/75/members" }, "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/76" }, "locationPath": "/1/65/76/", "isActive": true } ] } } }, "application/vnd.ibexa.api.CompanyList+xml": { "schema": { "$ref": "#/components/schemas/CompanyList" }, "example": "\n\n \n 66\n Ibexa AS\n \n \n Ibexa AS\n Ibexa AS\n \n \n \n \n 593\n 1\n PUBLISHED\n 2023-04-03T13:09:40+02:00\n \n 2023-04-03T13:09:40+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Ibexa AS\n \n \n \n \n \n 295\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 296\n name\n eng-GB\n ibexa_string\n Ibexa AS\n \n \n 297\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 298\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 299\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 300\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 301\n contact\n eng-GB\n ibexa_object_relation\n \n 74\n /api/ibexa/v2/content/objects/74\n \n \n \n 302\n default_address\n eng-GB\n ibexa_object_relation\n \n 69\n /api/ibexa/v2/content/objects/69\n \n \n \n 303\n billing_address\n eng-GB\n ibexa_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n 305\n members\n eng-GB\n ibexa_object_relation\n \n 67\n /api/ibexa/v2/content/objects/67\n \n \n \n 304\n address_book\n eng-GB\n ibexa_object_relation\n \n 68\n /api/ibexa/v2/content/objects/68\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-04-03T13:09:40+02:00\n 2023-03-31T14:33:36+02:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n HQ, Poland\n 74\n 14\n 69\n 68\n 67\n \n \n /1/65/67/\n 1\n \n \n 75\n QNTM Group AB\n \n \n QNTM Group AB\n QNTM Group AB\n \n \n \n \n 546\n 3\n PUBLISHED\n 2023-03-31T15:24:49+02:00\n \n 2023-03-31T15:24:49+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n QNTM Group AB\n \n \n \n \n \n 341\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 342\n name\n eng-GB\n ibexa_string\n QNTM Group AB\n \n \n 343\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 344\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 345\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 346\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 347\n contact\n eng-GB\n ibexa_object_relation\n \n \n \n \n \n 348\n default_address\n eng-GB\n ibexa_object_relation\n \n \n \n \n \n 349\n billing_address\n eng-GB\n ibexa_address\n \n \n \n \n \n \n \n 351\n members\n eng-GB\n ibexa_object_relation\n \n 76\n /api/ibexa/v2/content/objects/76\n \n \n \n 350\n address_book\n eng-GB\n ibexa_object_relation\n \n 77\n /api/ibexa/v2/content/objects/77\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-03-31T15:24:49+02:00\n 2023-03-31T15:24:48+02:00\n eng-GB\n 3\n true\n false\n PUBLISHED\n \n \n \n \n 14\n \n 77\n 76\n \n \n /1/65/76/\n 1\n \n\n" } } }, "400": { "description": "Returned when invalid Criterion or Sort clause is used", "content": { "application/vnd.ibexa.api.ErrorMessage": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } } } }, "summary": "Read list of companies", "description": "Returns paginated list of available companies.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, helps to determine response format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "post": { "operationId": "api_corporatecompanies_post", "tags": [ "Corporate Account" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Company+json": { "schema": { "$ref": "#/components/schemas/CompanyWrapper" }, "example": { "Company": { "_media-type": "application/vnd.ibexa.api.Company+json", "id": 66, "name": "Ibexa AS", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/66", "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377", "_id": 66, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/48" }, "Name": "Ibexa AS", "TranslatedName": "Ibexa AS", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/66/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/versions/1", "VersionInfo": { "id": 593, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2023-04-03T13:09:40+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-03T13:09:40+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Ibexa AS" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/66" } }, "Fields": { "field": [ { "id": 295, "fieldDefinitionIdentifier": "active", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_boolean", "fieldValue": true }, { "id": 296, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Ibexa AS" }, { "id": 297, "fieldDefinitionIdentifier": "vat", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "123 456 789" }, { "id": 298, "fieldDefinitionIdentifier": "website", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "https://ibexa.co" }, { "id": 299, "fieldDefinitionIdentifier": "customer_group", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_customer_group", "fieldValue": { "customer_group_id": 1 } }, { "id": 300, "fieldDefinitionIdentifier": "sales_rep", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 14, "destinationContentHref": "/api/ibexa/v2/content/objects/14" } }, { "id": 301, "fieldDefinitionIdentifier": "contact", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 74, "destinationContentHref": "/api/ibexa/v2/content/objects/74" } }, { "id": 302, "fieldDefinitionIdentifier": "default_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 69, "destinationContentHref": "/api/ibexa/v2/content/objects/69" } }, { "id": 303, "fieldDefinitionIdentifier": "billing_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_address", "fieldValue": { "name": "Headquarters", "country": "NO", "fields": { "region": "Company HQ location region", "locality": "Company HQ location city", "street": "Company HQ location street and building", "postal_code": "00000", "email": "company@email.invalid", "phone_number": "+47 000 000 000" } } }, { "id": 305, "fieldDefinitionIdentifier": "members", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 67, "destinationContentHref": "/api/ibexa/v2/content/objects/67" } }, { "id": 304, "fieldDefinitionIdentifier": "address_book", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 68, "destinationContentHref": "/api/ibexa/v2/content/objects/68" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/66/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/67" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/66/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-03T13:09:40+02:00", "publishedDate": "2023-03-31T14:33:36+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/66/objectstates" } }, "billingAddress": { "name": "Headquarters", "country": "NO", "fields": { "region": "Company HQ location region", "locality": "Company HQ location city", "street": "Company HQ location street and building", "postal_code": "00000", "email": "company@email.invalid", "phone_number": "+47 000 000 000" } }, "contactId": 74, "salesRepresentativeId": 80, "defaultAddressId": 69, "addressBookId": 68, "membersId": 67, "MemberList": { "_media-type": "application/vnd.ibexa.api.MemberList+json", "_href": "/api/ibexa/v2/corporate/companies/66/members" }, "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/67" }, "locationPath": "/1/65/67/", "isActive": true } } }, "application/vnd.ibexa.api.Company+xml": { "schema": { "$ref": "#/components/schemas/Company" }, "example": "\n\n 66\n Ibexa AS\n \n \n Ibexa AS\n Ibexa AS\n \n \n \n \n 593\n 1\n PUBLISHED\n 2023-04-03T13:09:40+02:00\n \n 2023-04-03T13:09:40+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Ibexa AS\n \n \n \n \n \n 295\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 296\n name\n eng-GB\n ibexa_string\n Ibexa AS\n \n \n 297\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 298\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 299\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 300\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 301\n contact\n eng-GB\n ibexa_object_relation\n \n 74\n /api/ibexa/v2/content/objects/74\n \n \n \n 302\n default_address\n eng-GB\n ibexa_object_relation\n \n 69\n /api/ibexa/v2/content/objects/69\n \n \n \n 303\n billing_address\n eng-GB\n ibexa_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n 305\n members\n eng-GB\n ibexa_object_relation\n \n 67\n /api/ibexa/v2/content/objects/67\n \n \n \n 304\n address_book\n eng-GB\n ibexa_object_relation\n \n 68\n /api/ibexa/v2/content/objects/68\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-04-03T13:09:40+02:00\n 2023-03-31T14:33:36+02:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n HQ, Poland\n 74\n 80\n 69\n 68\n 67\n \n \n /1/65/67/\n 1\n\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this Company." } }, "summary": "Create a company", "description": "Creates a CompanyCreateController resource.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new company is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The CompanyCreate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CompanyCreateController resource", "content": { "application/vnd.ibexa.api.CompanyCreate+json": { "schema": { "$ref": "#/components/schemas/CompanyCreateWrapper" }, "example": { "CompanyCreate": { "fields": { "field": [ { "fieldDefinitionIdentifier": "active", "fieldValue": true }, { "fieldDefinitionIdentifier": "name", "fieldValue": "Ibexa Sp. z o. o." }, { "fieldDefinitionIdentifier": "vat", "fieldValue": "123 456 789" }, { "fieldDefinitionIdentifier": "website", "fieldValue": "https://ibexa.co" }, { "fieldDefinitionIdentifier": "customer_group", "fieldValue": { "customer_group_id": 1 } }, { "fieldDefinitionIdentifier": "sales_rep", "fieldValue": { "destinationContentId": 14 } }, { "fieldDefinitionIdentifier": "billing_address", "fieldValue": { "name": "HQ", "country": "PL", "fields": { "region": "Silesia", "locality": "Katowice", "street": "Gliwicka 6/5", "postal_code": "40-079", "email": "company@email.invalid", "phone_number": "+48 000 000 000" } } } ] } } } }, "application/vnd.ibexa.api.CompanyCreate+xml": { "schema": { "$ref": "#/components/schemas/CompanyCreate" }, "example": "\n\n \n \n \n active\n true\n \n \n name\n Ibexa Sp. z o. o.\n \n \n vat\n 123 456 789\n \n \n website\n https://ibexa.co\n \n \n customer_group\n \n 1\n \n \n \n sales_rep\n \n 14\n \n \n \n billing_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n\n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/corporate/companies/{companyId}": { "get": { "operationId": "api_corporatecompanies_companyId_get", "tags": [ "Corporate Account" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Company+json": { "schema": { "$ref": "#/components/schemas/CompanyWrapper" }, "example": { "Company": { "_media-type": "application/vnd.ibexa.api.Company+json", "id": 66, "name": "Ibexa AS", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/66", "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377", "_id": 66, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/48" }, "Name": "Ibexa AS", "TranslatedName": "Ibexa AS", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/66/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/versions/1", "VersionInfo": { "id": 593, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2023-04-03T13:09:40+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-03T13:09:40+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Ibexa AS" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/66" } }, "Fields": { "field": [ { "id": 295, "fieldDefinitionIdentifier": "active", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_boolean", "fieldValue": true }, { "id": 296, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Ibexa AS" }, { "id": 297, "fieldDefinitionIdentifier": "vat", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "123 456 789" }, { "id": 298, "fieldDefinitionIdentifier": "website", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "https://ibexa.co" }, { "id": 299, "fieldDefinitionIdentifier": "customer_group", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_customer_group", "fieldValue": { "customer_group_id": 1 } }, { "id": 300, "fieldDefinitionIdentifier": "sales_rep", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 14, "destinationContentHref": "/api/ibexa/v2/content/objects/14" } }, { "id": 301, "fieldDefinitionIdentifier": "contact", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 74, "destinationContentHref": "/api/ibexa/v2/content/objects/74" } }, { "id": 302, "fieldDefinitionIdentifier": "default_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 69, "destinationContentHref": "/api/ibexa/v2/content/objects/69" } }, { "id": 303, "fieldDefinitionIdentifier": "billing_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_address", "fieldValue": { "name": "Headquarters", "country": "NO", "fields": { "region": "Company HQ location region", "locality": "Company HQ location city", "street": "Company HQ location street and building", "postal_code": "00000", "email": "company@email.invalid", "phone_number": "+47 000 000 000" } } }, { "id": 305, "fieldDefinitionIdentifier": "members", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 67, "destinationContentHref": "/api/ibexa/v2/content/objects/67" } }, { "id": 304, "fieldDefinitionIdentifier": "address_book", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 68, "destinationContentHref": "/api/ibexa/v2/content/objects/68" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/66/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/67" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/66/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-03T13:09:40+02:00", "publishedDate": "2023-03-31T14:33:36+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/66/objectstates" } }, "billingAddress": { "name": "Headquarters", "country": "NO", "fields": { "region": "Company HQ location region", "locality": "Company HQ location city", "street": "Company HQ location street and building", "postal_code": "00000", "email": "company@email.invalid", "phone_number": "+47 000 000 000" } }, "contactId": 74, "salesRepresentativeId": 80, "defaultAddressId": 69, "addressBookId": 68, "membersId": 67, "MemberList": { "_media-type": "application/vnd.ibexa.api.MemberList+json", "_href": "/api/ibexa/v2/corporate/companies/66/members" }, "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/67" }, "locationPath": "/1/65/67/", "isActive": true } } }, "application/vnd.ibexa.api.Company+xml": { "schema": { "$ref": "#/components/schemas/Company" }, "example": "\n\n 66\n Ibexa AS\n \n \n Ibexa AS\n Ibexa AS\n \n \n \n \n 593\n 1\n PUBLISHED\n 2023-04-03T13:09:40+02:00\n \n 2023-04-03T13:09:40+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Ibexa AS\n \n \n \n \n \n 295\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 296\n name\n eng-GB\n ibexa_string\n Ibexa AS\n \n \n 297\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 298\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 299\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 300\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 301\n contact\n eng-GB\n ibexa_object_relation\n \n 74\n /api/ibexa/v2/content/objects/74\n \n \n \n 302\n default_address\n eng-GB\n ibexa_object_relation\n \n 69\n /api/ibexa/v2/content/objects/69\n \n \n \n 303\n billing_address\n eng-GB\n ibexa_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n 305\n members\n eng-GB\n ibexa_object_relation\n \n 67\n /api/ibexa/v2/content/objects/67\n \n \n \n 304\n address_book\n eng-GB\n ibexa_object_relation\n \n 68\n /api/ibexa/v2/content/objects/68\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-04-03T13:09:40+02:00\n 2023-03-31T14:33:36+02:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n HQ, Poland\n 74\n 80\n 69\n 68\n 67\n \n \n /1/65/67/\n 1\n\n" } } }, "401": { "description": "Error - The user is not authorized to read this company." }, "404": { "description": "Error - The company does not exist." } }, "summary": "Get company", "description": "Returns the company by given company ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the company is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "companyId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "delete": { "operationId": "api_corporatecompanies_companyId_delete", "tags": [ "Corporate Account" ], "responses": { "204": { "description": "No Content - given company is deleted." }, "401": { "description": "Error - the user is not authorized to delete this company." }, "404": { "description": "Error - the company does not exist." } }, "summary": "Delete company", "description": "The given company is deleted.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, in the case of an error the error message is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "companyId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "patch": { "operationId": "api_corporatecompanies_companyId_patch", "tags": [ "Corporate Account" ], "responses": { "200": { "description": "OK - company updated.", "content": { "application/vnd.ibexa.api.Company+json": { "schema": { "$ref": "#/components/schemas/CompanyWrapper" }, "example": { "Company": { "_media-type": "application/vnd.ibexa.api.Company+json", "id": 66, "name": "Ibexa AS", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/66", "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377", "_id": 66, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/48" }, "Name": "Ibexa AS", "TranslatedName": "Ibexa AS", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/66/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/versions/1", "VersionInfo": { "id": 593, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2023-04-03T13:09:40+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-03T13:09:40+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Ibexa AS" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/66" } }, "Fields": { "field": [ { "id": 295, "fieldDefinitionIdentifier": "active", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_boolean", "fieldValue": true }, { "id": 296, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Ibexa AS" }, { "id": 297, "fieldDefinitionIdentifier": "vat", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "123 456 789" }, { "id": 298, "fieldDefinitionIdentifier": "website", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "https://ibexa.co" }, { "id": 299, "fieldDefinitionIdentifier": "customer_group", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_customer_group", "fieldValue": { "customer_group_id": 1 } }, { "id": 300, "fieldDefinitionIdentifier": "sales_rep", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 14, "destinationContentHref": "/api/ibexa/v2/content/objects/14" } }, { "id": 301, "fieldDefinitionIdentifier": "contact", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 74, "destinationContentHref": "/api/ibexa/v2/content/objects/74" } }, { "id": 302, "fieldDefinitionIdentifier": "default_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 69, "destinationContentHref": "/api/ibexa/v2/content/objects/69" } }, { "id": 303, "fieldDefinitionIdentifier": "billing_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_address", "fieldValue": { "name": "Headquarters", "country": "NO", "fields": { "region": "Company HQ location region", "locality": "Company HQ location city", "street": "Company HQ location street and building", "postal_code": "00000", "email": "company@email.invalid", "phone_number": "+47 000 000 000" } } }, { "id": 305, "fieldDefinitionIdentifier": "members", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 67, "destinationContentHref": "/api/ibexa/v2/content/objects/67" } }, { "id": 304, "fieldDefinitionIdentifier": "address_book", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 68, "destinationContentHref": "/api/ibexa/v2/content/objects/68" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/66/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/67" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/66/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-03T13:09:40+02:00", "publishedDate": "2023-03-31T14:33:36+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/66/objectstates" } }, "billingAddress": { "name": "Headquarters", "country": "NO", "fields": { "region": "Company HQ location region", "locality": "Company HQ location city", "street": "Company HQ location street and building", "postal_code": "00000", "email": "company@email.invalid", "phone_number": "+47 000 000 000" } }, "contactId": 74, "salesRepresentativeId": 80, "defaultAddressId": 69, "addressBookId": 68, "membersId": 67, "MemberList": { "_media-type": "application/vnd.ibexa.api.MemberList+json", "_href": "/api/ibexa/v2/corporate/companies/66/members" }, "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/67" }, "locationPath": "/1/65/67/", "isActive": true } } }, "application/vnd.ibexa.api.Company+xml": { "schema": { "$ref": "#/components/schemas/Company" }, "example": "\n\n 66\n Ibexa AS\n \n \n Ibexa AS\n Ibexa AS\n \n \n \n \n 593\n 1\n PUBLISHED\n 2023-04-03T13:09:40+02:00\n \n 2023-04-03T13:09:40+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Ibexa AS\n \n \n \n \n \n 295\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 296\n name\n eng-GB\n ibexa_string\n Ibexa AS\n \n \n 297\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 298\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 299\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 300\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 301\n contact\n eng-GB\n ibexa_object_relation\n \n 74\n /api/ibexa/v2/content/objects/74\n \n \n \n 302\n default_address\n eng-GB\n ibexa_object_relation\n \n 69\n /api/ibexa/v2/content/objects/69\n \n \n \n 303\n billing_address\n eng-GB\n ibexa_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n 305\n members\n eng-GB\n ibexa_object_relation\n \n 67\n /api/ibexa/v2/content/objects/67\n \n \n \n 304\n address_book\n eng-GB\n ibexa_object_relation\n \n 68\n /api/ibexa/v2/content/objects/68\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-04-03T13:09:40+02:00\n 2023-03-31T14:33:36+02:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n HQ, Poland\n 74\n 80\n 69\n 68\n 67\n \n \n /1/65/67/\n 1\n\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this company." } }, "summary": "Update a company", "description": "Updates a company. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated company is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The company input schema encoded in XML or JSON.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "companyId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated CompanyUpdateController resource", "content": { "application/vnd.ibexa.api.CompanyUpdate+json": { "schema": { "$ref": "#/components/schemas/CompanyUpdateWrapper" }, "example": { "CompanyUpdate": { "fields": { "field": [ { "fieldDefinitionIdentifier": "contact", "fieldValue": { "destinationContentId": 144 } } ] } } } }, "application/vnd.ibexa.api.CompanyUpdate+xml": { "schema": { "$ref": "#/components/schemas/CompanyUpdate" }, "example": "\n\n \n \n contact\n \n 144\n \n \n \n\n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/corporate/companies/{companyId}/members": { "get": { "operationId": "api_corporatecompanies_companyIdmembers_get", "tags": [ "Corporate Account" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.MemberList+json": { "schema": { "$ref": "#/components/schemas/MemberListWrapper" }, "example": { "MemberList": { "_media-type": "application/vnd.ibexa.api.MemberList+json", "_href": "/api/ibexa/v2/corporate/companies/139/members", "members": [ { "_media-type": "application/vnd.ibexa.api.Member+json", "_href": "/api/ibexa/v2/corporate/companies/139/members/144", "id": 144, "name": "Jay Kowalski", "Company": { "_media-type": "application/vnd.ibexa.api.Company+json", "id": 139, "name": "Ibexa Sp. z o. o.", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/139", "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2", "_id": 139, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/48" }, "Name": "Ibexa Sp. z o. o.", "TranslatedName": "Ibexa Sp. z o. o.", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/139/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/139/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/139/versions/6", "VersionInfo": { "id": 677, "versionNo": 6, "status": "PUBLISHED", "modificationDate": "2023-04-28T16:10:13+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-28T16:10:13+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Ibexa Sp. z o. o." } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/139" } }, "Fields": { "field": [ { "id": 673, "fieldDefinitionIdentifier": "active", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_boolean", "fieldValue": true }, { "id": 674, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Ibexa Sp. z o. o." }, { "id": 675, "fieldDefinitionIdentifier": "vat", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "123 456 789" }, { "id": 676, "fieldDefinitionIdentifier": "website", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "https://ibexa.co" }, { "id": 677, "fieldDefinitionIdentifier": "customer_group", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_customer_group", "fieldValue": { "customer_group_id": 1 } }, { "id": 678, "fieldDefinitionIdentifier": "sales_rep", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 14, "destinationContentHref": "/api/ibexa/v2/content/objects/14" } }, { "id": 679, "fieldDefinitionIdentifier": "contact", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 144, "destinationContentHref": "/api/ibexa/v2/content/objects/144" } }, { "id": 680, "fieldDefinitionIdentifier": "default_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 142, "destinationContentHref": "/api/ibexa/v2/content/objects/142" } }, { "id": 681, "fieldDefinitionIdentifier": "billing_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_address", "fieldValue": { "name": "HQ", "country": "PL", "fields": { "region": "Silesia", "locality": "Katowice", "street": "Gliwicka 6/5", "postal_code": "40-079", "email": "company@email.invalid", "phone_number": "+48 000 000 000" } } }, { "id": 683, "fieldDefinitionIdentifier": "members", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 140, "destinationContentHref": "/api/ibexa/v2/content/objects/140" } }, { "id": 682, "fieldDefinitionIdentifier": "address_book", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 141, "destinationContentHref": "/api/ibexa/v2/content/objects/141" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/139/versions/6/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/139/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-28T16:10:13+02:00", "publishedDate": "2023-04-28T15:44:55+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 6, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/139/objectstates" } }, "billingAddress": { "name": "HQ", "country": "PL", "fields": { "region": "Silesia", "locality": "Katowice", "street": "Gliwicka 6/5", "postal_code": "40-079", "email": "company@email.invalid", "phone_number": "+48 000 000 000" } }, "contactId": 144, "salesRepresentativeId": 14, "defaultAddressId": 142, "addressBookId": 141, "membersId": 140, "MemberList": { "_media-type": "application/vnd.ibexa.api.MemberList+json", "_href": "/api/ibexa/v2/corporate/companies/139/members" }, "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140" }, "locationPath": "/1/65/140/", "isActive": true }, "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/144", "_id": 144, "_remoteId": "1b3938c16adfa29996f3afff0b4a0032", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/47" }, "name": "Jay Kowalski", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/144/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140/141/145" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/144/locations" }, "Groups": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/144/groups" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "publishDate": "2023-04-28T16:10:03+02:00", "lastModificationDate": "2023-04-28T16:17:07+02:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/144/versions/6", "VersionInfo": { "id": 683, "versionNo": 6, "status": "PUBLISHED", "modificationDate": "2023-04-28T16:17:07+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-28T16:17:06+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Jay Kowalski" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/144" } }, "Fields": { "field": [ { "id": 698, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Jay" }, { "id": 699, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Kowalski" }, { "id": 700, "fieldDefinitionIdentifier": "phone_number", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "+48 123 123 456" }, { "id": 701, "fieldDefinitionIdentifier": "user", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 144, "login": "jay.kowalski", "email": "jay.kowalski@email.invalid", "passwordUpdatedAt": 1682691427, "enabled": false, "maxLogin": 5, "plainPassword": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/144/versions/6/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/user/default_profile_image/initials.svg?initials=JK#profile_image", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "login": "jay.kowalski", "email": "jay.kowalski@email.invalid", "enabled": false, "UserGroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/users/144/groups" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/144/roles" } }, "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/15", "identifier": "Company Buyer", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/15/policies" } } } ] } } }, "application/vnd.ibexa.api.MemberList+xml": { "schema": { "$ref": "#/components/schemas/MemberList" }, "example": "\n\n \n 144\n Jay Kowalski\n \n 139\n Ibexa Sp. z o. o.\n \n \n Ibexa Sp. z o. o.\n Ibexa Sp. z o. o.\n \n \n \n \n 677\n 6\n PUBLISHED\n 2023-04-28T16:10:13+02:00\n \n 2023-04-28T16:10:13+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Ibexa Sp. z o. o.\n \n \n \n \n \n 673\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 674\n name\n eng-GB\n ibexa_string\n Ibexa Sp. z o. o.\n \n \n 675\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 676\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 677\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 678\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 679\n contact\n eng-GB\n ibexa_object_relation\n \n 144\n /api/ibexa/v2/content/objects/144\n \n \n \n 680\n default_address\n eng-GB\n ibexa_object_relation\n \n 142\n /api/ibexa/v2/content/objects/142\n \n \n \n 681\n billing_address\n eng-GB\n ibexa_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n 683\n members\n eng-GB\n ibexa_object_relation\n \n 140\n /api/ibexa/v2/content/objects/140\n \n \n \n 682\n address_book\n eng-GB\n ibexa_object_relation\n \n 141\n /api/ibexa/v2/content/objects/141\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-04-28T16:10:13+02:00\n 2023-04-28T15:44:55+02:00\n eng-GB\n 6\n true\n false\n PUBLISHED\n \n \n HQ, Poland\n 144\n 14\n 142\n 141\n 140\n \n \n /1/65/140/\n 1\n \n \n \n Jay Kowalski\n \n
\n \n \n \n \n 2023-04-28T16:10:03+02:00\n 2023-04-28T16:17:07+02:00\n eng-GB\n true\n \n \n 683\n 6\n PUBLISHED\n 2023-04-28T16:17:07+02:00\n \n 2023-04-28T16:17:06+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Jay Kowalski\n \n \n \n \n \n 698\n first_name\n eng-GB\n ibexa_string\n Jay\n \n \n 699\n last_name\n eng-GB\n ibexa_string\n Kowalski\n \n \n 700\n phone_number\n eng-GB\n ibexa_string\n +48 123 123 456\n \n \n 701\n user\n eng-GB\n ibexa_user\n \n true\n 144\n jay.kowalski\n jay.kowalski@email.invalid\n 1682691427\n false\n 5\n \n \n \n \n \n \n /user/default_profile_image/initials.svg?initials=JK#profile_image\n \n \n image/svg+xml\n \n \n jay.kowalski\n jay.kowalski@email.invalid\n false\n \n \n \n \n Company Buyer\n \n \n \n\n" } } }, "400": { "description": "Returned when invalid Criterion or Sort clause is used.", "content": { "application/vnd.ibexa.api.ErrorMessage": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } } }, "404": { "description": "Error - The identifier do not match any company." } }, "summary": "Read list of company members", "description": "Returns paginated list of a given company members.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, helps to determine response format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "application/vnd.ibexa.api.MemberList+xml", "application/vnd.ibexa.api.MemberList+json" ] }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "companyId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "filter[DateMetadataCriterion][Target]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "created", "modified", "published" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "filter[DateMetadataCriterion][Operator]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "eq", "gt", "gte", "lt", "lte" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "filter[DateMetadataCriterion][Value]", "in": "query", "description": "DateTime as a UNIX timestamp", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sort[ContentName]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "ascending", "descending" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sort[DatePublished]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "ascending", "descending" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sort[DateModified]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "ascending", "descending" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "offset", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "limit", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "post": { "operationId": "api_corporatecompanies_companyIdmembers_post", "tags": [ "Corporate Account" ], "responses": { "201": { "description": "OK - company member created and returned.", "content": { "application/vnd.ibexa.api.Member+json": { "schema": { "$ref": "#/components/schemas/MemberWrapper" }, "example": { "Member": { "_media-type": "application/vnd.ibexa.api.Member+json", "_href": "/api/ibexa/v2/corporate/companies/139/members/144", "id": 144, "name": "Jay Kowalski", "Company": { "_media-type": "application/vnd.ibexa.api.Company+json", "id": 139, "name": "Ibexa Sp. z o. o.", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/139", "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2", "_id": 139, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/48" }, "Name": "Ibexa Sp. z o. o.", "TranslatedName": "Ibexa Sp. z o. o.", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/139/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/139/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/139/versions/6", "VersionInfo": { "id": 677, "versionNo": 6, "status": "PUBLISHED", "modificationDate": "2023-04-28T16:10:13+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-28T16:10:13+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Ibexa Sp. z o. o." } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/139" } }, "Fields": { "field": [ { "id": 673, "fieldDefinitionIdentifier": "active", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_boolean", "fieldValue": true }, { "id": 674, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Ibexa Sp. z o. o." }, { "id": 675, "fieldDefinitionIdentifier": "vat", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "123 456 789" }, { "id": 676, "fieldDefinitionIdentifier": "website", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "https://ibexa.co" }, { "id": 677, "fieldDefinitionIdentifier": "customer_group", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_customer_group", "fieldValue": { "customer_group_id": 1 } }, { "id": 678, "fieldDefinitionIdentifier": "sales_rep", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 14, "destinationContentHref": "/api/ibexa/v2/content/objects/14" } }, { "id": 679, "fieldDefinitionIdentifier": "contact", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 144, "destinationContentHref": "/api/ibexa/v2/content/objects/144" } }, { "id": 680, "fieldDefinitionIdentifier": "default_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 142, "destinationContentHref": "/api/ibexa/v2/content/objects/142" } }, { "id": 681, "fieldDefinitionIdentifier": "billing_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_address", "fieldValue": { "name": "HQ", "country": "PL", "fields": { "region": "Silesia", "locality": "Katowice", "street": "Gliwicka 6/5", "postal_code": "40-079", "email": "company@email.invalid", "phone_number": "+48 000 000 000" } } }, { "id": 683, "fieldDefinitionIdentifier": "members", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 140, "destinationContentHref": "/api/ibexa/v2/content/objects/140" } }, { "id": 682, "fieldDefinitionIdentifier": "address_book", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 141, "destinationContentHref": "/api/ibexa/v2/content/objects/141" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/139/versions/6/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/139/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-28T16:10:13+02:00", "publishedDate": "2023-04-28T15:44:55+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 6, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/139/objectstates" } }, "billingAddress": { "name": "HQ", "country": "PL", "fields": { "region": "Silesia", "locality": "Katowice", "street": "Gliwicka 6/5", "postal_code": "40-079", "email": "company@email.invalid", "phone_number": "+48 000 000 000" } }, "contactId": 144, "salesRepresentativeId": 14, "defaultAddressId": 142, "addressBookId": 141, "membersId": 140, "MemberList": { "_media-type": "application/vnd.ibexa.api.MemberList+json", "_href": "/api/ibexa/v2/corporate/companies/139/members" }, "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140" }, "locationPath": "/1/65/140/", "isActive": true }, "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/144", "_id": 144, "_remoteId": "1b3938c16adfa29996f3afff0b4a0032", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/47" }, "name": "Jay Kowalski", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/144/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140/141/145" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/144/locations" }, "Groups": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/144/groups" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "publishDate": "2023-04-28T16:10:03+02:00", "lastModificationDate": "2023-04-28T16:17:07+02:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/144/versions/6", "VersionInfo": { "id": 683, "versionNo": 6, "status": "PUBLISHED", "modificationDate": "2023-04-28T16:17:07+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-28T16:17:06+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Jay Kowalski" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/144" } }, "Fields": { "field": [ { "id": 698, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Jay" }, { "id": 699, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Kowalski" }, { "id": 700, "fieldDefinitionIdentifier": "phone_number", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "+48 123 123 456" }, { "id": 701, "fieldDefinitionIdentifier": "user", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 144, "login": "jay.kowalski", "email": "jay.kowalski@email.invalid", "passwordUpdatedAt": 1682691427, "enabled": false, "maxLogin": 5, "plainPassword": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/144/versions/6/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/user/default_profile_image/initials.svg?initials=JK#profile_image", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "login": "jay.kowalski", "email": "jay.kowalski@email.invalid", "enabled": false, "UserGroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/users/144/groups" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/144/roles" } }, "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/15", "identifier": "Company Buyer", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/15/policies" } } } } }, "application/vnd.ibexa.api.Member+xml": { "schema": { "$ref": "#/components/schemas/Member" }, "example": "\n\n 144\n Jay Kowalski\n \n 139\n Ibexa Sp. z o. o.\n \n \n Ibexa Sp. z o. o.\n Ibexa Sp. z o. o.\n \n \n \n \n 677\n 6\n PUBLISHED\n 2023-04-28T16:10:13+02:00\n \n 2023-04-28T16:10:13+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Ibexa Sp. z o. o.\n \n \n \n \n \n 673\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 674\n name\n eng-GB\n ibexa_string\n Ibexa Sp. z o. o.\n \n \n 675\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 676\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 677\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 678\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 679\n contact\n eng-GB\n ibexa_object_relation\n \n 144\n /api/ibexa/v2/content/objects/144\n \n \n \n 680\n default_address\n eng-GB\n ibexa_object_relation\n \n 142\n /api/ibexa/v2/content/objects/142\n \n \n \n 681\n billing_address\n eng-GB\n ibexa_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n 683\n members\n eng-GB\n ibexa_object_relation\n \n 140\n /api/ibexa/v2/content/objects/140\n \n \n \n 682\n address_book\n eng-GB\n ibexa_object_relation\n \n 141\n /api/ibexa/v2/content/objects/141\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-04-28T16:10:13+02:00\n 2023-04-28T15:44:55+02:00\n eng-GB\n 6\n true\n false\n PUBLISHED\n \n \n HQ, Poland\n 144\n 14\n 142\n 141\n 140\n \n \n /1/65/140/\n 1\n \n \n \n Jay Kowalski\n \n
\n \n \n \n \n 2023-04-28T16:10:03+02:00\n 2023-04-28T16:10:03+02:00\n eng-GB\n true\n \n \n 676\n 1\n PUBLISHED\n 2023-04-28T16:10:03+02:00\n \n 2023-04-28T16:10:03+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Jay Kowalski\n \n \n \n \n \n 698\n first_name\n eng-GB\n ibexa_string\n Jay\n \n \n 699\n last_name\n eng-GB\n ibexa_string\n Kowalski\n \n \n 700\n phone_number\n eng-GB\n ibexa_string\n +48 123 123 456\n \n \n 701\n user\n eng-GB\n ibexa_user\n \n true\n 144\n jay.kowalski\n jay.kowalski@email.invalid\n 1682691003\n true\n 0\n \n \n \n \n \n \n /user/default_profile_image/initials.svg?initials=JK#profile_image\n \n \n image/svg+xml\n \n \n jay.kowalski\n jay.kowalski@email.invalid\n true\n \n \n \n \n Company Admin\n \n \n\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create a company member." } }, "summary": "Create a company member", "description": "Creates a company member.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new member is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The CompanyCreate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "companyId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new MemberCreateController resource", "content": { "application/vnd.ibexa.api.MemberCreate+json": { "schema": { "$ref": "#/components/schemas/MemberCreateWrapper" }, "example": { "MemberCreate": { "login": "jay.kowalski", "email": "jay.kowalski@email.invalid", "password": "Ibexa123#", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/12" }, "fields": { "field": [ { "fieldDefinitionIdentifier": "first_name", "fieldValue": "Jay" }, { "fieldDefinitionIdentifier": "last_name", "fieldValue": "Kowalski" }, { "fieldDefinitionIdentifier": "phone_number", "fieldValue": "+48 123 123 456" } ] } } } }, "application/vnd.ibexa.api.MemberCreate+xml": { "schema": { "$ref": "#/components/schemas/MemberCreate" }, "example": "\n\n jay.kowalski\n jay.kowalski@email.invalid\n Ibexa123#\n \n \n \n first_name\n Jay\n \n \n last_name\n Kowalski\n \n \n phone_number\n +48 123 123 456\n \n \n\n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/corporate/companies/{companyId}/members/{memberId}": { "get": { "operationId": "api_corporatecompanies_companyIdmembers_memberId_get", "tags": [ "Corporate Account" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Member+json": { "schema": { "$ref": "#/components/schemas/MemberWrapper" }, "example": { "Member": { "_media-type": "application/vnd.ibexa.api.Member+json", "_href": "/api/ibexa/v2/corporate/companies/139/members/144", "id": 144, "name": "Jay Kowalski", "Company": { "_media-type": "application/vnd.ibexa.api.Company+json", "id": 139, "name": "Ibexa Sp. z o. o.", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/139", "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2", "_id": 139, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/48" }, "Name": "Ibexa Sp. z o. o.", "TranslatedName": "Ibexa Sp. z o. o.", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/139/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/139/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/139/versions/6", "VersionInfo": { "id": 677, "versionNo": 6, "status": "PUBLISHED", "modificationDate": "2023-04-28T16:10:13+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-28T16:10:13+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Ibexa Sp. z o. o." } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/139" } }, "Fields": { "field": [ { "id": 673, "fieldDefinitionIdentifier": "active", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_boolean", "fieldValue": true }, { "id": 674, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Ibexa Sp. z o. o." }, { "id": 675, "fieldDefinitionIdentifier": "vat", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "123 456 789" }, { "id": 676, "fieldDefinitionIdentifier": "website", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "https://ibexa.co" }, { "id": 677, "fieldDefinitionIdentifier": "customer_group", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_customer_group", "fieldValue": { "customer_group_id": 1 } }, { "id": 678, "fieldDefinitionIdentifier": "sales_rep", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 14, "destinationContentHref": "/api/ibexa/v2/content/objects/14" } }, { "id": 679, "fieldDefinitionIdentifier": "contact", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 144, "destinationContentHref": "/api/ibexa/v2/content/objects/144" } }, { "id": 680, "fieldDefinitionIdentifier": "default_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 142, "destinationContentHref": "/api/ibexa/v2/content/objects/142" } }, { "id": 681, "fieldDefinitionIdentifier": "billing_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_address", "fieldValue": { "name": "HQ", "country": "PL", "fields": { "region": "Silesia", "locality": "Katowice", "street": "Gliwicka 6/5", "postal_code": "40-079", "email": "company@email.invalid", "phone_number": "+48 000 000 000" } } }, { "id": 683, "fieldDefinitionIdentifier": "members", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 140, "destinationContentHref": "/api/ibexa/v2/content/objects/140" } }, { "id": 682, "fieldDefinitionIdentifier": "address_book", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 141, "destinationContentHref": "/api/ibexa/v2/content/objects/141" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/139/versions/6/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/139/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-28T16:10:13+02:00", "publishedDate": "2023-04-28T15:44:55+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 6, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/139/objectstates" } }, "billingAddress": { "name": "HQ", "country": "PL", "fields": { "region": "Silesia", "locality": "Katowice", "street": "Gliwicka 6/5", "postal_code": "40-079", "email": "company@email.invalid", "phone_number": "+48 000 000 000" } }, "contactId": 144, "salesRepresentativeId": 14, "defaultAddressId": 142, "addressBookId": 141, "membersId": 140, "MemberList": { "_media-type": "application/vnd.ibexa.api.MemberList+json", "_href": "/api/ibexa/v2/corporate/companies/139/members" }, "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140" }, "locationPath": "/1/65/140/", "isActive": true }, "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/144", "_id": 144, "_remoteId": "1b3938c16adfa29996f3afff0b4a0032", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/47" }, "name": "Jay Kowalski", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/144/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140/141/145" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/144/locations" }, "Groups": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/144/groups" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "publishDate": "2023-04-28T16:10:03+02:00", "lastModificationDate": "2023-04-28T16:17:07+02:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/144/versions/6", "VersionInfo": { "id": 683, "versionNo": 6, "status": "PUBLISHED", "modificationDate": "2023-04-28T16:17:07+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-28T16:17:06+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Jay Kowalski" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/144" } }, "Fields": { "field": [ { "id": 698, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Jay" }, { "id": 699, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Kowalski" }, { "id": 700, "fieldDefinitionIdentifier": "phone_number", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "+48 123 123 456" }, { "id": 701, "fieldDefinitionIdentifier": "user", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 144, "login": "jay.kowalski", "email": "jay.kowalski@email.invalid", "passwordUpdatedAt": 1682691427, "enabled": false, "maxLogin": 5, "plainPassword": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/144/versions/6/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/user/default_profile_image/initials.svg?initials=JK#profile_image", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "login": "jay.kowalski", "email": "jay.kowalski@email.invalid", "enabled": false, "UserGroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/users/144/groups" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/144/roles" } }, "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/15", "identifier": "Company Buyer", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/15/policies" } } } } }, "application/vnd.ibexa.api.Member+xml": { "schema": { "$ref": "#/components/schemas/Member" }, "example": "\n\n 144\n Jay Kowalski\n \n 139\n Ibexa Sp. z o. o.\n \n \n Ibexa Sp. z o. o.\n Ibexa Sp. z o. o.\n \n \n \n \n 677\n 6\n PUBLISHED\n 2023-04-28T16:10:13+02:00\n \n 2023-04-28T16:10:13+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Ibexa Sp. z o. o.\n \n \n \n \n \n 673\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 674\n name\n eng-GB\n ibexa_string\n Ibexa Sp. z o. o.\n \n \n 675\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 676\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 677\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 678\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 679\n contact\n eng-GB\n ibexa_object_relation\n \n 144\n /api/ibexa/v2/content/objects/144\n \n \n \n 680\n default_address\n eng-GB\n ibexa_object_relation\n \n 142\n /api/ibexa/v2/content/objects/142\n \n \n \n 681\n billing_address\n eng-GB\n ibexa_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n 683\n members\n eng-GB\n ibexa_object_relation\n \n 140\n /api/ibexa/v2/content/objects/140\n \n \n \n 682\n address_book\n eng-GB\n ibexa_object_relation\n \n 141\n /api/ibexa/v2/content/objects/141\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-04-28T16:10:13+02:00\n 2023-04-28T15:44:55+02:00\n eng-GB\n 6\n true\n false\n PUBLISHED\n \n \n HQ, Poland\n 144\n 14\n 142\n 141\n 140\n \n \n /1/65/140/\n 1\n \n \n \n Jay Kowalski\n \n
\n \n \n \n \n 2023-04-28T16:10:03+02:00\n 2023-04-28T16:10:03+02:00\n eng-GB\n true\n \n \n 676\n 1\n PUBLISHED\n 2023-04-28T16:10:03+02:00\n \n 2023-04-28T16:10:03+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Jay Kowalski\n \n \n \n \n \n 698\n first_name\n eng-GB\n ibexa_string\n Jay\n \n \n 699\n last_name\n eng-GB\n ibexa_string\n Kowalski\n \n \n 700\n phone_number\n eng-GB\n ibexa_string\n +48 123 123 456\n \n \n 701\n user\n eng-GB\n ibexa_user\n \n true\n 144\n jay.kowalski\n jay.kowalski@email.invalid\n 1682691003\n true\n 0\n \n \n \n \n \n \n /user/default_profile_image/initials.svg?initials=JK#profile_image\n \n \n image/svg+xml\n \n \n jay.kowalski\n jay.kowalski@email.invalid\n true\n \n \n \n \n Company Admin\n \n \n\n" } } }, "401": { "description": "Error - The user is not authorized to read this company." }, "404": { "description": "Error - The company does not exist." } }, "summary": "Get company member", "description": "Returns the company member by given member ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the company member is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "companyId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "memberId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "delete": { "operationId": "api_corporatecompanies_companyIdmembers_memberId_delete", "tags": [ "Corporate Account" ], "responses": { "204": { "description": "No Content - given company member is deleted." }, "401": { "description": "Error - the user is not authorized to delete this company member." }, "404": { "description": "Error - the company member does not exist." } }, "summary": "Delete company member", "description": "The given company member is deleted.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, in the case of an error the error message is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "companyId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "memberId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "patch": { "operationId": "api_corporatecompanies_companyIdmembers_memberId_patch", "tags": [ "Corporate Account" ], "responses": { "200": { "description": "OK - company member updated.", "content": { "application/vnd.ibexa.api.Member+json": { "schema": { "$ref": "#/components/schemas/MemberWrapper" }, "example": { "Member": { "_media-type": "application/vnd.ibexa.api.Member+json", "_href": "/api/ibexa/v2/corporate/companies/139/members/144", "id": 144, "name": "Jay Kowalski", "Company": { "_media-type": "application/vnd.ibexa.api.Company+json", "id": 139, "name": "Ibexa Sp. z o. o.", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/139", "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2", "_id": 139, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/48" }, "Name": "Ibexa Sp. z o. o.", "TranslatedName": "Ibexa Sp. z o. o.", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/139/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/139/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/139/versions/6", "VersionInfo": { "id": 677, "versionNo": 6, "status": "PUBLISHED", "modificationDate": "2023-04-28T16:10:13+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-28T16:10:13+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Ibexa Sp. z o. o." } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/139" } }, "Fields": { "field": [ { "id": 673, "fieldDefinitionIdentifier": "active", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_boolean", "fieldValue": true }, { "id": 674, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Ibexa Sp. z o. o." }, { "id": 675, "fieldDefinitionIdentifier": "vat", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "123 456 789" }, { "id": 676, "fieldDefinitionIdentifier": "website", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "https://ibexa.co" }, { "id": 677, "fieldDefinitionIdentifier": "customer_group", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_customer_group", "fieldValue": { "customer_group_id": 1 } }, { "id": 678, "fieldDefinitionIdentifier": "sales_rep", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 14, "destinationContentHref": "/api/ibexa/v2/content/objects/14" } }, { "id": 679, "fieldDefinitionIdentifier": "contact", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 144, "destinationContentHref": "/api/ibexa/v2/content/objects/144" } }, { "id": 680, "fieldDefinitionIdentifier": "default_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 142, "destinationContentHref": "/api/ibexa/v2/content/objects/142" } }, { "id": 681, "fieldDefinitionIdentifier": "billing_address", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_address", "fieldValue": { "name": "HQ", "country": "PL", "fields": { "region": "Silesia", "locality": "Katowice", "street": "Gliwicka 6/5", "postal_code": "40-079", "email": "company@email.invalid", "phone_number": "+48 000 000 000" } } }, { "id": 683, "fieldDefinitionIdentifier": "members", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 140, "destinationContentHref": "/api/ibexa/v2/content/objects/140" } }, { "id": 682, "fieldDefinitionIdentifier": "address_book", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_object_relation", "fieldValue": { "destinationContentId": 141, "destinationContentHref": "/api/ibexa/v2/content/objects/141" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/139/versions/6/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/139/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-28T16:10:13+02:00", "publishedDate": "2023-04-28T15:44:55+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 6, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/139/objectstates" } }, "billingAddress": { "name": "HQ", "country": "PL", "fields": { "region": "Silesia", "locality": "Katowice", "street": "Gliwicka 6/5", "postal_code": "40-079", "email": "company@email.invalid", "phone_number": "+48 000 000 000" } }, "contactId": 144, "salesRepresentativeId": 14, "defaultAddressId": 142, "addressBookId": 141, "membersId": 140, "MemberList": { "_media-type": "application/vnd.ibexa.api.MemberList+json", "_href": "/api/ibexa/v2/corporate/companies/139/members" }, "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140" }, "locationPath": "/1/65/140/", "isActive": true }, "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/144", "_id": 144, "_remoteId": "1b3938c16adfa29996f3afff0b4a0032", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/47" }, "name": "Jay Kowalski", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/144/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/65/140/141/145" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/144/locations" }, "Groups": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/144/groups" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "publishDate": "2023-04-28T16:10:03+02:00", "lastModificationDate": "2023-04-28T16:17:07+02:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/144/versions/6", "VersionInfo": { "id": 683, "versionNo": 6, "status": "PUBLISHED", "modificationDate": "2023-04-28T16:17:07+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-28T16:17:06+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Jay Kowalski" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/144" } }, "Fields": { "field": [ { "id": 698, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Jay" }, { "id": 699, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Kowalski" }, { "id": 700, "fieldDefinitionIdentifier": "phone_number", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "+48 123 123 456" }, { "id": 701, "fieldDefinitionIdentifier": "user", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 144, "login": "jay.kowalski", "email": "jay.kowalski@email.invalid", "passwordUpdatedAt": 1682691427, "enabled": false, "maxLogin": 5, "plainPassword": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/144/versions/6/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/user/default_profile_image/initials.svg?initials=JK#profile_image", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "login": "jay.kowalski", "email": "jay.kowalski@email.invalid", "enabled": false, "UserGroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/users/144/groups" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/144/roles" } }, "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/15", "identifier": "Company Buyer", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/15/policies" } } } } }, "application/vnd.ibexa.api.Member+xml": { "schema": { "$ref": "#/components/schemas/Member" }, "example": "\n\n 144\n Jay Kowalski\n \n 139\n Ibexa Sp. z o. o.\n \n \n Ibexa Sp. z o. o.\n Ibexa Sp. z o. o.\n \n \n \n \n 677\n 6\n PUBLISHED\n 2023-04-28T16:10:13+02:00\n \n 2023-04-28T16:10:13+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Ibexa Sp. z o. o.\n \n \n \n \n \n 673\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 674\n name\n eng-GB\n ibexa_string\n Ibexa Sp. z o. o.\n \n \n 675\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 676\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 677\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 678\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 679\n contact\n eng-GB\n ibexa_object_relation\n \n 144\n /api/ibexa/v2/content/objects/144\n \n \n \n 680\n default_address\n eng-GB\n ibexa_object_relation\n \n 142\n /api/ibexa/v2/content/objects/142\n \n \n \n 681\n billing_address\n eng-GB\n ibexa_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n 683\n members\n eng-GB\n ibexa_object_relation\n \n 140\n /api/ibexa/v2/content/objects/140\n \n \n \n 682\n address_book\n eng-GB\n ibexa_object_relation\n \n 141\n /api/ibexa/v2/content/objects/141\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-04-28T16:10:13+02:00\n 2023-04-28T15:44:55+02:00\n eng-GB\n 6\n true\n false\n PUBLISHED\n \n \n HQ, Poland\n 144\n 14\n 142\n 141\n 140\n \n \n /1/65/140/\n 1\n \n \n \n Jay Kowalski\n \n
\n \n \n \n \n 2023-04-28T16:10:03+02:00\n 2023-04-28T16:10:03+02:00\n eng-GB\n true\n \n \n 676\n 1\n PUBLISHED\n 2023-04-28T16:10:03+02:00\n \n 2023-04-28T16:10:03+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Jay Kowalski\n \n \n \n \n \n 698\n first_name\n eng-GB\n ibexa_string\n Jay\n \n \n 699\n last_name\n eng-GB\n ibexa_string\n Kowalski\n \n \n 700\n phone_number\n eng-GB\n ibexa_string\n +48 123 123 456\n \n \n 701\n user\n eng-GB\n ibexa_user\n \n true\n 144\n jay.kowalski\n jay.kowalski@email.invalid\n 1682691003\n true\n 0\n \n \n \n \n \n \n /user/default_profile_image/initials.svg?initials=JK#profile_image\n \n \n image/svg+xml\n \n \n jay.kowalski\n jay.kowalski@email.invalid\n true\n \n \n \n \n Company Admin\n \n \n\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this company member." } }, "summary": "Update a company member", "description": "Updates a company member. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated company member is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The company input schema encoded in XML or JSON.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "companyId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "memberId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated MemberUpdateController resource", "content": { "application/vnd.ibexa.api.MemberUpdate+json": { "schema": { "$ref": "#/components/schemas/MemberUpdateWrapper" }, "example": { "MemberUpdate": { "login": "jay.kowalski", "email": "jay.kowalski@email.invalid", "password": "Ibexa123#", "maxLogin": 5, "enabled": false, "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/15" }, "fields": { "field": [ { "fieldDefinitionIdentifier": "first_name", "fieldValue": "Jay" }, { "fieldDefinitionIdentifier": "last_name", "fieldValue": "Kowalski" }, { "fieldDefinitionIdentifier": "phone_number", "fieldValue": "+48 123 123 456" } ] } } } }, "application/vnd.ibexa.api.MemberUpdate+xml": { "schema": { "$ref": "#/components/schemas/MemberUpdate" }, "example": "\n\n jay.kowalski@updated.email\n Publish123#\n false\n 5\n \n \n \n first_name\n Jay\n \n \n last_name\n Kowalski\n \n \n phone_number\n +48 123 123 456\n \n \n\n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/corporate/sales-representatives": { "get": { "operationId": "api_corporatesales-representatives_get", "tags": [ "Corporate Account" ], "responses": { "200": { "description": "Sales representatives list containing Company objects.", "content": { "application/vnd.ibexa.api.SalesRepresentativesList+json": { "schema": { "$ref": "#/components/schemas/SalesRepresentativesListWrapper" }, "example": { "SalesRepresentativesList": { "_media-type": "application/vnd.ibexa.api.SalesRepresentativesList+json", "users": [ { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/75", "_id": 75, "_remoteId": "f262e2fa12ae105b78a1b654e87a0874", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/4" }, "name": "John Black", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/75/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/10" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/64/76" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/75/locations" }, "Groups": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/75/groups" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "publishDate": "2023-06-20T07:33:17+00:00", "lastModificationDate": "2023-06-20T07:33:17+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/75/versions/1", "VersionInfo": { "id": 536, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2023-06-20T07:33:17+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-06-20T07:33:17+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "John Black" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/75" } }, "Fields": { "field": [ { "id": 339, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "John" }, { "id": 340, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Black" }, { "id": 341, "fieldDefinitionIdentifier": "user_account", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 75, "login": "John Black", "email": "j.black@ibexa.co", "passwordUpdatedAt": 1687246397, "enabled": true, "maxLogin": 0, "plainPassword": null } }, { "id": 342, "fieldDefinitionIdentifier": "signature", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_text", "fieldValue": null }, { "id": 343, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image", "fieldValue": null } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/75/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/user/default_profile_image/initials.svg?initials=JB#profile_image", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "login": "John Black", "email": "j.black@ibexa.co", "enabled": true, "UserGroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/users/75/groups" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/75/roles" } } ] } } }, "application/vnd.ibexa.api.SalesRepresentativesList+xml": { "schema": { "$ref": "#/components/schemas/SalesRepresentativesList" }, "example": "\n\n \n \n John Black\n \n
\n \n \n \n \n 2023-06-20T07:33:17+00:00\n 2023-06-20T07:33:17+00:00\n eng-GB\n true\n \n \n 536\n 1\n PUBLISHED\n 2023-06-20T07:33:17+00:00\n \n 2023-06-20T07:33:17+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n John Black\n \n \n \n \n \n 339\n first_name\n eng-GB\n ibexa_string\n John\n \n \n 340\n last_name\n eng-GB\n ibexa_string\n Black\n \n \n 341\n user_account\n eng-GB\n ibexa_user\n \n true\n 75\n John Black\n j.black@ibexa.co\n 1687246397\n true\n 0\n \n \n \n \n 342\n signature\n eng-GB\n ibexa_text\n \n \n \n 343\n image\n eng-GB\n ibexa_image\n \n \n \n \n \n /user/default_profile_image/initials.svg?initials=JB#profile_image\n \n \n image/svg+xml\n \n \n John Black\n j.black@ibexa.co\n true\n \n \n \n\n" } } }, "401": { "description": "Error - the user is not authorized to read Sales Representatives List.", "content": { "application/vnd.ibexa.api.ErrorMessage": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } } } }, "summary": "Read list of sales representatives", "description": "Returns paginated list of available sales representatives.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, helps to determine response format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/discounts": { "get": { "operationId": "api_discounts_get", "tags": [ "Discounts" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.DiscountList+json": { "schema": { "$ref": "#/components/schemas/DiscountList" }, "example": { "DiscountList": { "_media-type": "application/vnd.ibexa.api.DiscountList+json", "Discount": [ { "_media-type": "application/vnd.ibexa.api.Discount+json", "id": 2, "identifier": "my_discount_identifier", "name": "My Discount", "type": "cart", "label": "My Discount label", "labelDescription": "My Discount description", "priority": 1, "isEnabled": true, "createdAt": "2025-08-18T11:28:43+02:00", "updatedAt": "2025-08-18T11:28:43+02:00", "startDate": "2025-08-01T00:00:00+02:00", "endDate": "2025-08-31T23:59:59+02:00", "DiscountRule": { "_media-type": "application/vnd.ibexa.api.DiscountRule.FixedAmount+json", "type": "fixed_amount", "expressionValues": { "discount_amount": "12" } }, "DiscountConditions": [ { "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", "identifier": "is_in_currency", "expressionValues": { "currency_code": "PLN" } } ], "DiscountTranslations": [ { "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json", "languageCode": "eng-GB", "name": "My Discount", "description": "My Discount description", "label": "My Discount label", "labelDescription": "My Discount description" } ] }, { "_media-type": "application/vnd.ibexa.api.Discount+json", "id": 3, "identifier": "my_another_discount", "name": "My Another Discount", "type": "catalog", "label": "Catalog discount label", "labelDescription": "Catalog discount description", "priority": 1, "isEnabled": true, "createdAt": "2025-08-18T11:58:37+02:00", "updatedAt": "2025-08-18T11:58:37+02:00", "startDate": "2025-08-18T09:57:14+02:00", "DiscountRule": { "_media-type": "application/vnd.ibexa.api.DiscountRule.Percentage+json", "type": "percentage", "expressionValues": { "discount_percentage": "10" } }, "DiscountConditions": [ { "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", "identifier": "is_in_currency", "expressionValues": { "currency_code": "PLN" } } ], "DiscountTranslations": [ { "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json", "languageCode": "eng-GB", "name": "My Another Discount", "description": "My Another Discount Description", "label": "Catalog discount label", "labelDescription": "Catalog discount description" } ] } ] } } } } } }, "summary": "Get discounts", "description": "Returns a list of all defined discounts", "parameters": [ { "name": "offset", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false, "example": 0 }, { "name": "limit", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false, "example": 25 } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "post": { "operationId": "api_discounts_post", "tags": [ "Discounts" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Discount+json": { "schema": { "$ref": "#/components/schemas/Discount" }, "example": { "Discount": { "_media-type": "application/vnd.ibexa.api.Discount+json", "id": 2, "identifier": "my_discount_identifier", "name": "My Discount", "type": "cart", "label": "My Discount label", "labelDescription": "My Discount description", "priority": 1, "isEnabled": true, "createdAt": "2025-08-18T11:28:43+02:00", "updatedAt": "2025-08-18T11:28:43+02:00", "startDate": "2025-08-01T00:00:00+02:00", "endDate": "2025-08-31T23:59:59+02:00", "DiscountRule": { "_media-type": "application/vnd.ibexa.api.DiscountRule.FixedAmount+json", "type": "fixed_amount", "expressionValues": { "discount_amount": "12" } }, "DiscountConditions": [ { "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", "identifier": "is_in_currency", "expressionValues": { "currency_code": "PLN" } } ], "DiscountTranslations": [ { "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json", "languageCode": "eng-GB", "name": "My Discount", "description": "My Discount description", "label": "My Discount label", "labelDescription": "My Discount description" } ] } } } } }, "401": { "description": "Error - the user is not authorized to create a discount item." }, "406": { "description": "Error - the input data is not valid." } }, "summary": "Create a discount", "description": "Creates a new discount", "parameters": [ { "name": "X-Csrf-Token", "in": "header", "description": "CSRF token obtained during the authentication.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new DiscountCreateController resource", "content": { "application/vnd.ibexa.api.DiscountCreate+json": { "schema": { "$ref": "#/components/schemas/DiscountCreate" }, "example": { "DiscountCreate": { "identifier": "my_discount_identifier", "type": "cart", "priority": 1, "isEnabled": true, "userId": 14, "rule": { "type": "fixed_amount", "amount": "12" }, "conditions": [ { "class": "\\Ibexa\\Discounts\\Value\\DiscountCondition\\IsInCurrency", "parameters": [ "PLN" ] } ], "startDate": "2025-08-01 00:00:00", "endDate": "2025-08-31 23:59:59", "createdAt": "2025-07-31 12:00:00", "updatedAt": "2025-07-31 12:10:02", "translations": [ { "languageCode": "eng-GB", "name": "My Discount", "description": "My Discount description", "label": "My Discount label", "labelDescription": "My Discount description" } ], "context": { "arbitrary_foo_key": "arbitrary_foo_value", "arbitrary_bar_key": [ "arbitrary_bar_value1", "arbitrary_bar_value2" ] } } } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/discounts/{identifier}": { "get": { "operationId": "api_discounts_identifier_get", "tags": [ "Discounts" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Discount+json": { "schema": { "$ref": "#/components/schemas/Discount" }, "example": { "Discount": { "_media-type": "application/vnd.ibexa.api.Discount+json", "id": 2, "identifier": "my_discount_identifier", "name": "My Discount", "type": "cart", "label": "My Discount label", "labelDescription": "My Discount description", "priority": 1, "isEnabled": true, "createdAt": "2025-08-18T11:28:43+02:00", "updatedAt": "2025-08-18T11:28:43+02:00", "startDate": "2025-08-01T00:00:00+02:00", "endDate": "2025-08-31T23:59:59+02:00", "DiscountRule": { "_media-type": "application/vnd.ibexa.api.DiscountRule.FixedAmount+json", "type": "fixed_amount", "expressionValues": { "discount_amount": "12" } }, "DiscountConditions": [ { "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", "identifier": "is_in_currency", "expressionValues": { "currency_code": "PLN" } } ], "DiscountTranslations": [ { "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json", "languageCode": "eng-GB", "name": "My Discount", "description": "My Discount description", "label": "My Discount label", "labelDescription": "My Discount description" } ] } } } } }, "404": { "description": "Error - a discount of the given unique identifier is not found." }, "401": { "description": "Error - the user is not authorized to read this discount item." } }, "summary": "Get a discount item by its unique identifier.", "description": "Returns a discount item by its unique string identifier.", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false, "example": "my_discount_identifier" } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "delete": { "operationId": "api_discounts_identifier_delete", "tags": [ "Discounts" ], "responses": { "204": { "description": "The discount is deleted." }, "404": { "description": "Error - a discount of the given unique identifier is not found." }, "401": { "description": "Error - the user is not authorized to delete a discount item." } }, "summary": "Delete a discount item", "description": "Deletes an existing discount item by its unique identifier", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false, "example": "my_discount_identifier" }, { "name": "X-Csrf-Token", "in": "header", "description": "CSRF token obtained during the authentication.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "patch": { "operationId": "api_discounts_identifier_patch", "tags": [ "Discounts" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Discount+json": { "schema": { "$ref": "#/components/schemas/Discount" }, "example": { "Discount": { "_media-type": "application/vnd.ibexa.api.Discount+json", "id": 2, "identifier": "my_discount_identifier", "name": "My Discount", "type": "cart", "label": "My Discount label", "labelDescription": "My Discount description", "priority": 1, "isEnabled": true, "createdAt": "2025-08-18T11:28:43+02:00", "updatedAt": "2025-08-18T11:28:43+02:00", "startDate": "2025-08-01T00:00:00+02:00", "endDate": "2025-08-31T23:59:59+02:00", "DiscountRule": { "_media-type": "application/vnd.ibexa.api.DiscountRule.FixedAmount+json", "type": "fixed_amount", "expressionValues": { "discount_amount": "12" } }, "DiscountConditions": [ { "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", "identifier": "is_in_currency", "expressionValues": { "currency_code": "PLN" } } ], "DiscountTranslations": [ { "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json", "languageCode": "eng-GB", "name": "My Discount", "description": "My Discount description", "label": "My Discount label", "labelDescription": "My Discount description" } ] } } } } }, "404": { "description": "Error - a discount of the given unique identifier is not found." }, "401": { "description": "Error - the user is not authorized to update a discount item." }, "406": { "description": "Error - the input data is not valid." } }, "summary": "Update a discount", "description": "Updates a new discount", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false, "example": "my_discount_identifier" }, { "name": "X-Csrf-Token", "in": "header", "description": "CSRF token obtained during the authentication.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated DiscountUpdateController resource", "content": { "application/vnd.ibexa.api.DiscountUpdate+json": { "schema": { "$ref": "#/components/schemas/DiscountUpdate" }, "example": { "DiscountUpdate": { "identifier": "my_discount_identifier", "priority": 1, "isEnabled": true, "userId": 14, "lastContributorId": 14, "rule": { "type": "fixed_amount", "amount": "20" }, "conditions": [ { "class": "\\Ibexa\\Discounts\\Value\\DiscountCondition\\IsInCurrency", "parameters": [ "PLN" ] } ], "startDate": "2025-08-01 00:00:00", "endDate": "2025-08-31 23:59:59", "createdAt": "2025-07-31 12:00:00", "updatedAt": "2025-07-31 12:10:02", "translations": [ { "languageCode": "eng-GB", "name": "My Discount", "description": "My Discount description", "label": "My Discount label", "labelDescription": "My Discount description" } ], "context": { "arbitrary_foo_key": "arbitrary_foo_value", "arbitrary_bar_key": [ "arbitrary_bar_value1", "arbitrary_bar_value2" ] } } } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/discounts/{identifier}/disable": { "post": { "operationId": "api_discounts_identifierdisable_post", "tags": [ "Discounts" ], "responses": { "204": { "description": "The discount is disabled." }, "404": { "description": "Error - a discount of the given unique identifier is not found." }, "401": { "description": "Error - the user is not authorized to disable a discount item." } }, "summary": "Disables a discount", "description": "Disables a discount item by its unique identifier", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false, "example": "my_discount_identifier" }, { "name": "X-Csrf-Token", "in": "header", "description": "CSRF token obtained during the authentication.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new DiscountDisableController resource", "content": [], "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/discounts/{identifier}/enable": { "post": { "operationId": "api_discounts_identifierenable_post", "tags": [ "Discounts" ], "responses": { "204": { "description": "The discount is enabled." }, "404": { "description": "Error - a discount of the given unique identifier is not found." }, "401": { "description": "Error - the user is not authorized to enable a discount item." } }, "summary": "Enables a discount", "description": "Enables a discount item by its unique identifier", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false, "example": "my_discount_identifier" }, { "name": "X-Csrf-Token", "in": "header", "description": "CSRF token obtained during the authentication.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new DiscountEnableController resource", "content": [], "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/discounts/{id}": { "get": { "operationId": "api_discounts_id_get", "tags": [ "Discounts" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Discount+json": { "schema": { "$ref": "#/components/schemas/Discount" }, "example": { "Discount": { "_media-type": "application/vnd.ibexa.api.Discount+json", "id": 2, "identifier": "my_discount_identifier", "name": "My Discount", "type": "cart", "label": "My Discount label", "labelDescription": "My Discount description", "priority": 1, "isEnabled": true, "createdAt": "2025-08-18T11:28:43+02:00", "updatedAt": "2025-08-18T11:28:43+02:00", "startDate": "2025-08-01T00:00:00+02:00", "endDate": "2025-08-31T23:59:59+02:00", "DiscountRule": { "_media-type": "application/vnd.ibexa.api.DiscountRule.FixedAmount+json", "type": "fixed_amount", "expressionValues": { "discount_amount": "12" } }, "DiscountConditions": [ { "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", "identifier": "is_in_currency", "expressionValues": { "currency_code": "PLN" } } ], "DiscountTranslations": [ { "_media-type": "application/vnd.ibexa.api.DiscountTranslation+json", "languageCode": "eng-GB", "name": "My Discount", "description": "My Discount description", "label": "My Discount label", "labelDescription": "My Discount description" } ] } } } } }, "404": { "description": "Error - a discount of the given ID is not found." }, "401": { "description": "Error - the user is not authorized to read this discount item." } }, "summary": "Get a discount item", "description": "Returns a discount item by its ID.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "simple", "explode": false, "allowReserved": false, "example": 1 } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/discounts_codes/{cartIdentifier}/apply": { "post": { "operationId": "ibexa.rest.discounts_codes.apply", "tags": [ "Discounts" ], "responses": { "200": { "description": "OK - The discount code has been applied and is returned.", "content": { "application/vnd.ibexa.api.DiscountCode+json": { "schema": { "$ref": "#/components/schemas/DiscountCodeWrapper" }, "example": { "DiscountCode": { "_media-type": "application/vnd.ibexa.api.DiscountCode+json", "id": 1, "code": "summer10", "created_at": { "date": "2025-06-10 14:14:06.000000", "timezone_type": 3, "timezone": "UTC" } } } } } }, "404": { "description": "Not Found - the cart does not exist, or, the requested discount code has not been found or is already applied." }, "429": { "description": "Too Many Requests - rate limit exceeded, next requests are temporarily blocked as a security measure." } }, "summary": "Apply discount code", "description": "Apply a discount code on a cart given by its identifier.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "cartIdentifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The discount code to apply", "content": { "application/vnd.ibexa.api.DiscountCode+json": { "schema": { "$ref": "#/components/schemas/DiscountCodeWrapper" }, "example": { "DiscountCode": { "code": "summer10" } } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/discounts_codes/{cartIdentifier}/drop": { "post": { "operationId": "ibexa.rest.discounts_codes.drop", "tags": [ "Discounts" ], "responses": { "204": { "description": "No Content - the discount code has been dropped." }, "404": { "description": "Not Found - the cart does not exist." } }, "summary": "Drop discount code", "description": "Unapply a discount code from a cart given by its identifier.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "cartIdentifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The discount code to drop", "content": { "application/vnd.ibexa.api.DiscountCode+json": { "schema": { "$ref": "#/components/schemas/DiscountCodeWrapper" }, "example": { "DiscountCode": { "code": "summer10" } } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/languages": { "get": { "operationId": "api_languages_get", "tags": [ "Language" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.LanguageList+json": { "schema": { "$ref": "#/components/schemas/LanguageListWrapper" }, "example": { "LanguageList": { "_media-type": "application/vnd.ibexa.api.LanguageList+json", "_href": "/api/ibexa/v2/languages", "Language": [ { "_media-type": "application/vnd.ibexa.api.Language+json", "_href": "/api/ibexa/v2/languages/eng-GB", "languageId": 2, "languageCode": "eng-GB", "name": "English (United Kingdom)" }, { "_href": "/api/ibexa/v2/languages/pol-PL", "_media-type": "application/vnd.ibexa.api.Language+json", "languageCode": "pol-PL", "languageId": 4, "name": "Polish (polski)" } ] } } }, "application/vnd.ibexa.api.LanguageList+xml": { "schema": { "$ref": "#/components/schemas/LanguageList" }, "example": "\n\n \n 2\n eng-GB\n English (United Kingdom)\n \n \n 4\n pol-PL\n Polish (polski)\n \n\n" } } } }, "summary": "Language list", "description": "Lists languages", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/languages/{code}": { "get": { "operationId": "api_languages_code_get", "tags": [ "Language" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Language+json": { "schema": { "$ref": "#/components/schemas/LanguageWrapper" }, "example": { "Language": { "_media-type": "application/vnd.ibexa.api.Language+json", "_href": "/api/ibexa/v2/languages/eng-GB", "languageId": 2, "languageCode": "eng-GB", "name": "English (United Kingdom)" } } }, "application/vnd.ibexa.api.Language+xml": { "schema": { "$ref": "#/components/schemas/Language" }, "example": "\n\n 2\n eng-GB\n English (United Kingdom)\n\n" } } } }, "summary": "Get language", "description": "Retrieves a LanguageLoadByIdController resource.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the language is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/locations": { "get": { "operationId": "api_contentlocations_get", "tags": [ "Location" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.LocationList+json": { "schema": { "$ref": "#/components/schemas/LocationWrapper" }, "example": { "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114", "id": 114, "priority": 0, "hidden": false, "invisible": false, "explicitlyHidden": false, "ParentLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/59" }, "pathString": "/1/2/59/114/", "depth": 3, "childCount": 0, "remoteId": "47a1e4ee082fb64e93a822dcfe3a5614", "Children": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114/children" }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/59" }, "sortField": "PATH", "sortOrder": "ASC", "UrlAliases": { "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114/urlaliases" }, "ContentInfo": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59", "_remoteId": "0fe1b1543f886b0becd4d9b2c7c517d0", "_id": 59, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2" }, "Name": "Art1", "TranslatedName": "Art1", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/59/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/59/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/59/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2021-06-28T11:33:01+00:00", "publishedDate": "2021-06-28T11:33:01+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": false, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/59/objectstates" } } } } } }, "application/vnd.ibexa.api.LocationList+xml": { "schema": { "$ref": "#/components/schemas/Location" }, "example": "\n\n 96\n 0\n false\n true\n false\n \n /1/2/42/96/\n 3\n 0\n 58133c8c75230e5debe362a28b92d27a\n \n \n PATH\n ASC\n \n \n \n \n Art3\n Art3\n \n \n
\n \n \n 2021-06-28T11:34:17+00:00\n 2021-06-28T11:34:17+00:00\n eng-GB\n 1\n false\n false\n PUBLISHED\n \n \n \n\n" } } }, "307": { "description": "Temporary redirect to the main resource URL." }, "404": { "description": "Error - the Location with the given ID (remote ID or URL Alias) does not exist." } }, "summary": "Load Locations by id/remoteId/urlAlias", "description": "Loads the Location for a given ID (x), remote ID or URL alias.", "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/locations/{path}": { "get": { "operationId": "api_contentlocations_path_get", "tags": [ "Location" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Location+json": { "schema": { "$ref": "#/components/schemas/LocationWrapper" }, "example": { "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114", "id": 114, "priority": 0, "hidden": false, "invisible": false, "explicitlyHidden": false, "ParentLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/59" }, "pathString": "/1/2/59/114/", "depth": 3, "childCount": 0, "remoteId": "47a1e4ee082fb64e93a822dcfe3a5614", "Children": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114/children" }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/59" }, "sortField": "PATH", "sortOrder": "ASC", "UrlAliases": { "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114/urlaliases" }, "ContentInfo": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59", "_remoteId": "0fe1b1543f886b0becd4d9b2c7c517d0", "_id": 59, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2" }, "Name": "Art1", "TranslatedName": "Art1", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/59/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/59/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/59/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2021-06-28T11:33:01+00:00", "publishedDate": "2021-06-28T11:33:01+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": false, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/59/objectstates" } } } } } }, "application/vnd.ibexa.api.Location+xml": { "schema": { "$ref": "#/components/schemas/Location" }, "example": "\n\n 96\n 0\n false\n true\n false\n \n /1/2/42/96/\n 3\n 0\n 58133c8c75230e5debe362a28b92d27a\n \n \n PATH\n ASC\n \n \n \n \n Art3\n Art3\n \n \n
\n \n \n 2021-06-28T11:34:17+00:00\n 2021-06-28T11:34:17+00:00\n eng-GB\n 1\n false\n false\n PUBLISHED\n \n \n \n\n" } } }, "401": { "description": "Error - the user is not authorized to read this Location." }, "404": { "description": "Error - the Location with the given path does not exist." } }, "summary": "Load Location", "description": "Loads the Location for the given path e.g. '/content/locations/1/2/61'.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new Location is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contentlocations_path_delete", "tags": [ "Location" ], "responses": { "204": { "description": "No Content - deleted." }, "401": { "description": "Error - the user is not authorized to delete this subtree." }, "404": { "description": "Error - the Location with the given ID does not exist." } }, "summary": "Delete subtree", "description": "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.", "parameters": [ { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_contentlocations_path_patch", "tags": [ "Location" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Location+json": { "schema": { "$ref": "#/components/schemas/LocationWrapper" }, "example": { "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114", "id": 114, "priority": 0, "hidden": false, "invisible": false, "explicitlyHidden": false, "ParentLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/59" }, "pathString": "/1/2/59/114/", "depth": 3, "childCount": 0, "remoteId": "47a1e4ee082fb64e93a822dcfe3a5614", "Children": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114/children" }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/59" }, "sortField": "PATH", "sortOrder": "ASC", "UrlAliases": { "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114/urlaliases" }, "ContentInfo": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59", "_remoteId": "0fe1b1543f886b0becd4d9b2c7c517d0", "_id": 59, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2" }, "Name": "Art1", "TranslatedName": "Art1", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/59/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/59/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/59/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2021-06-28T11:33:01+00:00", "publishedDate": "2021-06-28T11:33:01+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": false, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/59/objectstates" } } } } } }, "application/vnd.ibexa.api.Location+xml": { "schema": { "$ref": "#/components/schemas/Location" }, "example": "\n\n 96\n 0\n false\n true\n false\n \n /1/2/42/96/\n 3\n 0\n 58133c8c75230e5debe362a28b92d27a\n \n \n PATH\n ASC\n \n \n \n \n Art3\n Art3\n \n \n
\n \n \n 2021-06-28T11:34:17+00:00\n 2021-06-28T11:34:17+00:00\n eng-GB\n 1\n false\n false\n PUBLISHED\n \n \n \n\n" } } }, "401": { "description": "Error - the user is not authorized to update this Location." }, "404": { "description": "Error - the Location with the given ID does not exist." } }, "summary": "Update Location", "description": "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.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Location is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The LocationUpdate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated LocationUpdateController resource", "content": { "application/vnd.ibexa.api.LocationUpdate+json": { "schema": { "$ref": "#/components/schemas/LocationUpdateStructWrapper" }, "example": { "LocationUpdate": { "priority": "3", "hidden": true, "remoteId": "remoteId-qwert999", "sortField": "NAME", "sortOrder": "DESC" } } }, "application/vnd.ibexa.api.LocationUpdate+xml": { "schema": { "$ref": "#/components/schemas/LocationUpdateStruct" }, "example": "\n\n 3\n true\n remoteId-qwert999\n CLASS\n DESC\n\n" } }, "required": false }, "deprecated": false } }, "/content/locations/{path}/children": { "get": { "operationId": "api_contentlocations_pathchildren_get", "tags": [ "Location" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.LocationList+json": { "schema": { "$ref": "#/components/schemas/LocationListWrapper" } }, "application/vnd.ibexa.api.LocationList+xml": { "schema": { "$ref": "#/components/schemas/LocationList" }, "example": "\n\n \n\n" } } }, "401": { "description": "Error - the user is not authorized to read this content item." }, "404": { "description": "Error - the content item with the given ID does not exist." } }, "summary": "Get child Locations.", "description": "Loads all child Locations for the given parent Location.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new Location list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/locations/{path}/urlaliases": { "get": { "operationId": "api_contentlocations_pathurlaliases_get", "tags": [ "Location" ], "responses": { "200": { "description": "OK - returns the list of URL aliases.", "content": { "application/vnd.ibexa.api.UrlAliasRefList+json": { "schema": { "$ref": "#/components/schemas/UrlAliasRefListWrapper" } }, "application/vnd.ibexa.api.UrlAliasRefList+xml": { "schema": { "$ref": "#/components/schemas/UrlAliasRefList" }, "example": "\n\n \n\n" } } }, "400": { "description": "Error - The user has no permission to read URL aliases." }, "401": { "description": "Error - The Location was not found." } }, "summary": "List URL aliases for Location", "description": "Returns the list of URL aliases for a Location.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the URL alias list contains only references and is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/objectstategroups": { "get": { "operationId": "api_contentobjectstategroups_get", "tags": [ "Object State Groups" ], "responses": { "200": { "description": "OK - returns a list of Object state groups.", "content": { "application/vnd.ibexa.api.ObjectStateGroupList+json": { "schema": { "$ref": "#/components/schemas/ObjectStateGroupListWrapper" }, "example": { "ObjectStateGroupList": { "_media-type": "application/vnd.ibexa.api.ObjectStateGroupList+json", "_href": "/api/ibexa/v2/content/objectstategroups", "ObjectStateGroup": [ { "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", "_href": "/api/ibexa/v2/content/objectstategroups/2", "id": 2, "identifier": "ibexa_lock", "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates" }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Lock" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] } }, { "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", "_href": "/api/ibexa/v2/content/objectstategroups/3", "id": 3, "identifier": "accessibility", "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", "_href": "/api/ibexa/v2/content/objectstategroups/3/objectstates" }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Accessibility" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] } }, { "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", "_href": "/api/ibexa/v2/content/objectstategroups/6", "id": 6, "identifier": "custom-states", "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", "_href": "/api/ibexa/v2/content/objectstategroups/6/objectstates" }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Custom State" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Custom Object state" } ] } } ] } } }, "application/vnd.ibexa.api.ObjectStateGroupList+xml": { "schema": { "$ref": "#/components/schemas/ObjectStateGroupList" }, "example": "\n\n \n 2\n ibexa_lock\n eng-GB\n eng-GB\n \n \n Lock\n \n \n \n \n \n \n 3\n accessibility\n eng-GB\n eng-GB\n \n \n Accessibility\n \n \n \n \n \n \n 6\n custom-states\n eng-GB\n eng-GB\n \n \n Custom State\n \n \n Custom Object state\n \n \n\n" } } }, "401": { "description": "Error - The user has no permission to read Object state groups." } }, "summary": "List Object state groups", "description": "Returns a list of all Object state groups.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Object state group list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contentobjectstategroups_post", "tags": [ "Object State Groups" ], "responses": { "201": { "description": "Object state group created.", "content": { "application/vnd.ibexa.api.ObjectStateGroup+json": { "schema": { "$ref": "#/components/schemas/ObjectStateGroupWrapper" }, "example": { "ObjectStateGroup": { "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", "_href": "/api/ibexa/v2/content/objectstategroups/7", "id": 7, "identifier": "custom-states", "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates" }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "New Custom State name" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Custom Object state" } ] } } } }, "application/vnd.ibexa.api.ObjectStateGroup+xml": { "schema": { "$ref": "#/components/schemas/ObjectStateGroup" }, "example": "\n\n 7\n custom-states\n eng-GB\n eng-GB\n \n \n New Custom State name\n \n \n Custom Object state\n \n\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to create an Object state group." }, "403": { "description": "Error - An Object state group with the same identifier already exists." } }, "summary": "Create Object state group", "description": "Creates a new Object state group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new Object state group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Object state group input schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ObjectStateGroupCreateController resource", "content": { "application/vnd.ibexa.api.ObjectStateGroupCreate+json": { "schema": { "$ref": "#/components/schemas/ObjectStateGroupCreateWrapper" }, "example": { "ObjectStateGroupCreate": { "identifier": "custom-states", "defaultLanguageCode": "eng-GB", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Custom State" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Custom Object state" } ] } } } }, "application/vnd.ibexa.api.ObjectStateGroupCreate+xml": { "schema": { "$ref": "#/components/schemas/ObjectStateGroupCreate" }, "example": "\n\n custom\n eng-GB\n \n Custom State\n \n \n Custom Object state\n \n" } }, "required": false }, "deprecated": false } }, "/content/objectstategroups/{objectStateGroupId}": { "get": { "operationId": "api_contentobjectstategroups_objectStateGroupId_get", "tags": [ "Object State Groups" ], "responses": { "200": { "description": "OK - returns the Object state group.", "content": { "application/vnd.ibexa.api.ObjectStateGroup+json": { "schema": { "$ref": "#/components/schemas/ObjectStateGroupWrapper" }, "example": { "ObjectStateGroup": { "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", "_href": "/api/ibexa/v2/content/objectstategroups/7", "id": 7, "identifier": "custom-states", "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates" }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "New Custom State name" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Custom Object state" } ] } } } }, "application/vnd.ibexa.api.ObjectStateGroup+xml": { "schema": { "$ref": "#/components/schemas/ObjectStateGroup" }, "example": "\n\n 7\n custom-states\n eng-GB\n eng-GB\n \n \n New Custom State name\n \n \n Custom Object state\n \n\n" } } }, "401": { "description": "Error - The user is not authorized to read this Object state group." }, "404": { "description": "Error - The Object state group does not exist." } }, "summary": "Get Object state group", "description": "Returns the Object state group with the provided ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Object state group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "objectStateGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contentobjectstategroups_objectStateGroupId_delete", "tags": [ "Object State Groups" ], "responses": { "204": { "description": "No Content - Object state group deleted." }, "401": { "description": "Error - The user is not authorized to delete an Object state group." }, "404": { "description": "Error - The Object state group does not exist." } }, "summary": "Delete Object state group", "description": "Deletes the given Object state group including Object states.", "parameters": [ { "name": "objectStateGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_contentobjectstategroups_objectStateGroupId_patch", "tags": [ "Object State Groups" ], "responses": { "200": { "description": "OK - Object stated group updated.", "content": { "application/vnd.ibexa.api.ObjectStateGroup+json": { "schema": { "$ref": "#/components/schemas/ObjectStateGroupWrapper" }, "example": { "ObjectStateGroup": { "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", "_href": "/api/ibexa/v2/content/objectstategroups/7", "id": 7, "identifier": "custom-states", "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates" }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "New Custom State name" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Custom Object state" } ] } } } }, "application/vnd.ibexa.api.ObjectStateGroup+xml": { "schema": { "$ref": "#/components/schemas/ObjectStateGroup" }, "example": "\n\n 7\n custom-states\n eng-GB\n eng-GB\n \n \n New Custom State name\n \n \n Custom Object state\n \n\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to update an Object state group." }, "403": { "description": "Error - An Object state group with the provided identifier already exists." }, "412": { "description": "Error - The current ETag does not match the one provided in the If-Match header." } }, "summary": "Update Object state group", "description": "Updates an Object state group. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Object state group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Object state group input schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "objectStateGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ObjectStateGroupUpdateController resource", "content": { "application/vnd.ibexa.api.ObjectStateGroupUpdate+json": { "schema": { "$ref": "#/components/schemas/ObjectStateGroupUpdateWrapper" }, "example": { "ObjectStateGroupUpdate": { "names": { "value": [ { "_languageCode": "eng-GB", "#text": "New Custom State name" } ] } } } }, "application/vnd.ibexa.api.ObjectStateGroupUpdate+xml": { "schema": { "$ref": "#/components/schemas/ObjectStateGroupUpdate" }, "example": "\n\n \n New Custom State name\n \n\n" } }, "required": false }, "deprecated": false } }, "/content/objectstategroups/{objectStateGroupId}/objectstates": { "get": { "operationId": "api_contentobjectstategroups_objectStateGroupIdobjectstates_get", "tags": [ "Object State Groups" ], "responses": { "200": { "description": "OK - returns a list of Object states.", "content": { "application/vnd.ibexa.api.ObjectStateList+json": { "schema": { "$ref": "#/components/schemas/ObjectStateListWrapper" }, "example": { "ObjectStateList": { "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates", "ObjectState": [ { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/1", "id": 1, "identifier": "not_locked", "priority": 0, "ObjectStateGroup": { "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", "_href": "/api/ibexa/v2/content/objectstategroups/2" }, "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Not locked" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] } }, { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/2", "id": 2, "identifier": "locked", "priority": 1, "ObjectStateGroup": { "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", "_href": "/api/ibexa/v2/content/objectstategroups/2" }, "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Locked" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] } } ] } } }, "application/vnd.ibexa.api.ObjectStateList+xml": { "schema": { "$ref": "#/components/schemas/ObjectStateList" }, "example": "\n\n \n 1\n not_locked\n 0\n \n eng-GB\n eng-GB\n \n Not locked\n \n \n \n \n \n \n 2\n locked\n 1\n \n eng-GB\n eng-GB\n \n Locked\n \n \n \n \n \n\n" } } }, "401": { "description": "Error - The user has no permission to read Object states." } }, "summary": "List Object states", "description": "Returns a list of all Object states of the given group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Object state list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "objectStateGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contentobjectstategroups_objectStateGroupIdobjectstates_post", "tags": [ "Object State Groups" ], "responses": { "201": { "description": "Object state created.", "content": { "application/vnd.ibexa.api.ObjectState+json": { "schema": { "$ref": "#/components/schemas/ObjectStateWrapper" }, "example": { "ObjectState": { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/6/objectstates/9", "id": 9, "identifier": "closed", "priority": 1, "ObjectStateGroup": { "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", "_href": "/api/ibexa/v2/content/objectstategroups/6" }, "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "New Object State name" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] } } } }, "application/vnd.ibexa.api.ObjectState+xml": { "schema": { "$ref": "#/components/schemas/ObjectState" }, "example": "\n\n 2\n locked\n 1\n \n eng-GB\n eng-GB\n \n New Object State name\n \n \n \n \n\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to create an Object state." }, "403": { "description": "Error - An Object state with the same identifier already exists in the given group." } }, "summary": "Create Object state", "description": "Creates a new Object state.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new Object state is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Object state input schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "objectStateGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ObjectStateCreateController resource", "content": { "application/vnd.ibexa.api.ObjectStateCreate+json": { "schema": { "$ref": "#/components/schemas/ObjectStateCreateWrapper" }, "example": { "ObjectStateCreate": { "identifier": "new-state", "priority": "1", "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "New State" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "New Object State" } ] } } } }, "application/vnd.ibexa.api.ObjectStateCreate+xml": { "schema": { "$ref": "#/components/schemas/ObjectStateCreate" }, "example": "\n\n new-state\n 1\n eng-GB\n \n New State\n \n \n New Object State\n \n\n" } }, "required": false }, "deprecated": false } }, "/content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}": { "get": { "operationId": "api_contentobjectstategroups_objectStateGroupIdobjectstates_objectStateId_get", "tags": [ "Object State Groups" ], "responses": { "200": { "description": "OK - returns the Object state.", "content": { "application/vnd.ibexa.api.ObjectState+json": { "schema": { "$ref": "#/components/schemas/ObjectStateWrapper" }, "example": { "ObjectState": { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/6/objectstates/9", "id": 9, "identifier": "closed", "priority": 1, "ObjectStateGroup": { "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", "_href": "/api/ibexa/v2/content/objectstategroups/6" }, "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "New Object State name" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] } } } }, "application/vnd.ibexa.api.ObjectState+xml": { "schema": { "$ref": "#/components/schemas/ObjectState" }, "example": "\n\n 2\n locked\n 1\n \n eng-GB\n eng-GB\n \n New Object State name\n \n \n \n \n\n" } } }, "401": { "description": "Error - The user is not authorized to read this Object state." }, "404": { "description": "Error - The Object state does not exist." } }, "summary": "Get Object state", "description": "Returns the Object state.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Object State is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "objectStateGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "objectStateId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contentobjectstategroups_objectStateGroupIdobjectstates_objectStateId_delete", "tags": [ "Object State Groups" ], "responses": { "204": { "description": "No Content - Object state deleted." }, "401": { "description": "Error - The user is not authorized to delete an Object state." }, "404": { "description": "Error - The Object state does not exist." } }, "summary": "Delete Object state", "description": "Deletes provided Object state.", "parameters": [ { "name": "objectStateGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "objectStateId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_contentobjectstategroups_objectStateGroupIdobjectstates_objectStateId_patch", "tags": [ "Object State Groups" ], "responses": { "200": { "description": "OK - Object State updated", "content": { "application/vnd.ibexa.api.ObjectState+json": { "schema": { "$ref": "#/components/schemas/ObjectStateWrapper" }, "example": { "ObjectState": { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/6/objectstates/9", "id": 9, "identifier": "closed", "priority": 1, "ObjectStateGroup": { "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", "_href": "/api/ibexa/v2/content/objectstategroups/6" }, "defaultLanguageCode": "eng-GB", "languageCodes": "eng-GB", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "New Object State name" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] } } } }, "application/vnd.ibexa.api.ObjectState+xml": { "schema": { "$ref": "#/components/schemas/ObjectState" }, "example": "\n\n 2\n locked\n 1\n \n eng-GB\n eng-GB\n \n New Object State name\n \n \n \n \n\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to update the Object state." }, "403": { "description": "Error - An Object state with the provided identifier already exists in this group." }, "412": { "description": "Error - The current ETag does not match the one provided in the If-Match header." } }, "summary": "Update Object state", "description": "Updates an Object state. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Object state is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Object state input schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "objectStateGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "objectStateId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ObjectStateUpdateController resource", "content": { "application/vnd.ibexa.api.ObjectStateUpdate+json": { "schema": { "$ref": "#/components/schemas/ObjectStateUpdateWrapper" }, "example": { "ObjectStateUpdate": { "names": { "value": [ { "_languageCode": "eng-GB", "#text": "New Object State name" } ] } } } }, "application/vnd.ibexa.api.ObjectStateUpdate+xml": { "schema": { "$ref": "#/components/schemas/ObjectStateUpdate" }, "example": "\n\n 3\n eng-GB\n \n New Object State name\n \n\n" } }, "required": false }, "deprecated": false } }, "/content/objects": { "get": { "operationId": "api_contentobjects_get", "tags": [ "Objects" ], "responses": { "307": { "description": "Temporary redirect to `GET /content/objects/{contentId}` equivalent.", "headers": { "Location": { "description": "Contains the prefixed `/content/objects/{contentId}` absolute path of the content item.", "schema": { "type": "string" } } } }, "400": { "description": "Error - the required `remoteId` query parameter is missing." }, "404": { "description": "Error - the content with the given remote ID does not exist." } }, "summary": "Load content by remote ID", "description": "Loads content item for a given remote ID.", "parameters": [ { "name": "remoteId", "in": "query", "description": "Remote ID of the content item.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contentobjects_post", "tags": [ "Objects" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Content+json": { "schema": { "$ref": "#/components/schemas/ContentWrapper" }, "example": { "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/54", "_remoteId": "9e863fbb0fb835ce050032b4f00de61d", "_id": 54, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1" }, "Name": "Forms", "TranslatedName": "Forms", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/54/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/54/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/54/versions/1", "VersionInfo": { "id": 514, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2018-09-17T06:48:13+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2018-09-17T06:48:13+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Forms" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/54" } }, "Fields": { "field": [ { "id": 249, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Forms" }, { "id": 250, "fieldDefinitionIdentifier": "short_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": null }, { "id": 251, "fieldDefinitionIdentifier": "short_description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 252, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/54/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#folder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/6" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/55" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/54/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2018-09-17T06:48:13+00:00", "publishedDate": "2018-09-17T06:48:13+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": false, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/54/objectstates" } } } }, "application/vnd.ibexa.api.Content+xml": { "schema": { "$ref": "#/components/schemas/Content" }, "example": "\n\n \n Forms\n Forms\n \n \n \n \n 514\n 1\n PUBLISHED\n 2018-09-17T06:48:13+00:00\n \n 2018-09-17T06:48:13+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Forms\n \n \n \n \n \n 249\n name\n eng-GB\n ibexa_string\n Forms\n \n \n 250\n short_name\n eng-GB\n ibexa_string\n \n \n \n 251\n short_description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n 252\n description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n \n \n /bundles/ezplatformadminui/img/ez-icons.svg#folder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2018-09-17T06:48:13+00:00\n 2018-09-17T06:48:13+00:00\n eng-GB\n 1\n false\n false\n PUBLISHED\n \n\n" }, "application/vnd.ibexa.api.ContentInfo+xml": { "schema": { "$ref": "#/components/schemas/ContentInfoWrapper" }, "example": "\n\n \n article1\n \n \n
\n \n \n \n 2019-02-19T15:00:34+01:00\n 2019-02-19T15:00:34+01:00\n eng-GB\n 1\n false\n \n\n" } } }, "400": { "description": "Error - the input does not match the input schema definition or the validation on a field fails." }, "401": { "description": "Error - the user is not authorized to create this Object in this Location." }, "404": { "description": "Error - the parent Location specified in the request body does not exist." } }, "summary": "Create content item", "description": "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.", "parameters": [ { "name": "Accept", "in": "header", "description": "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.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The ContentCreate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentCreateController resource", "content": { "application/vnd.ibexa.api.ContentCreate+json": { "schema": { "$ref": "#/components/schemas/ContentCreateWrapper" }, "example": { "ContentCreate": { "ContentType": { "_href": "/api/ibexa/v2/content/types/2" }, "mainLanguageCode": "eng-GB", "LocationCreate": { "_media-type": "application/vnd.ibexa.api.LocationCreate", "ParentLocation": { "_href": "/api/ibexa/v2/content/locations/1/2" }, "priority": "0", "hidden": "false", "sortField": "PATH", "sortOrder": "ASC" }, "Section": { "_href": "/api/ibexa/v2/content/sections/1" }, "alwaysAvailable": "true", "fields": { "field": [ { "fieldDefinitionIdentifier": "title", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "draft article" }, { "fieldDefinitionIdentifier": "intro", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "

draft draft

" } }, { "fieldDefinitionIdentifier": "body", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "

draft draft draft

" } } ] } } } }, "application/vnd.ibexa.api.ContentCreate+xml": { "schema": { "$ref": "#/components/schemas/ContentCreate" }, "example": "\n\n \n eng-GB\n \n \n 0\n false\n PATH\n ASC\n \n
\n true\n \n \n \n title\n eng-GB\n draft article\n \n \n intro\n eng-GB\n \n

draft draft

]]>\n \n \n \n body\n eng-GB\n \n

draft draft draft

]]>\n \n \n \n\n" } }, "required": false }, "deprecated": false } }, "/content/objects/{contentId}": { "get": { "operationId": "api_contentobjects_contentId_get", "tags": [ "Objects" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Content+json": { "schema": { "$ref": "#/components/schemas/ContentWrapper" }, "example": { "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/54", "_remoteId": "9e863fbb0fb835ce050032b4f00de61d", "_id": 54, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1" }, "Name": "Forms", "TranslatedName": "Forms", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/54/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/54/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/54/versions/1", "VersionInfo": { "id": 514, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2018-09-17T06:48:13+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2018-09-17T06:48:13+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Forms" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/54" } }, "Fields": { "field": [ { "id": 249, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Forms" }, { "id": 250, "fieldDefinitionIdentifier": "short_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": null }, { "id": 251, "fieldDefinitionIdentifier": "short_description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 252, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/54/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#folder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/6" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/55" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/54/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2018-09-17T06:48:13+00:00", "publishedDate": "2018-09-17T06:48:13+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": false, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/54/objectstates" } } } }, "application/vnd.ibexa.api.Content+xml": { "schema": { "$ref": "#/components/schemas/Content" }, "example": "\n\n \n Forms\n Forms\n \n \n \n \n 514\n 1\n PUBLISHED\n 2018-09-17T06:48:13+00:00\n \n 2018-09-17T06:48:13+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Forms\n \n \n \n \n \n 249\n name\n eng-GB\n ibexa_string\n Forms\n \n \n 250\n short_name\n eng-GB\n ibexa_string\n \n \n \n 251\n short_description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n 252\n description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n \n \n /bundles/ezplatformadminui/img/ez-icons.svg#folder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2018-09-17T06:48:13+00:00\n 2018-09-17T06:48:13+00:00\n eng-GB\n 1\n false\n false\n PUBLISHED\n \n\n" }, "application/vnd.ibexa.api.ContentInfo+json": { "schema": { "$ref": "#/components/schemas/ContentInfoWrapper" }, "example": "\n\n \n article1\n \n \n
\n \n \n \n 2019-02-19T15:00:34+01:00\n 2019-02-19T15:00:34+01:00\n eng-GB\n 1\n false\n \n\n" }, "application/vnd.ibexa.api.ContentInfo+xml": { "schema": { "$ref": "#/components/schemas/ContentInfo" } } } }, "401": { "description": "Error - the user is not authorized to read this object. This could also happen if there is no published version yet and another user owns a draft of this content item." }, "404": { "description": "Error - the ID is not found." } }, "summary": "Load content", "description": "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).", "parameters": [ { "name": "Accept", "in": "header", "description": "\n* Content -\tIf set, all information for the content item including the embedded current version is returned in XML or JSON format.\n* ContentInfo - If set, all information for the content item (excluding the current version) is returned in XML or JSON format.\n ", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "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" ] }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "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.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contentobjects_contentId_delete", "tags": [ "Objects" ], "responses": { "204": { "description": "The content item is deleted." }, "404": { "description": "Error - content item was not found." }, "401": { "description": "Error - the user is not authorized to delete this content item." } }, "summary": "Delete Content", "description": "Deletes content item. If content item has multiple Locations, all of them will be deleted via delete a subtree.", "parameters": [ { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_contentobjects_contentId_patch", "tags": [ "Objects" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ContentInfo+json": { "schema": { "$ref": "#/components/schemas/ContentInfoWrapper" }, "example": "\n\n \n article1\n \n \n
\n \n \n \n 2019-02-19T15:00:34+01:00\n 2019-02-19T15:00:34+01:00\n eng-GB\n 1\n false\n \n\n" }, "application/vnd.ibexa.api.ContentInfo+xml": { "schema": { "$ref": "#/components/schemas/ContentInfo" } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update this object." }, "404": { "description": "Error - the content ID does not exist." }, "412": { "description": "Error - the current ETag does not match with the one provided in the If-Match header." }, "415": { "description": "Error - the media-type is not one of those specified in headers." } }, "summary": "Update content", "description": "This method updates the content metadata which is independent from a version. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, all information for the content item (excluding the current version) is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-match", "in": "header", "description": "Causes to patch only if the specified ETag is the current one. Otherwise a 412 is returned.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The ContentUpdate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ContentMetadataUpdateController resource", "content": { "application/vnd.ibexa.api.ContentUpdate+json": { "schema": { "$ref": "#/components/schemas/ContentInfoWrapper" }, "example": "\n\n \n article1\n \n \n
\n \n \n \n 2019-02-19T15:00:34+01:00\n 2019-02-19T15:00:34+01:00\n eng-GB\n 1\n false\n \n\n" }, "application/vnd.ibexa.api.ContentUpdate+xml": { "schema": { "$ref": "#/components/schemas/ContentInfo" } } }, "required": false }, "deprecated": false } }, "/content/objects/{contentId}/currentversion": { "get": { "operationId": "api_contentobjects_contentIdcurrentversion_get", "tags": [ "Objects" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Version+json": { "schema": { "$ref": "#/components/schemas/VersionWrapper" }, "example": { "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/107/versions/5", "VersionInfo": { "id": 581, "versionNo": 5, "status": "ARCHIVED", "modificationDate": "2023-05-24T06:11:50+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-05-24T06:09:49+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Features" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/107" } }, "Fields": { "field": [ { "id": 477, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Features" }, { "id": 478, "fieldDefinitionIdentifier": "short_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": null }, { "id": 479, "fieldDefinitionIdentifier": "short_description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 480, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/107/versions/5/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } } }, "application/vnd.ibexa.api.Version+xml": { "schema": { "$ref": "#/components/schemas/Version" }, "example": "\n\n \n 581\n 5\n ARCHIVED\n 2023-05-24T06:11:50+00:00\n \n 2023-05-24T06:09:49+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Features\n \n \n \n \n \n 477\n name\n eng-GB\n ibexa_string\n Features\n \n \n 478\n short_name\n eng-GB\n ibexa_string\n \n \n \n 479\n short_description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n 480\n description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n\n" } } }, "307": { "description": "Temporary redirect." }, "404": { "description": "Error - the resource does not exist." } }, "summary": "Get current version", "description": "Redirects to the current version of the content item.", "parameters": [ { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contentobjects_contentIdcurrentversion_post", "tags": [ "Objects" ], "responses": { "201": { "description": "Created", "content": { "application/vnd.ibexa.api.Version+json": { "schema": { "$ref": "#/components/schemas/VersionWrapper" }, "example": { "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/107/versions/5", "VersionInfo": { "id": 581, "versionNo": 5, "status": "ARCHIVED", "modificationDate": "2023-05-24T06:11:50+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-05-24T06:09:49+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Features" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/107" } }, "Fields": { "field": [ { "id": 477, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Features" }, { "id": 478, "fieldDefinitionIdentifier": "short_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": null }, { "id": 479, "fieldDefinitionIdentifier": "short_description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 480, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/107/versions/5/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } } }, "application/vnd.ibexa.api.Version+xml": { "schema": { "$ref": "#/components/schemas/Version" }, "example": "\n\n \n 581\n 5\n ARCHIVED\n 2023-05-24T06:11:50+00:00\n \n 2023-05-24T06:09:49+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Features\n \n \n \n \n \n 477\n name\n eng-GB\n ibexa_string\n Features\n \n \n 478\n short_name\n eng-GB\n ibexa_string\n \n \n \n 479\n short_description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n 480\n description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n\n" } } }, "401": { "description": "Error - the user is not authorized to update this content item." }, "403": { "description": "Error - the current version is already a draft." }, "404": { "description": "Error - the content item was not found." } }, "summary": "Create a draft from current version", "description": "The system creates a new draft as a copy of the current version. COPY or POST with header X-HTTP-Method-Override COPY.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated version is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentDraftCreateFromCurrentVersionController resource", "content": [], "required": false }, "deprecated": false } }, "/content/objects/{contentId}/hide": { "post": { "operationId": "api_contentobjects_contentIdhide_post", "tags": [ "Objects" ], "responses": { "204": { "description": "OK - Object item is hidden." }, "401": { "description": "Error - The user has no permission to change Object item visibility." }, "404": { "description": "Error - The content item was not found." } }, "summary": "Hide content item", "description": "Makes or keep the content item invisible", "parameters": [ { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentHideController resource", "content": [], "required": false }, "deprecated": false } }, "/content/objects/{contentId}/locations": { "get": { "operationId": "api_contentobjects_contentIdlocations_get", "tags": [ "Objects" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.LocationList+json": { "schema": { "$ref": "#/components/schemas/LocationListWrapper" }, "example": { "LocationList": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/63/locations", "Location": [ { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/57/65" } ] } } }, "application/vnd.ibexa.api.LocationList+xml": { "schema": { "$ref": "#/components/schemas/LocationList" }, "example": "\n\n \n\n" } } }, "401": { "description": "Error - the user is not authorized to read this content item." }, "404": { "description": "Error - the content item with the given ID does not exist." } }, "summary": "Get Locations for content item", "description": "Loads all Locations for the given content item.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Location list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contentobjects_contentIdlocations_post", "tags": [ "Objects" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Location+json": { "schema": { "$ref": "#/components/schemas/LocationWrapper" }, "example": { "Location": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114", "id": 114, "priority": 0, "hidden": false, "invisible": false, "explicitlyHidden": false, "ParentLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/59" }, "pathString": "/1/2/59/114/", "depth": 3, "childCount": 0, "remoteId": "47a1e4ee082fb64e93a822dcfe3a5614", "Children": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114/children" }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/59" }, "sortField": "PATH", "sortOrder": "ASC", "UrlAliases": { "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", "_href": "/api/ibexa/v2/content/locations/1/2/59/114/urlaliases" }, "ContentInfo": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59", "_remoteId": "0fe1b1543f886b0becd4d9b2c7c517d0", "_id": 59, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2" }, "Name": "Art1", "TranslatedName": "Art1", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/59/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/59/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/59/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2021-06-28T11:33:01+00:00", "publishedDate": "2021-06-28T11:33:01+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": false, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/59/objectstates" } } } } } }, "application/vnd.ibexa.api.Location+xml": { "schema": { "$ref": "#/components/schemas/Location" }, "example": "\n\n 96\n 0\n false\n true\n false\n \n /1/2/42/96/\n 3\n 0\n 58133c8c75230e5debe362a28b92d27a\n \n \n PATH\n ASC\n \n \n \n \n Art3\n Art3\n \n \n
\n \n \n 2021-06-28T11:34:17+00:00\n 2021-06-28T11:34:17+00:00\n eng-GB\n 1\n false\n false\n PUBLISHED\n \n \n \n\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this Location." }, "403": { "description": "Error - a Location under the given parent ID already exists." } }, "summary": "Create new Location for content item", "description": "Creates a new Location for the given content item.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new Location is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The LocationCreate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new LocationCreateController resource", "content": { "application/vnd.ibexa.api.LocationCreate+json": { "schema": { "$ref": "#/components/schemas/LocationCreateWrapper" }, "example": { "LocationCreate": { "_media-type": "application/vnd.ibexa.api.LocationCreate", "ParentLocation": { "_href": "/api/ibexa/v2/content/locations/1/59" }, "priority": "0", "hidden": false, "sortField": "PATH", "sortOrder": "ASC" } } }, "application/vnd.ibexa.api.LocationCreate+xml": { "schema": { "$ref": "#/components/schemas/LocationCreate" }, "example": "\n\n \n 0\n false\n PATH\n ASC\n\n" } }, "required": false }, "deprecated": false } }, "/content/objects/{contentId}/objectstates": { "get": { "operationId": "api_contentobjects_contentIdobjectstates_get", "tags": [ "Objects" ], "responses": { "200": { "description": "OK - returns the Object state.", "content": { "application/vnd.ibexa.api.ContentObjectStates+json": { "schema": { "$ref": "#/components/schemas/ContentObjectStates" } }, "application/vnd.ibexa.api.ContentObjectStates+xml": { "schema": { "$ref": "#/components/schemas/ContentObjectStates" } } } }, "404": { "description": "Error - The content item does not exist." } }, "summary": "Get Object states of content item", "description": "Returns the Object states of a content item", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Object states are returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_contentobjects_contentIdobjectstates_patch", "tags": [ "Objects" ], "responses": { "204": { "description": "OK - Object state updated.", "content": { "application/vnd.ibexa.api.ContentObjectStates+json": { "schema": { "$ref": "#/components/schemas/ContentObjectStatesWrapper" }, "example": { "ContentObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "ObjectState": [ { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/1" }, { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/3/objectstates/3" }, { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates/7" }, { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/8/objectstates/8" } ] } } }, "application/vnd.ibexa.api.ContentObjectStates+xml": { "schema": { "$ref": "#/components/schemas/ContentObjectStates" }, "example": "\n\n \n\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to set an Object state." }, "403": { "description": "Error - The input contains multiple Object states of the same Object state group." }, "412": { "description": "Error - The current ETag does not match the one provided in the If-Match header." } }, "summary": "Set Object states of content item", "description": "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.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Object state is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The content item Object states input schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ObjectStatesForContentUpdateController resource", "content": { "application/vnd.ibexa.api.ContentObjectStates+json": { "schema": { "$ref": "#/components/schemas/ContentObjectStatesWrapper" }, "example": { "ContentObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "ObjectState": [ { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/1" }, { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/3/objectstates/3" }, { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates/7" }, { "_media-type": "application/vnd.ibexa.api.ObjectState+json", "_href": "/api/ibexa/v2/content/objectstategroups/8/objectstates/8" } ] } } }, "application/vnd.ibexa.api.ContentObjectStates+xml": { "schema": { "$ref": "#/components/schemas/ContentObjectStates" }, "example": "\n\n \n\n" } }, "required": false }, "deprecated": false } }, "/content/objects/{contentId}/relations": { "get": { "operationId": "api_contentobjects_contentIdrelations_get", "tags": [ "Objects" ], "responses": { "307": { "description": "Temporary redirect." }, "401": { "description": "Error - the user is not authorized to read this content item." }, "404": { "description": "Error - the content item was not found." } }, "summary": "Load Relations of content item", "description": "Redirects to the Relations of the current version.", "parameters": [ { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/objects/{contentId}/reveal": { "post": { "operationId": "api_contentobjects_contentIdreveal_post", "tags": [ "Objects" ], "responses": { "204": { "description": "OK - Object item is revealed." }, "401": { "description": "Error - The user has no permission to change Object item visibility." }, "404": { "description": "Error - The content item was not found." } }, "summary": "Reveal content item", "description": "Makes or keep the content item visible", "parameters": [ { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentRevealController resource", "content": [], "required": false }, "deprecated": false } }, "/content/objects/{contentId}/translations/{languageCode}": { "delete": { "operationId": "api_contentobjects_contentIdtranslations_languageCode_delete", "tags": [ "Objects" ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Error - the user is not authorized to delete content item (content/remove policy)." }, "404": { "description": "Error - the content item was not found." }, "406": { "description": "Error - the given translation does not exist for the content item." }, "409": { "description": "Error - the specified translation is the only one any version has or is the main translation." } }, "summary": "Delete translation (permanently)", "description": "Permanently deletes a translation from all versions of a content item.", "parameters": [ { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "languageCode", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/objects/{contentId}/versions": { "get": { "operationId": "api_contentobjects_contentIdversions_get", "tags": [ "Objects" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.VersionList+json": { "schema": { "$ref": "#/components/schemas/VersionListWrapper" }, "example": { "VersionList": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/61/versions", "VersionItem": [ { "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/61/versions/1" }, "VersionInfo": { "id": 521, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2021-06-28T11:33:49+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2021-06-28T11:33:31+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Art1" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/61" } } }, { "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/61/versions/2" }, "VersionInfo": { "id": 580, "versionNo": 2, "status": "DRAFT", "modificationDate": "2021-07-26T08:10:02+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2021-07-26T08:10:02+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Art1" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/61" } } }, { "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/61/versions/3" }, "VersionInfo": { "id": 581, "versionNo": 3, "status": "DRAFT", "modificationDate": "2021-07-26T08:16:50+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2021-07-26T08:16:50+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Art1" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/61" } } } ] } } }, "application/vnd.ibexa.api.VersionList+xml": { "schema": { "$ref": "#/components/schemas/VersionList" }, "example": "\n\n \n \n \n 521\n 1\n PUBLISHED\n 2021-06-28T11:33:49+00:00\n \n 2021-06-28T11:33:31+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Art1\n \n \n \n \n \n \n \n 580\n 2\n DRAFT\n 2021-07-26T08:10:02+00:00\n \n 2021-07-26T08:10:02+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Art1\n \n \n \n \n \n \n \n 581\n 3\n DRAFT\n 2021-07-26T08:16:50+00:00\n \n 2021-07-26T08:16:50+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Art1\n \n \n \n \n\n" } } }, "401": { "description": "Error - the user has no permission to read the versions." } }, "summary": "List versions", "description": "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.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the version list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/objects/{contentId}/versions/{versionNo}": { "get": { "operationId": "api_contentobjects_contentIdversions_versionNo_get", "tags": [ "Objects" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Version+json": { "schema": { "$ref": "#/components/schemas/VersionWrapper" }, "example": { "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/107/versions/5", "VersionInfo": { "id": 581, "versionNo": 5, "status": "ARCHIVED", "modificationDate": "2023-05-24T06:11:50+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-05-24T06:09:49+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Features" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/107" } }, "Fields": { "field": [ { "id": 477, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Features" }, { "id": 478, "fieldDefinitionIdentifier": "short_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": null }, { "id": 479, "fieldDefinitionIdentifier": "short_description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 480, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/107/versions/5/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } } }, "application/vnd.ibexa.api.Version+xml": { "schema": { "$ref": "#/components/schemas/Version" }, "example": "\n\n \n 581\n 5\n ARCHIVED\n 2023-05-24T06:11:50+00:00\n \n 2023-05-24T06:09:49+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Features\n \n \n \n \n \n 477\n name\n eng-GB\n ibexa_string\n Features\n \n \n 478\n short_name\n eng-GB\n ibexa_string\n \n \n \n 479\n short_description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n 480\n description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n\n" } } }, "304": { "description": "Error - the ETag does not match the current one." }, "401": { "description": "Error - the user is not authorized to read this content item." }, "404": { "description": "Error - the ID or version is not found." } }, "summary": "Load version", "description": "Loads a specific version of a content item. This method returns Fields and relations.", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "Only return the version if the given ETag is the not current one, otherwise a 304 is returned.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Accept", "in": "header", "description": "If set, the version list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "versionNo", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contentobjects_contentIdversions_versionNo_post", "tags": [ "Objects" ], "responses": { "201": { "description": "Created.", "content": { "application/vnd.ibexa.api.Version+json": { "schema": { "$ref": "#/components/schemas/VersionWrapper" }, "example": { "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/107/versions/5", "VersionInfo": { "id": 581, "versionNo": 5, "status": "ARCHIVED", "modificationDate": "2023-05-24T06:11:50+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-05-24T06:09:49+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Features" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/107" } }, "Fields": { "field": [ { "id": 477, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Features" }, { "id": 478, "fieldDefinitionIdentifier": "short_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": null }, { "id": 479, "fieldDefinitionIdentifier": "short_description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 480, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/107/versions/5/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } } }, "application/vnd.ibexa.api.Version+xml": { "schema": { "$ref": "#/components/schemas/Version" }, "example": "\n\n \n 581\n 5\n ARCHIVED\n 2023-05-24T06:11:50+00:00\n \n 2023-05-24T06:09:49+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Features\n \n \n \n \n \n 477\n name\n eng-GB\n ibexa_string\n Features\n \n \n 478\n short_name\n eng-GB\n ibexa_string\n \n \n \n 479\n short_description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n 480\n description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n\n" } } }, "401": { "description": "Error - the user is not authorized to update this content item." }, "404": { "description": "Error - the content item was not found." } }, "summary": "Create a draft from a version", "description": "The system creates a new draft as a copy of the given version. COPY or POST with header X-HTTP-Method-Override COPY.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated version is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "versionNo", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentDraftCreateFromVersionController resource", "content": [], "required": false }, "deprecated": false }, "delete": { "operationId": "api_contentobjects_contentIdversions_versionNo_delete", "tags": [ "Objects" ], "responses": { "204": { "description": "No Content - the version is deleted." }, "404": { "description": "Error - the content item or version were not found." }, "401": { "description": "Error - the user is not authorized to delete this version." }, "403": { "description": "Error - the version is in published state." } }, "summary": "Delete content version", "description": "Deletes the content version.", "parameters": [ { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "versionNo", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_contentobjects_contentIdversions_versionNo_patch", "tags": [ "Objects" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Version+json": { "schema": { "$ref": "#/components/schemas/VersionWrapper" }, "example": { "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/107/versions/5", "VersionInfo": { "id": 581, "versionNo": 5, "status": "ARCHIVED", "modificationDate": "2023-05-24T06:11:50+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-05-24T06:09:49+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Features" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/107" } }, "Fields": { "field": [ { "id": 477, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Features" }, { "id": 478, "fieldDefinitionIdentifier": "short_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": null }, { "id": 479, "fieldDefinitionIdentifier": "short_description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 480, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/107/versions/5/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } } }, "application/vnd.ibexa.api.Version+xml": { "schema": { "$ref": "#/components/schemas/Version" }, "example": "\n\n \n 581\n 5\n ARCHIVED\n 2023-05-24T06:11:50+00:00\n \n 2023-05-24T06:09:49+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Features\n \n \n \n \n \n 477\n name\n eng-GB\n ibexa_string\n Features\n \n \n 478\n short_name\n eng-GB\n ibexa_string\n \n \n \n 479\n short_description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n 480\n description\n eng-GB\n ibexa_richtext\n \n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update this version." }, "403": { "description": "Error - the version is not allowed to change - i.e. version is not a DRAFT." }, "404": { "description": "Error - the content ID or version ID does not exist." }, "412": { "description": "Error - the current ETag does not match with the one provided in the If-Match header." } }, "summary": "Update version", "description": "A specific draft is updated. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated version is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-match", "in": "header", "description": "Performs the patch only if the specified ETag is the current one.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The VersionUpdate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "versionNo", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ContentVersionUpdateController resource", "content": { "application/vnd.ibexa.api.VersionUpdate+json": { "schema": { "$ref": "#/components/schemas/VersionUpdateWrapper" } }, "application/vnd.ibexa.api.VersionUpdate+xml": { "schema": { "$ref": "#/components/schemas/VersionUpdate" }, "example": "\n\n 2012-02-20T12:00:00\n ger-DE\n \n \n 1234\n title\n ger-DE\n Neuer Titel\n \n \n 1235\n summary\n ger-DE\n Dies ist eine neuse Zusammenfassungy\n \n \n\n" } }, "required": false }, "deprecated": false } }, "/content/objects/{contentId}/versions/{versionNo}/relations": { "get": { "operationId": "api_contentobjects_contentIdversions_versionNorelations_get", "tags": [ "Objects" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.RelationList+json": { "schema": { "$ref": "#/components/schemas/RelationListWrapper" }, "example": { "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/107/versions/9/relations", "Relation": [ { "_media-type": "application/vnd.ibexa.api.Relation+json", "_href": "/api/ibexa/v2/content/objects/107/versions/9/relations/7", "SourceContent": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/107" }, "DestinationContent": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/52" }, "RelationType": "LINK" } ] } } }, "application/vnd.ibexa.api.RelationList+xml": { "schema": { "$ref": "#/components/schemas/RelationList" }, "example": "\n\n \n \n \n LINK\n \n\n" } } }, "401": { "description": "Error - the user is not authorized to read this content item." }, "404": { "description": "Error - the content item was not found." } }, "summary": "Load Relations of content item version", "description": "Loads the Relations of the given version.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Relation is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "versionNo", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contentobjects_contentIdversions_versionNorelations_post", "tags": [ "Objects" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Relation+json": { "schema": { "$ref": "#/components/schemas/RelationWrapper" }, "example": { "Relation": { "_media-type": "application/vnd.ibexa.api.Relation+json", "_href": "/api/ibexa/v2/content/objects/59/versions/2/relations/38", "SourceContent": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59" }, "DestinationContent": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59" }, "RelationType": "COMMON" } } }, "application/vnd.ibexa.api.Relation+xml": { "schema": { "$ref": "#/components/schemas/Relation" }, "example": "\n\n \n \n COMMON\n\n" } } } }, "summary": "Create new Relation", "description": "Creates a new Relation of type COMMON for the given draft.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated version is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The RelationCreate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "versionNo", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentRelationCreateController resource", "content": { "application/vnd.ibexa.api.RelationCreate+json": { "schema": { "$ref": "#/components/schemas/RelationCreateWrapper" }, "example": { "RelationCreate": { "Destination": { "_href": "/api/ibexa/v2/content/objects/59" } } } }, "application/vnd.ibexa.api.RelationCreate+xml": { "schema": { "$ref": "#/components/schemas/RelationCreate" }, "example": "\n\n \n\n" } }, "required": false }, "deprecated": false } }, "/content/objects/{contentId}/versions/{versionNo}/relations/{relationId}": { "get": { "operationId": "api_contentobjects_contentIdversions_versionNorelations_relationId_get", "tags": [ "Objects" ], "responses": { "200": { "description": "OK - loads a Relation for the given content item.", "content": { "application/vnd.ibexa.api.Relation+json": { "schema": { "$ref": "#/components/schemas/RelationWrapper" }, "example": { "Relation": { "_media-type": "application/vnd.ibexa.api.Relation+json", "_href": "/api/ibexa/v2/content/objects/59/versions/2/relations/38", "SourceContent": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59" }, "DestinationContent": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/59" }, "RelationType": "COMMON" } } }, "application/vnd.ibexa.api.Relation+xml": { "schema": { "$ref": "#/components/schemas/Relation" }, "example": "\n\n \n \n COMMON\n\n" } } }, "401": { "description": "Error - the user is not authorized to read this content item." }, "404": { "description": "Error - the content item with the given ID or the Relation does not exist." } }, "summary": "Load Relation", "description": "Loads a Relation for the given content item.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Relation is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "versionNo", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "relationId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contentobjects_contentIdversions_versionNorelations_relationId_delete", "tags": [ "Objects" ], "responses": { "204": { "description": "No Content - deleted a Relation of the given draft." }, "401": { "description": "Error - the user is not authorized to delete this Relation." }, "403": { "description": "Error - the Relation is not of type COMMON or the given version is not a draft." }, "404": { "description": "Error - content item or the Relation were not found in the given version." } }, "summary": "Delete Relation", "description": "Deletes a Relation of the given draft.", "parameters": [ { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "versionNo", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "relationId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/objects/{contentId}/versions/{versionNo}/translations/{languageCode}": { "delete": { "operationId": "api_contentobjects_contentIdversions_versionNotranslations_languageCode_delete", "tags": [ "Objects" ], "responses": { "204": { "description": "No Content - removes a translation from a version draft." }, "401": { "description": "Error - the user is not authorized to delete this translation." }, "403": { "description": "Error - the version is not in draft state." }, "404": { "description": "Error - the content item or version number were not found." }, "406": { "description": "Error - the given translation does not exist for the version." }, "409": { "description": "Error - the specified translation is the only one the version has or is the main translation." } }, "summary": "Delete translation from version draft", "description": "Removes a translation from a version draft.", "parameters": [ { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "versionNo", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "languageCode", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/orders/order/cancel/{id}": { "post": { "operationId": "api_ordersordercancel_id_post", "tags": [ "Orders" ], "responses": { "204": { "description": "No content - the given order is cancelled." }, "401": { "description": "Error - the user is not authorized to delete this order." }, "404": { "description": "Error - the order with the given ID does not exist." }, "406": { "description": "Error - the order cannot be cancelled due to not-allowed workflow transition" } }, "summary": "Cancel order", "description": "Cancels the given order.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new OrderCancelController resource", "content": [], "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/orders/order/{identifier}": { "get": { "operationId": "api_ordersorder_identifier_get", "tags": [ "Orders" ], "responses": { "200": { "description": "OK - loads the order.", "content": { "application/vnd.ibexa.api.Order+json": { "schema": { "$ref": "#/components/schemas/OrderWrapper" }, "example": { "Order": { "_media-type": "application/vnd.ibexa.api.Order+json", "id": 2, "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898", "created": { "date": "2023-04-18 09:06:02.000000", "timezone_type": 3, "timezone": "UTC" }, "modified": { "date": "2023-04-18 09:06:02.000000", "timezone_type": 3, "timezone": "UTC" }, "status": "pending", "OrderUser": { "_media-type": "application/vnd.ibexa.api.OrderUser+json", "id": 14, "name": "Administrator", "email": "aa@aa.aa" }, "OrderCurrency": { "_media-type": "application/vnd.ibexa.api.OrderCurrency+json", "id": 1, "code": "EUR" }, "OrderValue": { "_media-type": "application/vnd.ibexa.api.OrderValue+json", "vat": { "amount": "10", "currency": "EUR" }, "total_gross": { "amount": "10", "currency": "EUR" }, "total_net": { "amount": "10", "currency": "EUR" } }, "OrderCompany": { "_media-type": "application/vnd.ibexa.api.OrderCompany+json", "id": 68, "name": "Apple" }, "OrderItemsList": [ { "_media-type": "application/vnd.ibexa.api.OrderItem+json", "quantity": 10, "OrderItemValue": { "_media-type": "application/vnd.ibexa.api.OrderItemValue+json", "unit_price_gross": { "amount": "110", "currency": "EUR" }, "unit_price_net": { "amount": "100", "currency": "EUR" }, "vat_rate": "10.00", "subtotal_price_gross": { "amount": "1100", "currency": "EUR" }, "subtotal_price_net": { "amount": "1000", "currency": "EUR" } }, "OrderItemProduct": { "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json", "id": 1, "code": "test", "name": "Test" }, "context": { "foo": "bar", "baz": true } } ], "context": { "foo": "bar", "baz": 123 } } } }, "application/vnd.ibexa.api.Order+xml": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "401": { "description": "Error - the user has no permission to read orders." }, "404": { "description": "Error - the order does not exist." } }, "summary": "Load order by identifier", "description": "Loads an order by its identifier (UUID).", "parameters": [ { "name": "Accept", "in": "header", "description": "Order - If set, the order returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/orders/order/{id}": { "get": { "operationId": "api_ordersorder_id_get", "tags": [ "Orders" ], "responses": { "200": { "description": "OK - loads the order.", "content": { "application/vnd.ibexa.api.Order+json": { "schema": { "$ref": "#/components/schemas/OrderWrapper" }, "example": { "Order": { "_media-type": "application/vnd.ibexa.api.Order+json", "id": 2, "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898", "created": { "date": "2023-04-18 09:06:02.000000", "timezone_type": 3, "timezone": "UTC" }, "modified": { "date": "2023-04-18 09:06:02.000000", "timezone_type": 3, "timezone": "UTC" }, "status": "pending", "OrderUser": { "_media-type": "application/vnd.ibexa.api.OrderUser+json", "id": 14, "name": "Administrator", "email": "aa@aa.aa" }, "OrderCurrency": { "_media-type": "application/vnd.ibexa.api.OrderCurrency+json", "id": 1, "code": "EUR" }, "OrderValue": { "_media-type": "application/vnd.ibexa.api.OrderValue+json", "vat": { "amount": "10", "currency": "EUR" }, "total_gross": { "amount": "10", "currency": "EUR" }, "total_net": { "amount": "10", "currency": "EUR" } }, "OrderCompany": { "_media-type": "application/vnd.ibexa.api.OrderCompany+json", "id": 68, "name": "Apple" }, "OrderItemsList": [ { "_media-type": "application/vnd.ibexa.api.OrderItem+json", "quantity": 10, "OrderItemValue": { "_media-type": "application/vnd.ibexa.api.OrderItemValue+json", "unit_price_gross": { "amount": "110", "currency": "EUR" }, "unit_price_net": { "amount": "100", "currency": "EUR" }, "vat_rate": "10.00", "subtotal_price_gross": { "amount": "1100", "currency": "EUR" }, "subtotal_price_net": { "amount": "1000", "currency": "EUR" } }, "OrderItemProduct": { "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json", "id": 1, "code": "test", "name": "Test" }, "context": { "foo": "bar", "baz": true } } ], "context": { "foo": "bar", "baz": 123 } } } }, "application/vnd.ibexa.api.Order+xml": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "401": { "description": "Error - the user has no permission to read orders." }, "404": { "description": "Error - the order does not exist." } }, "summary": "Load order by ID", "description": "Loads an order by its numerical ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "Order - If set, the order returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "patch": { "operationId": "api_ordersorder_id_patch", "tags": [ "Orders" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Order+json": { "schema": { "$ref": "#/components/schemas/OrderWrapper" }, "example": { "Order": { "_media-type": "application/vnd.ibexa.api.Order+json", "id": 2, "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898", "created": { "date": "2023-04-18 09:06:02.000000", "timezone_type": 3, "timezone": "UTC" }, "modified": { "date": "2023-04-18 09:06:02.000000", "timezone_type": 3, "timezone": "UTC" }, "status": "pending", "OrderUser": { "_media-type": "application/vnd.ibexa.api.OrderUser+json", "id": 14, "name": "Administrator", "email": "aa@aa.aa" }, "OrderCurrency": { "_media-type": "application/vnd.ibexa.api.OrderCurrency+json", "id": 1, "code": "EUR" }, "OrderValue": { "_media-type": "application/vnd.ibexa.api.OrderValue+json", "vat": { "amount": "10", "currency": "EUR" }, "total_gross": { "amount": "10", "currency": "EUR" }, "total_net": { "amount": "10", "currency": "EUR" } }, "OrderCompany": { "_media-type": "application/vnd.ibexa.api.OrderCompany+json", "id": 68, "name": "Apple" }, "OrderItemsList": [ { "_media-type": "application/vnd.ibexa.api.OrderItem+json", "quantity": 10, "OrderItemValue": { "_media-type": "application/vnd.ibexa.api.OrderItemValue+json", "unit_price_gross": { "amount": "110", "currency": "EUR" }, "unit_price_net": { "amount": "100", "currency": "EUR" }, "vat_rate": "10.00", "subtotal_price_gross": { "amount": "1100", "currency": "EUR" }, "subtotal_price_net": { "amount": "1000", "currency": "EUR" } }, "OrderItemProduct": { "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json", "id": 1, "code": "test", "name": "Test" }, "context": { "foo": "bar", "baz": true } } ], "context": { "foo": "bar", "baz": 123 } } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update this order." }, "404": { "description": "Error - the order with the given ID does not exist." }, "406": { "description": "Error - the order cannot be cancelled due to not-allowed workflow transition" } }, "summary": "Update order", "description": "Updates an order.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated order is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The OrderUpdate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated OrderUpdateController resource", "content": { "application/vnd.ibexa.api.OrderUpdate+json": { "schema": { "$ref": "#/components/schemas/OrderUpdateWrapper" }, "example": { "OrderUpdate": { "status": "cancelled", "transition": "cancel" } } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/orders/orders": { "get": { "operationId": "api_ordersorders_get", "tags": [ "Orders" ], "responses": { "200": { "description": "OK - loads orders.", "content": { "application/vnd.ibexa.api.OrderList+json": { "schema": { "$ref": "#/components/schemas/OrderListWrapper" }, "example": { "OrderList": { "_media-type": "application/vnd.ibexa.api.OrderList+json", "Order": [ { "_media-type": "application/vnd.ibexa.api.Order+json", "id": 2, "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898", "created": { "date": "2023-04-18 09:06:02.000000", "timezone_type": 3, "timezone": "UTC" }, "modified": { "date": "2023-04-18 09:06:02.000000", "timezone_type": 3, "timezone": "UTC" }, "status": "pending", "OrderUser": { "_media-type": "application/vnd.ibexa.api.OrderUser+json", "id": 14, "name": "Administrator", "email": "aa@aa.aa" }, "OrderCurrency": { "_media-type": "application/vnd.ibexa.api.OrderCurrency+json", "id": 1, "code": "EUR" }, "OrderValue": { "_media-type": "application/vnd.ibexa.api.OrderValue+json", "vat": { "amount": "10", "currency": "EUR" }, "total_gross": { "amount": "10", "currency": "EUR" }, "total_net": { "amount": "10", "currency": "EUR" } }, "OrderCompany": { "_media-type": "application/vnd.ibexa.api.OrderCompany+json", "id": 68, "name": "Apple" }, "OrderItemsList": [ { "_media-type": "application/vnd.ibexa.api.OrderItem+json", "quantity": 10, "OrderItemValue": { "_media-type": "application/vnd.ibexa.api.OrderItemValue+json", "unit_price_gross": { "amount": "110", "currency": "EUR" }, "unit_price_net": { "amount": "100", "currency": "EUR" }, "vat_rate": "10.00", "subtotal_price_gross": { "amount": "1100", "currency": "EUR" }, "subtotal_price_net": { "amount": "1000", "currency": "EUR" } }, "OrderItemProduct": { "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json", "id": 1, "code": "test", "name": "Test" }, "context": { "foo": "bar", "baz": true } } ], "context": { "foo": "bar", "baz": 123 } }, { "_media-type": "application/vnd.ibexa.api.Order+json", "id": 3, "identifier": "79b20ac4-fe23-4566-a9c2-b81966431026", "created": { "date": "2023-04-18 09:44:34.000000", "timezone_type": 3, "timezone": "UTC" }, "modified": { "date": "2023-04-18 09:44:34.000000", "timezone_type": 3, "timezone": "UTC" }, "status": "pending", "OrderUser": { "_media-type": "application/vnd.ibexa.api.OrderUser+json", "id": 14, "name": "Administrator", "email": "aa@aa.aa" }, "OrderCurrency": { "_media-type": "application/vnd.ibexa.api.OrderCurrency+json", "id": 1, "code": "EUR" }, "OrderValue": { "_media-type": "application/vnd.ibexa.api.OrderValue+json", "vat": { "amount": "10", "currency": "EUR" }, "total_gross": { "amount": "10", "currency": "EUR" }, "total_net": { "amount": "10", "currency": "EUR" } }, "OrderCompany": { "_media-type": "application/vnd.ibexa.api.OrderCompany+json", "id": 68, "name": "Apple" }, "OrderItemsList": [ { "_media-type": "application/vnd.ibexa.api.OrderItem+json", "quantity": 10, "OrderItemValue": { "_media-type": "application/vnd.ibexa.api.OrderItemValue+json", "unit_price_gross": { "amount": "110", "currency": "EUR" }, "unit_price_net": { "amount": "100", "currency": "EUR" }, "vat_rate": "10.00", "subtotal_price_gross": { "amount": "1100", "currency": "EUR" }, "subtotal_price_net": { "amount": "1000", "currency": "EUR" } }, "OrderItemProduct": { "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json", "id": 1, "code": "test", "name": "Test" }, "context": { "foo": "bar", "baz": true } } ], "context": { "foo": "bar", "baz": 123 } } ] } } }, "application/vnd.ibexa.api.OrderList+xml": { "schema": { "$ref": "#/components/schemas/OrderList" } } } }, "401": { "description": "Error - the user has no permission to read orders." } }, "summary": "Load orders", "description": "Loads a list of orders.", "parameters": [ { "name": "Accept", "in": "header", "description": "OrderList - If set, the orders list returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "post": { "operationId": "api_ordersorders_post", "tags": [ "Orders" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Order+json": { "schema": { "$ref": "#/components/schemas/OrderWrapper" }, "example": { "Order": { "_media-type": "application/vnd.ibexa.api.Order+json", "id": 2, "identifier": "2d9c73cd-ea10-4459-b20e-96710c8d3898", "created": { "date": "2023-04-18 09:06:02.000000", "timezone_type": 3, "timezone": "UTC" }, "modified": { "date": "2023-04-18 09:06:02.000000", "timezone_type": 3, "timezone": "UTC" }, "status": "pending", "OrderUser": { "_media-type": "application/vnd.ibexa.api.OrderUser+json", "id": 14, "name": "Administrator", "email": "aa@aa.aa" }, "OrderCurrency": { "_media-type": "application/vnd.ibexa.api.OrderCurrency+json", "id": 1, "code": "EUR" }, "OrderValue": { "_media-type": "application/vnd.ibexa.api.OrderValue+json", "vat": { "amount": "10", "currency": "EUR" }, "total_gross": { "amount": "10", "currency": "EUR" }, "total_net": { "amount": "10", "currency": "EUR" } }, "OrderCompany": { "_media-type": "application/vnd.ibexa.api.OrderCompany+json", "id": 68, "name": "Apple" }, "OrderItemsList": [ { "_media-type": "application/vnd.ibexa.api.OrderItem+json", "quantity": 10, "OrderItemValue": { "_media-type": "application/vnd.ibexa.api.OrderItemValue+json", "unit_price_gross": { "amount": "110", "currency": "EUR" }, "unit_price_net": { "amount": "100", "currency": "EUR" }, "vat_rate": "10.00", "subtotal_price_gross": { "amount": "1100", "currency": "EUR" }, "subtotal_price_net": { "amount": "1000", "currency": "EUR" } }, "OrderItemProduct": { "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json", "id": 1, "code": "test", "name": "Test" }, "context": { "foo": "bar", "baz": true } } ], "context": { "foo": "bar", "baz": 123 } } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this order." }, "406": { "description": "Error - a order with this identifier already exists." } }, "summary": "Create order", "description": "Creates a new order.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new order is returned in JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Order schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new OrderCreateController resource", "content": { "application/vnd.ibexa.api.OrderCreate+json": { "schema": { "$ref": "#/components/schemas/OrderCreateWrapper" }, "example": { "OrderCreate": { "OrderUser": { "id": 14, "name": "Administrator", "email": "test@ibexa.co" }, "OrderCurrency": { "id": 1, "code": "EUR" }, "OrderValue": { "vat": "10", "total_gross": "11", "total_net": "10" }, "OrderCompany": { "id": 68, "name": "Apple" }, "source": "local", "items": [ { "OrderItem": { "OrderItemValue": { "unit_price_gross": "110", "unit_price_net": "100", "vat_rate": "10", "subtotal_price_gross": "1100", "subtotal_price_net": "1000" }, "OrderItemProduct": { "id": 1, "code": "test", "name": "Test" }, "quantity": 10, "context": { "foo": "bar", "baz": true } } } ], "context": { "foo": "bar", "baz": 123 } } } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/payment-method": { "post": { "operationId": "api_payment-method_post", "tags": [ "Payments" ], "responses": { "200": { "description": "OK", "content": { "application/vnd.ibexa.api.PaymentMethod+json": { "schema": { "$ref": "#/components/schemas/PaymentMethodWrapper" }, "example": { "PaymentMethod": { "_media-type": "application/vnd.ibexa.api.PaymentMethod+json", "identifier": "bank_transfer", "id": 1, "enabled": true, "name": "Bank transfer", "description": "Bank transfer" } } }, "application/vnd.ibexa.api.PaymentMethod+xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create Payment Method." }, "404": { "description": "Error - the payment methods does not exist." } }, "summary": "Create payment method", "description": "Creates a PaymentMethodCreateController resource.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the created Payment Method is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Payment Method input schema encoded in XML or JSON.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new PaymentMethodCreateController resource", "content": { "application/vnd.ibexa.api.PaymentMethodCreateStruct+json": { "schema": { "$ref": "#/components/schemas/PaymentMethodCreateStructWrapper" }, "example": { "PaymentMethodCreateStruct": { "identifier": "bank_transfer", "type": "offline", "names": { "eng-GB": "Bank Transfer" } } } }, "application/vnd.ibexa.api.PaymentMethodCreateStruct+xml": { "schema": { "$ref": "#/components/schemas/PaymentMethodCreateStruct" }, "example": "\n bank_transfer\n offline\n \n Bank transfer\n \n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/payment-method/view": { "post": { "operationId": "api_payment-methodview_post", "tags": [ "Payments" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.PaymentMethodView+json": { "schema": { "$ref": "#/components/schemas/PaymentMethodViewWrapper" }, "example": { "PaymentMethodView": { "_media-type": "application/vnd.ibexa.api.PaymentMethodView+json", "identifier": "example", "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 4, "PaymentMethodList": [ { "_media-type": "application/vnd.ibexa.api.PaymentMethod+json", "identifier": "bank_transfer", "id": 1, "enabled": true, "name": "Bank transfer", "description": "Bank transfer" }, { "_media-type": "application/vnd.ibexa.api.PaymentMethod+json", "identifier": "cash_on_delivery", "id": 2, "enabled": true, "name": "Cash on delivery", "description": "Cash on delivery" }, { "_media-type": "application/vnd.ibexa.api.PaymentMethod+json", "identifier": "invoice", "id": 3, "enabled": true, "name": "Invoice", "description": "Invoice" }, { "_media-type": "application/vnd.ibexa.api.PaymentMethod+json", "identifier": "paypal", "id": 4, "enabled": true, "name": "PayPal", "description": "PayPal" } ] } } } }, "application/vnd.ibexa.api.PaymentMethodView+xml": { "schema": { "$ref": "#/components/schemas/PaymentMethodView" } } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "List payment methods", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new PaymentMethodFindController resource", "content": { "application/vnd.ibexa.api.PaymentMethodViewInput+json": { "schema": { "$ref": "#/components/schemas/PaymentMethodViewInputWrapper" }, "example": { "PaymentMethodViewInput": { "identifier": "example", "PaymentMethodQuery": { "offset": 0, "limit": 10 } } } }, "application/vnd.ibexa.api.PaymentMethodViewInput+xml": { "schema": { "$ref": "#/components/schemas/PaymentMethodViewInput" } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/payment-method/{identifier}": { "get": { "operationId": "api_payment-method_identifier_get", "tags": [ "Payments" ], "responses": { "200": { "description": "OK - loads the payment method.", "content": { "application/vnd.ibexa.api.PaymentMethod+json": { "schema": { "$ref": "#/components/schemas/PaymentMethodWrapper" }, "example": { "PaymentMethod": { "_media-type": "application/vnd.ibexa.api.PaymentMethod+json", "identifier": "bank_transfer", "id": 1, "enabled": true, "name": "Bank transfer", "description": "Bank transfer" } } }, "application/vnd.ibexa.api.PaymentMethod+xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } } }, "401": { "description": "Error - the user has no permission to read payment methods." }, "404": { "description": "Error - the payment methods does not exist." } }, "summary": "Load payment method by identifier", "description": "Loads an payment method by its identifier.", "parameters": [ { "name": "Accept", "in": "header", "description": "Payment Method - If set, the payment method returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "delete": { "operationId": "api_payment-method_identifier_delete", "tags": [ "Payments" ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Error - the user has no permission to delete payment methods." }, "404": { "description": "Error - the payment methods does not exist." } }, "summary": "Delete payment method", "description": "Removes the PaymentMethodDeleteController resource.", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "patch": { "operationId": "api_payment-method_identifier_patch", "tags": [ "Payments" ], "responses": { "200": { "description": "OK", "content": { "application/vnd.ibexa.api.PaymentMethod+json": { "schema": { "$ref": "#/components/schemas/PaymentMethodWrapper" }, "example": { "PaymentMethod": { "_media-type": "application/vnd.ibexa.api.PaymentMethod+json", "identifier": "bank_transfer", "id": 1, "enabled": true, "name": "Bank transfer", "description": "Bank transfer" } } }, "application/vnd.ibexa.api.PaymentMethod+xml": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update Payment Method." }, "404": { "description": "Error - the payment methods does not exist." } }, "summary": "Update payment method", "description": "Updates the PaymentMethodUpdateController resource.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Payment Method is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Payment Method input schema encoded in XML or JSON.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated PaymentMethodUpdateController resource", "content": { "application/vnd.ibexa.api.PaymentMethodUpdateStruct+json": { "schema": { "$ref": "#/components/schemas/PaymentMethodUpdateStructWrapper" }, "example": { "PaymentMethodUpdateStructParser": { "names": { "eng-GB": "Bank transfer (updated)" } } } }, "application/vnd.ibexa.api.PaymentMethodUpdateStruct+xml": { "schema": { "$ref": "#/components/schemas/PaymentMethodUpdateStruct" }, "example": "\n\n \n Bank transfer (updated)\n \n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/payment-method/{id}": { "get": { "operationId": "api_payment-method_id_get", "tags": [ "Payments" ], "responses": { "200": { "description": "OK - loads the payment method.", "content": { "application/vnd.ibexa.api.PaymentMethod+json": { "schema": { "$ref": "#/components/schemas/PaymentMethodWrapper" }, "example": { "PaymentMethod": { "_media-type": "application/vnd.ibexa.api.PaymentMethod+json", "identifier": "bank_transfer", "id": 1, "enabled": true, "name": "Bank transfer", "description": "Bank transfer" } } } } }, "401": { "description": "Error - the user has no permission to read payment methods." }, "404": { "description": "Error - the payment methods does not exist." } }, "summary": "Load payment method by id", "description": "Loads an payment method by its id.", "parameters": [ { "name": "Accept", "in": "header", "description": "Payment Method - If set, the payment method returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/product/catalog/products": { "get": { "operationId": "api_productcatalogproducts_get", "tags": [ "Product" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ProductList+json": { "schema": { "$ref": "#/components/schemas/ProductListWrapper" }, "example": { "ProductList": { "_media-type": "application/vnd.ibexa.api.ProductList+json", "Product": [ { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "wsk_98845", "name": "HUMMINGBIRD PRO DRY 9,2MM", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "d_rope", "name": "Dynamic ropes", "AttributeAssignmentList": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1645787815, "updated_at": 1645787815, "AttributesList": [] }, { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "wsst_34456", "name": "Simond XC 60m", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "s_rope", "name": "Static ropes", "AttributeAssignmentList": [] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/141", "_remoteId": "86fdab24802923a9c30994858165ba9b", "_id": 141, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/54" }, "Name": "HUMMINGBIRD PRO DRY 9,2MM", "TranslatedName": "HUMMINGBIRD PRO DRY 9,2MM", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/141/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/141/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/141/versions/2", "VersionInfo": { "id": 618, "versionNo": 2, "status": "PUBLISHED", "modificationDate": "2022-05-27T09:29:33+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2022-05-27T09:29:33+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "HUMMINGBIRD PRO DRY 9,2MM" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/141" } }, "Fields": { "field": [ { "id": 612, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "HUMMINGBIRD PRO DRY 9,2MM" }, { "id": 613, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 25, "code": "wsk_98845", "attributes": [ 10 ] } }, { "id": 614, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 615, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/141/versions/2/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/141/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2022-05-27T09:29:33+00:00", "publishedDate": "2022-05-27T06:51:36+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 2, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/141/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1645787893, "updated_at": 1645787893, "AttributesList": [] } ] } } } } }, "401": { "description": "Error - the user has no permission to read product." } }, "summary": "Load products list (deprecated)", "description": "Returns a list of products. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/products/view instead.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the products are returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The product list schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "content": { "application/vnd.ibexa.api.ProductListGet+json": { "schema": { "$ref": "#/components/schemas/ProductListGetWrapper" }, "example": { "ProductListGet": { "offset": 0, "limit": 10, "languages": [ "eng-GB" ] } } } }, "required": false }, "deprecated": false } }, "/product/catalog/products/view": { "post": { "operationId": "api_productcatalogproductsview_post", "tags": [ "Product" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ProductView+json": { "schema": { "$ref": "#/components/schemas/ProductViewWrapper" }, "example": { "ProductView": { "_media-type": "application/vnd.ibexa.api.ProductView+json", "identifier": "TitleView", "ProductQuery": { "_media-type": "application/vnd.ibexa.api.ProductQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 2, "ProductList": { "_media-type": "application/vnd.ibexa.api.ProductList+json", "Product": [ { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "OTHER", "isBaseProduct": false, "isVariant": false, "name": "Other Office Desk", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "desk", "name": "Desk", "AttributeAssignmentList": [ { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": false, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "color", "name": "Color", "description": "", "type": "Selection", "type_identifier": "selection", "group": "Desk", "position": 0, "options": { "choices": [ { "label": { "eng-GB": "Black" }, "value": "black" }, { "label": { "eng-GB": "White" }, "value": "white" } ] }, "value": null } }, { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": false, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "width", "name": "Width", "description": "", "type": "Measurement (single)", "type_identifier": "measurement_single", "group": "Desk", "position": 0, "options": { "sign": "none", "type": "length", "unit": "centimeter", "defaultValue": null }, "value": null } } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/67", "_remoteId": "c5c22c68912af81992b74851f158db4a", "_id": 67, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/53" }, "Name": "Other Office Desk", "TranslatedName": "Other Office Desk", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/67/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/67/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/67/versions/2", "VersionInfo": { "id": 529, "versionNo": 2, "status": "PUBLISHED", "modificationDate": "2023-04-12T14:06:25+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-12T14:06:25+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Other Office Desk" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/67" } }, "Fields": { "field": [ { "id": 301, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Other Office Desk" }, { "id": 302, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 4, "code": "OTHER", "attributes": [ "white", [] ] } }, { "id": 303, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 304, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } }, { "id": 305, "fieldDefinitionIdentifier": "category", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", "fieldValue": { "taxonomy_entries": [], "taxonomy": "product_categories" } }, { "id": 306, "fieldDefinitionIdentifier": "field_64369cb9130a7", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_seo", "fieldValue": "" } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/67/versions/2/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/67/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-12T14:06:25+00:00", "publishedDate": "2023-04-12T11:59:17+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 2, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/67/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1681308385, "updated_at": 1681308385, "AttributesList": [ { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "color", "name": "Color", "description": "", "type": "Selection", "type_identifier": "selection", "group": "Desk", "position": 0, "options": { "choices": [ { "label": { "eng-GB": "Black" }, "value": "black" }, { "label": { "eng-GB": "White" }, "value": "white" } ] }, "value": "white" }, { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "width", "name": "Width", "description": "", "type": "Measurement (single)", "type_identifier": "measurement_single", "group": "Desk", "position": 0, "options": { "sign": "none", "type": "length", "unit": "centimeter", "defaultValue": null }, "value": null } ], "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "160.00", "base_amount": "160.00", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true }, "money": "16000", "base_money": "16000" } }, { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "ERGO", "isBaseProduct": false, "isVariant": false, "name": "Ergo Office Desk", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "desk", "name": "Desk", "AttributeAssignmentList": [ { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": false, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "color", "name": "Color", "description": "", "type": "Selection", "type_identifier": "selection", "group": "Desk", "position": 0, "options": { "choices": [ { "label": { "eng-GB": "Black" }, "value": "black" }, { "label": { "eng-GB": "White" }, "value": "white" } ] }, "value": null } }, { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": false, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "width", "name": "Width", "description": "", "type": "Measurement (single)", "type_identifier": "measurement_single", "group": "Desk", "position": 0, "options": { "sign": "none", "type": "length", "unit": "centimeter", "defaultValue": null }, "value": null } } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/66", "_remoteId": "1e7449c13671b56ed3907929a2af3ad9", "_id": 66, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/53" }, "Name": "Ergo Office Desk", "TranslatedName": "Ergo Office Desk", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/66/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/versions/2", "VersionInfo": { "id": 528, "versionNo": 2, "status": "PUBLISHED", "modificationDate": "2023-04-12T14:06:14+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-12T14:06:14+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Ergo Office Desk" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/66" } }, "Fields": { "field": [ { "id": 295, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Ergo Office Desk" }, { "id": 296, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 3, "code": "ERGO", "attributes": [ "black", [] ] } }, { "id": 297, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 298, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } }, { "id": 299, "fieldDefinitionIdentifier": "category", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", "fieldValue": { "taxonomy_entries": [], "taxonomy": "product_categories" } }, { "id": 300, "fieldDefinitionIdentifier": "field_64369cb9130a7", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_seo", "fieldValue": "" } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/66/versions/2/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/66/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-12T14:06:14+00:00", "publishedDate": "2023-04-12T11:58:00+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 2, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/66/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1681308374, "updated_at": 1681308374, "AttributesList": [ { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "color", "name": "Color", "description": "", "type": "Selection", "type_identifier": "selection", "group": "Desk", "position": 0, "options": { "choices": [ { "label": { "eng-GB": "Black" }, "value": "black" }, { "label": { "eng-GB": "White" }, "value": "white" } ] }, "value": "black" }, { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "width", "name": "Width", "description": "", "type": "Measurement (single)", "type_identifier": "measurement_single", "group": "Desk", "position": 0, "options": { "sign": "none", "type": "length", "unit": "centimeter", "defaultValue": null }, "value": null } ], "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "99.00", "base_amount": "99.00", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true }, "money": "9900", "base_money": "9900" } } ] }, "aggregations": [ { "_media-type": "application/vnd.ibexa.api.RangeAggregationResult+json", "name": "price", "entries": [ { "_media-type": "application/vnd.ibexa.api.RangeAggregationResultEntry+json", "key": { "Range": { "_media-type": "application/vnd.ibexa.api.Range+json", "from": 0, "to": 10000 } }, "count": 1 } ] } ] } } } }, "application/vnd.ibexa.api.ProductView+xml": { "schema": { "$ref": "#/components/schemas/ProductView" } } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "Filter products", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ProductViewController resource", "content": { "application/vnd.ibexa.api.ProductViewInput+json": { "schema": { "$ref": "#/components/schemas/ProductViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", "ProductQuery": { "limit": "10", "offset": "0", "Filter": { "ProductTypeCriterion": "desk", "ProductAvailabilityCriterion": false }, "SortClauses": { "ProductName": "descending" }, "Aggregations": [ { "ProductPriceRange": { "name": "price", "currencyCode": "EUR", "ranges": [ { "from": 0, "to": 10000 }, { "from": 10000, "to": null } ] } } ] } } } }, "application/vnd.ibexa.api.ProductViewInput+xml": { "schema": { "$ref": "#/components/schemas/ProductViewInput" } } }, "required": false }, "deprecated": false } }, "/product/catalog/products/{code}": { "get": { "operationId": "api_productcatalogproducts_code_get", "tags": [ "Product" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Product+json": { "schema": { "$ref": "#/components/schemas/ProductWrapper" }, "example": { "Product": { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "wsk_98845", "name": "HUMMINGBIRD PRO DRY 9,2MM", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "d_rope", "name": "Dynamic ropes", "AttributeAssignmentList": [] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/141", "_remoteId": "86fdab24802923a9c30994858165ba9b", "_id": 141, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/54" }, "Name": "HUMMINGBIRD PRO DRY 9,2MM", "TranslatedName": "HUMMINGBIRD PRO DRY 9,2MM", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/141/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/141/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/141/versions/2", "VersionInfo": { "id": 618, "versionNo": 2, "status": "PUBLISHED", "modificationDate": "2022-05-27T09:29:33+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2022-05-27T09:29:33+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "HUMMINGBIRD PRO DRY 9,2MM" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/141" } }, "Fields": { "field": [ { "id": 612, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "HUMMINGBIRD PRO DRY 9,2MM" }, { "id": 613, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 25, "code": "wsk_98845", "attributes": [ 10 ] } }, { "id": 614, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 615, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/141/versions/2/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/141/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2022-05-27T09:29:33+00:00", "publishedDate": "2022-05-27T06:51:36+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 2, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/141/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1645787815, "updated_at": 1645787815, "AttributesList": [] } } } } }, "401": { "description": "Error - the user is not authorized to view this product." }, "404": { "description": "Error - no product with the given code exists." } }, "summary": "Load the given product", "description": "Loads the given product.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the products are returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "An optional product schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "content": { "application/vnd.ibexa.api.ProductGet+json": { "schema": { "$ref": "#/components/schemas/ProductGetWrapper" }, "example": { "ProductGet": { "languages": [ "eng-GB" ] } } } }, "required": false }, "deprecated": false }, "patch": { "operationId": "api_productcatalogproducts_code_patch", "tags": [ "Product" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Product+json": { "schema": { "$ref": "#/components/schemas/ProductWrapper" }, "example": { "Product": { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "wsk_98845", "name": "HUMMINGBIRD PRO DRY 9,2MM", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "d_rope", "name": "Dynamic ropes", "AttributeAssignmentList": [] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/141", "_remoteId": "86fdab24802923a9c30994858165ba9b", "_id": 141, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/54" }, "Name": "HUMMINGBIRD PRO DRY 9,2MM", "TranslatedName": "HUMMINGBIRD PRO DRY 9,2MM", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/141/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/141/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/141/versions/2", "VersionInfo": { "id": 618, "versionNo": 2, "status": "PUBLISHED", "modificationDate": "2022-05-27T09:29:33+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2022-05-27T09:29:33+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "HUMMINGBIRD PRO DRY 9,2MM" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/141" } }, "Fields": { "field": [ { "id": 612, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "HUMMINGBIRD PRO DRY 9,2MM" }, { "id": 613, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 25, "code": "wsk_98845", "attributes": [ 10 ] } }, { "id": 614, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 615, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/141/versions/2/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/141/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2022-05-27T09:29:33+00:00", "publishedDate": "2022-05-27T06:51:36+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 2, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/141/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1645787815, "updated_at": 1645787815, "AttributesList": [] } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update this product." }, "403": { "description": "Error - a product with the same code already exists." }, "404": { "description": "Error - no product with the given code exists." } }, "summary": "Update product", "description": "Updates product.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated product is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "If set, the updated product is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ProductUpdateController resource", "content": { "application/vnd.ibexa.api.ProductUpdate+json": { "schema": { "$ref": "#/components/schemas/ProductUpdateWrapper" }, "example": { "ProductUpdate": { "ContentUpdate": { "__url": "/api/ibexa/v2/content/objects/67", "fields": { "field": [ { "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "IN6.1200tze205" } ] } }, "code": "NEWCODE" } } } }, "required": false }, "deprecated": false } }, "/product/catalog/products/{code}/prices": { "get": { "operationId": "api_productcatalogproducts_codeprices_get", "tags": [ "Product" ], "responses": { "200": { "description": "OK - loads the list of product prices.", "content": { "application/vnd.ibexa.api.PriceList+json": { "schema": { "$ref": "#/components/schemas/PriceListWrapper" }, "example": { "PriceList": { "_media-type": "application/vnd.ibexa.api.PriceList+json", "prices": [ { "_media-type": "application/vnd.ibexa.api.Price+json", "id": 1, "amount": "12.00", "base_amount": "12.00", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true }, "money": "1200", "base_money": "1200" }, { "_media-type": "application/vnd.ibexa.api.Price+json", "id": 2, "amount": "12.00", "base_amount": "12.00", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 5, "code": "USD", "subunits": 2, "enabled": true }, "money": "1200", "base_money": "1200" } ], "totalCount": 2 } } } } }, "401": { "description": "Error - the user has no permission to read prices." } }, "summary": "Load the list of product prices", "description": "Loads the list of product prices.", "parameters": [ { "name": "Accept", "in": "header", "description": "PriceList - if set, the product price list is returned in JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_productcatalogproducts_codeprices_post", "tags": [ "Product" ], "responses": { "200": { "description": "OK - creates product price.", "content": { "application/vnd.ibexa.api.CustomPrice+json": { "schema": { "$ref": "#/components/schemas/CustomPriceWrapper" }, "example": { "CustomPrice": { "_media-type": "application/vnd.ibexa.api.CustomPrice+json", "id": 3, "amount": "17.00", "base_amount": "35.00", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 5, "code": "USD", "subunits": 2, "enabled": true }, "money": "1700", "base_money": "3500", "custom_money": "1700", "custom_amount": "17.00", "custom_rule": null } } }, "application/vnd.ibexa.api.Price+json": { "schema": { "$ref": "#/components/schemas/PriceWrapper" }, "example": { "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "id": 4, "amount": "0.09", "base_amount": "0.09", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 94, "code": "CHF", "subunits": 2, "enabled": true }, "money": "9", "base_money": "9" } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this price." } }, "summary": "Create product price or custom price", "description": "Create product price or custom price.", "parameters": [ { "name": "Accept", "in": "header", "description": "The product price schema encoded in JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "If set, the new price is returned in JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new PriceCreateController resource", "content": { "application/vnd.ibexa.api.CustomPriceCreateStruct+json": { "schema": { "$ref": "#/components/schemas/CustomPriceCreateStructWrapper" }, "example": { "CustomPriceCreateStruct": { "customerGroup": "test", "amount": 2500, "customAmount": 1500, "currency": "EUR" } } }, "application/vnd.ibexa.api.PriceCreateStruct+json": { "schema": { "$ref": "#/components/schemas/PriceCreateStructWrapper" }, "example": { "PriceCreateStruct": { "amount": 9, "currency": "CHF" } } } }, "required": false }, "deprecated": false } }, "/product/catalog/products/{code}/prices/{currencyCode}": { "get": { "operationId": "api_productcatalogproducts_codeprices_currencyCode_get", "tags": [ "Product" ], "responses": { "200": { "description": "OK - gets price in given currency.", "content": { "application/vnd.ibexa.api.Price+json": { "schema": { "$ref": "#/components/schemas/PriceWrapper" }, "example": { "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "id": 4, "amount": "0.09", "base_amount": "0.09", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 94, "code": "CHF", "subunits": 2, "enabled": true }, "money": "9", "base_money": "9" } } } } }, "401": { "description": "Error - the user has no permission to read prices." }, "404": { "description": "Error - the price does not exist." } }, "summary": "Get price in given currency", "description": "Get price in given currency.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, gets price in given currency in JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "currencyCode", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/products/{code}/prices/{currencyCode}/customer-group/{customerGroupIdentifier}": { "get": { "operationId": "api_productcatalogproducts_codeprices_currencyCodecustomer-group_customerGroupIdentifier_get", "tags": [ "Product" ], "responses": { "200": { "description": "OK - gets price in given currency and customer group.", "content": { "application/vnd.ibexa.api.CustomPrice+json": { "schema": { "$ref": "#/components/schemas/CustomPriceWrapper" }, "example": { "CustomPrice": { "_media-type": "application/vnd.ibexa.api.CustomPrice+json", "id": 3, "amount": "17.00", "base_amount": "35.00", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 5, "code": "USD", "subunits": 2, "enabled": true }, "money": "1700", "base_money": "3500", "custom_money": "1700", "custom_amount": "17.00", "custom_rule": null } } } } }, "401": { "description": "Error - the user has no permission to read prices." }, "404": { "description": "Error - the price does not exist." } }, "summary": "Get price in given currency and customer group", "description": "Get price in given currency and customer group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, gets price in given currency and customer group in JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "currencyCode", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "customerGroupIdentifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/products/{code}/prices/{id}": { "delete": { "operationId": "api_productcatalogproducts_codeprices_id_delete", "tags": [ "Product" ], "responses": { "200": { "description": "No content - the given price is deleted." }, "401": { "description": "Error - the user is not authorized to delete this price." } }, "summary": "Delete product price", "description": "Deletes product price.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, deletes price of given id.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "Delete product price.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_productcatalogproducts_codeprices_id_patch", "tags": [ "Product" ], "responses": { "200": { "description": "OK - updates product price.", "content": { "application/vnd.ibexa.api.CustomPrice+json": { "schema": { "$ref": "#/components/schemas/CustomPriceWrapper" }, "example": { "CustomPrice": { "_media-type": "application/vnd.ibexa.api.CustomPrice+json", "id": 3, "amount": "17.00", "base_amount": "35.00", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 5, "code": "USD", "subunits": 2, "enabled": true }, "money": "1700", "base_money": "3500", "custom_money": "1700", "custom_amount": "17.00", "custom_rule": null } } }, "application/vnd.ibexa.api.Price+json": { "schema": { "$ref": "#/components/schemas/PriceWrapper" }, "example": { "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "id": 4, "amount": "0.09", "base_amount": "0.09", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 94, "code": "CHF", "subunits": 2, "enabled": true }, "money": "9", "base_money": "9" } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update this price." } }, "summary": "Update product price", "description": "Updates product price.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, updates product price.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "Update price or custom price for given currency.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated PriceUpdateController resource", "content": { "application/vnd.ibexa.api.CustomPriceUpdateStruct+json": { "schema": { "$ref": "#/components/schemas/CustomPriceUpdateStructWrapper" }, "example": { "CustomPriceUpdateStruct": { "amount": 2500, "customAmount": 1700, "currency": "USD" } } }, "application/vnd.ibexa.api.PriceUpdateStruct+json": { "schema": { "$ref": "#/components/schemas/PriceUpdateStructWrapper" }, "example": { "PriceUpdateStruct": { "amount": 3500, "currency": "USD" } } } }, "required": false }, "deprecated": false } }, "/product/catalog/products/{identifier}": { "delete": { "operationId": "api_productcatalogproducts_identifier_delete", "tags": [ "Product" ], "responses": { "204": { "description": "No content - the given product is deleted." }, "401": { "description": "Error - the user is not authorized to delete this product." } }, "summary": "Delete product", "description": "Deletes the given product.", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/products/{productTypeIdentifier}": { "post": { "operationId": "api_productcatalogproducts_productTypeIdentifier_post", "tags": [ "Product" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.ProductCreate+json": { "schema": { "$ref": "#/components/schemas/ProductWrapper" }, "example": { "Product": { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "wsk_98845", "name": "HUMMINGBIRD PRO DRY 9,2MM", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "d_rope", "name": "Dynamic ropes", "AttributeAssignmentList": [] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/141", "_remoteId": "86fdab24802923a9c30994858165ba9b", "_id": 141, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/54" }, "Name": "HUMMINGBIRD PRO DRY 9,2MM", "TranslatedName": "HUMMINGBIRD PRO DRY 9,2MM", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/141/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/141/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/141/versions/2", "VersionInfo": { "id": 618, "versionNo": 2, "status": "PUBLISHED", "modificationDate": "2022-05-27T09:29:33+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2022-05-27T09:29:33+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "HUMMINGBIRD PRO DRY 9,2MM" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/141" } }, "Fields": { "field": [ { "id": 612, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "HUMMINGBIRD PRO DRY 9,2MM" }, { "id": 613, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 25, "code": "wsk_98845", "attributes": [ 10 ] } }, { "id": 614, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 615, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/141/versions/2/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/141/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2022-05-27T09:29:33+00:00", "publishedDate": "2022-05-27T06:51:36+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 2, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/141/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1645787815, "updated_at": 1645787815, "AttributesList": [] } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update this product." }, "403": { "description": "Error - a product with the same name already exists." }, "404": { "description": "Error - no product with the given code exists." } }, "summary": "Create product", "description": "Creates a new product.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new product is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The product schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "productTypeIdentifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ProductCreateController resource", "content": { "application/vnd.ibexa.api.ProductCreate+json": { "schema": { "$ref": "#/components/schemas/ProductCreateWrapper" }, "example": { "ProductCreate": { "ContentCreate": { "ContentType": { "_href": "/api/ibexa/v2/content/types/46", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/260/fieldDefinitions", "FieldDefinition": [] } }, "LocationCreate": { "_media-type": "application/vnd.ibexa.api.LocationCreate", "ParentLocation": { "_href": "/api/ibexa/v2/content/locations/1/2" }, "priority": "0", "hidden": "false", "sortField": "PATH", "sortOrder": "ASC" }, "alwaysAvailable": "true", "fields": { "field": [ { "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "new PT" } ] }, "mainLanguageCode": "eng-GB" }, "code": "ggg", "attributes": { "attr1": "fffffff" } } } } }, "required": false }, "deprecated": false } }, "/product/catalog/attributes": { "get": { "operationId": "api_productcatalogattributes_get", "tags": [ "Product Attribute" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.AttributeList+json": { "schema": { "$ref": "#/components/schemas/AttributeListWrapper" }, "example": { "AttributeList": { "_media-type": "application/vnd.ibexa.api.AttributeList+json", "Attribute": [ { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "attrib1", "name": "Attrib1", "description": "", "type": "Checkbox", "type_identifier": "checkbox", "value": true, "group": "Attribute Group Test", "position": 0, "options": [] }, { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "attrib2", "name": "Attrib2", "description": "", "type": "Checkbox", "type_identifier": "checkbox", "value": true, "group": "Attribute Group Test", "position": 0, "options": [] }, { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "attrib3", "name": "Attrib3", "description": "", "type": "Checkbox", "type_identifier": "checkbox", "value": true, "group": "Attribute Group Test", "position": 0, "options": [] } ] } } }, "application/vnd.ibexa.api.AttributeList+xml": { "schema": { "$ref": "#/components/schemas/AttributeList" } } } }, "401": { "description": "Error - the user has no permission to read user groups." } }, "summary": "Load attributes (deprecated)", "description": "Loads list of all attributes. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attributes/view instead.", "parameters": [ { "name": "Accept", "in": "header", "description": "AttributeList - If set, the attributes list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_productcatalogattributes_post", "tags": [ "Product Attribute" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Attribute+json": { "schema": { "$ref": "#/components/schemas/AttributeWrapper" }, "example": { "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "attr_group", "name": "Attribute Group", "description": "description", "type": "Checkbox", "type_identifier": "checkbox", "value": true, "group": "Attribute Group", "position": 0, "options": [] } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this attribute." }, "403": { "description": "Error - an attribute with the same name already exists." } }, "summary": "Create attribute", "description": "Creates a new attribute.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new attribute is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The attribute schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new AttributeCreateController resource", "content": { "application/vnd.ibexa.api.AttributeCreate+json": { "schema": { "$ref": "#/components/schemas/AttributeCreateWrapper" }, "example": { "AttributeCreate": { "identifier": "foo", "type": "checkbox", "group": "attr_group_test", "names": { "eng-GB": "Attribute" }, "descriptions": { "eng-GB": "description" }, "position": 0, "options": { "foo": "bar" } } } } }, "required": false }, "deprecated": false } }, "/product/catalog/attributes/translation/{id}/{languageCode}": { "delete": { "operationId": "api_productcatalogattributestranslation_id_languageCode_delete", "tags": [ "Product Attribute" ], "responses": { "200": { "description": "No Content." }, "401": { "description": "Error - the user is not authorized to delete this translation." } }, "summary": "Delete attribute translation", "description": "The given translation is removed from the attribute.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "languageCode", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/attributes/view": { "post": { "operationId": "api_productcatalogattributesview_post", "tags": [ "Product Attribute" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.AttributeView+json": { "schema": { "$ref": "#/components/schemas/AttributeViewWrapper" }, "example": { "AttributeView": { "_media-type": "application/vnd.ibexa.api.AttributeView+json", "identifier": "TitleView", "AttributeQuery": { "_media-type": "application/vnd.ibexa.api.AttributeQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 1, "AttributeList": { "_media-type": "application/vnd.ibexa.api.AttributeList+json", "Attribute": [ { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "measure", "name": "measure", "description": "", "type": "Measurement", "type_identifier": "measurement", "group": "Test Attribute group", "position": 0, "options": { "type": "length", "unit": "centimeter", "measurementRange": { "minimum": 12, "maximum": 15 }, "measurementDefaultRange": { "defaultRangeMinimumValue": null, "defaultRangeMaximumValue": null } } } ] } } } } }, "application/vnd.ibexa.api.AttributeView+xml": { "schema": { "$ref": "#/components/schemas/AttributeView" } } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "Filter attributes", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new AttributeViewController resource", "content": { "application/vnd.ibexa.api.AttributeViewInput+json": { "schema": { "$ref": "#/components/schemas/AttributeViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", "AttributeQuery": { "limit": "10", "offset": "0", "Query": { "AttributeNameCriterion": "measure", "AttributeGroupIdentifierCriterion": "test_attribute_group" } } } } }, "application/vnd.ibexa.api.AttributeViewInput+xml": { "schema": { "$ref": "#/components/schemas/AttributeViewInput" } } }, "required": false }, "deprecated": false } }, "/product/catalog/attributes/{id}": { "get": { "operationId": "api_productcatalogattributes_id_get", "tags": [ "Product Attribute" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Attribute+json": { "schema": { "$ref": "#/components/schemas/AttributeWrapper" }, "example": { "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "attr_group", "name": "Attribute Group", "description": "description", "type": "Checkbox", "type_identifier": "checkbox", "value": true, "group": "Attribute Group", "position": 0, "options": [] } } }, "application/vnd.ibexa.api.Attribute+xml": { "schema": { "$ref": "#/components/schemas/Attribute" } } } }, "401": { "description": "Error - the user has no permission to read the attribute." } }, "summary": "Load attribute", "description": "Loads given attribute.", "parameters": [ { "name": "Accept", "in": "header", "description": "Attribute - If set, the given attribute is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_productcatalogattributes_id_delete", "tags": [ "Product Attribute" ], "responses": { "200": { "description": "No Content." }, "401": { "description": "Error - the user is not authorized to delete this attribute." } }, "summary": "Delete attribute", "description": "The given attribute is removed from the attribute group.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/attributes/{id}/{group_id}": { "patch": { "operationId": "api_productcatalogattributes_id_group_id_patch", "tags": [ "Product Attribute" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Attribute+json": { "schema": { "$ref": "#/components/schemas/AttributeWrapper" }, "example": { "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "attr_group", "name": "Attribute Group", "description": "description", "type": "Checkbox", "type_identifier": "checkbox", "value": true, "group": "Attribute Group", "position": 0, "options": [] } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this attribute." }, "403": { "description": "Error - an attribute with the same name already exists." }, "404": { "description": "Error - the attribute with the given ID does not exist." } }, "summary": "Update attribute", "description": "Updates an attribute.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated attribute is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "If set, the updated attribute group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "group_id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated AttributeUpdateController resource", "content": { "application/vnd.ibexa.api.AttributeUpdate+json": { "schema": { "$ref": "#/components/schemas/AttributeUpdateWrapper" }, "example": { "AttributeUpdate": { "identifier": "attr_group", "names": { "eng-GB": "Attribute Group" }, "descriptions": { "eng-GB": "description" }, "position": 0, "options": { "foo": "bar" } } } } }, "required": false }, "deprecated": false } }, "/product/catalog/attribute_groups": { "get": { "operationId": "api_productcatalogattribute_groups_get", "tags": [ "Product Attribute Group" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.AttributeGroupList+json": { "schema": { "$ref": "#/components/schemas/AttributeGroupListWrapper" }, "example": { "AttributeGroupList": { "_media-type": "application/vnd.ibexa.api.AttributeGroupList+json", "AttributeGroup": [ { "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", "name": "Attribute Group Test", "identifier": "attr_group_test", "position": 0 }, { "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", "name": "Dimensions", "identifier": "ag_dimensions", "position": 0 } ] } } }, "application/vnd.ibexa.api.AttributeGroupList+xml": { "schema": { "$ref": "#/components/schemas/AttributeGroupList" } } } }, "401": { "description": "Error - the user has no permission to read attribute groups." } }, "summary": "Load attribute groups (deprecated)", "description": "Returns a list of attribute groups. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attribute_groups/view instead.", "parameters": [ { "name": "Accept", "in": "header", "description": "AttributeGroupList - If set, the attribute group list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The AttributeGroupListGet schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "content": { "application/vnd.ibexa.api.AttributeGroupListGet+json": { "schema": { "$ref": "#/components/schemas/AttributeGroupListGetWrapper" }, "example": { "AttributeGroupListGet": { "prefix": "s", "offset": 0, "limit": 10 } } } }, "required": false }, "deprecated": false }, "post": { "operationId": "api_productcatalogattribute_groups_post", "tags": [ "Product Attribute Group" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.AttributeGroup+json": { "schema": { "$ref": "#/components/schemas/AttributeGroupWrapper" }, "example": { "AttributeGroup": { "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", "name": "Colors Group", "identifier": "ag_colors", "position": 0 } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this attribute group." }, "403": { "description": "Error - an attribute group with the same identifier already exists." } }, "summary": "Create attribute group", "description": "Creates a new attribute group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new attribute group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The AttributeGroup schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new AttributeGroupCreateController resource", "content": { "application/vnd.ibexa.api.AttributeGroupCreate+json": { "schema": { "$ref": "#/components/schemas/AttributeGroupCreateWrapper" }, "example": { "AttributeGroupCreate": { "identifier": "attr_group_test", "names": { "eng-GB": "Attribute Group Test" }, "position": 0 } } } }, "required": false }, "deprecated": false } }, "/product/catalog/attribute_groups/translation/{id}/{languageCode}": { "delete": { "operationId": "api_productcatalogattribute_groupstranslation_id_languageCode_delete", "tags": [ "Product Attribute Group" ], "responses": { "200": { "description": "No content - the given attribute group translation is deleted." }, "401": { "description": "Error - the user is not authorized to delete this attribute group translation assignment." } }, "summary": "Delete attribute group translation", "description": "Deletes given translation from attribute group.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "languageCode", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/attribute_groups/view": { "post": { "operationId": "api_productcatalogattribute_groupsview_post", "tags": [ "Product Attribute Group" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.AttributeGroupView+json": { "schema": { "$ref": "#/components/schemas/AttributeGroupViewWrapper" }, "example": { "AttributeGroupView": { "_media-type": "application/vnd.ibexa.api.AttributeGroupView+json", "identifier": "TitleView", "AttributeGroupQuery": { "_media-type": "application/vnd.ibexa.api.AttributeGroupQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 1, "AttributeGroupList": { "_media-type": "application/vnd.ibexa.api.AttributeGroupList+json", "AttributeGroup": [ { "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", "name": "Test Attribute group", "identifier": "test_attribute_group", "position": 0 } ] } } } } }, "application/vnd.ibexa.api.AttributeGroupView+xml": { "schema": { "$ref": "#/components/schemas/AttributeGroupView" } } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "Filter attribute groups", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new AttributeGroupViewController resource", "content": { "application/vnd.ibexa.api.AttributeGroupViewInput+json": { "schema": { "$ref": "#/components/schemas/AttributeGroupViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", "AttributeGroupQuery": { "limit": "10", "offset": "0", "name_prefix": "test" } } } }, "application/vnd.ibexa.api.AttributeGroupViewInput+xml": { "schema": { "$ref": "#/components/schemas/AttributeGroupViewInput" } } }, "required": false }, "deprecated": false } }, "/product/catalog/attribute_groups/{id}": { "get": { "operationId": "api_productcatalogattribute_groups_id_get", "tags": [ "Product Attribute Group" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.AttributeGroup+json": { "schema": { "$ref": "#/components/schemas/AttributeGroupWrapper" }, "example": { "AttributeGroup": { "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", "name": "Colors Group", "identifier": "ag_colors", "position": 0 } } }, "application/vnd.ibexa.api.AttributeGroup+xml": { "schema": { "$ref": "#/components/schemas/AttributeGroup" } } } }, "401": { "description": "Error - the user has no permission to read attribute groups." } }, "summary": "Load attribute group", "description": "Returns the given attribute group.", "parameters": [ { "name": "Accept", "in": "header", "description": "AttributeGroupGet - If set, the attribute group List is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "An optional AttributeGroupGet schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "content": { "application/vnd.ibexa.api.AttributeGroupGet+json": { "schema": { "$ref": "#/components/schemas/AttributeGroupGetWrapper" }, "example": { "AttributeGroupGet": { "languages": [ "eng-GB" ] } } }, "application/vnd.ibexa.api.AttributeGroupGet+xml": { "schema": { "$ref": "#/components/schemas/AttributeGroupGet" } } }, "required": false }, "deprecated": false }, "delete": { "operationId": "api_productcatalogattribute_groups_id_delete", "tags": [ "Product Attribute Group" ], "responses": { "204": { "description": "No content - the given attribute group is deleted." }, "401": { "description": "Error - the user is not authorized to delete this attribute group." } }, "summary": "Delete attribute group", "description": "Deletes an attribute group.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_productcatalogattribute_groups_id_patch", "tags": [ "Product Attribute Group" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.AttributeGroup+json": { "schema": { "$ref": "#/components/schemas/AttributeGroupWrapper" }, "example": { "AttributeGroup": { "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", "name": "Colors Group", "identifier": "ag_colors", "position": 0 } } }, "application/vnd.ibexa.api.AttributeGroup+xml": { "schema": { "$ref": "#/components/schemas/AttributeGroup" } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this attribute group." }, "403": { "description": "Error - an attribute group with the same identifier already exists." }, "404": { "description": "Error - the group with the given ID does not exist." } }, "summary": "Update attribute group", "description": "Updates an attribute group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated attribute group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The attribute group update schema is sent in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated AttributeGroupUpdateController resource", "content": { "application/vnd.ibexa.api.AttributeGroupUpdate+json": { "schema": { "$ref": "#/components/schemas/AttributeGroupUpdateWrapper" }, "example": { "AttributeGroupUpdate": { "identifier": "ag_colors", "names": { "eng-GB": "Colors Group" }, "position": 0 } } }, "application/vnd.ibexa.api.AttributeGroupUpdate+xml": { "schema": { "$ref": "#/components/schemas/AttributeGroupUpdate" } } }, "required": false }, "deprecated": false } }, "/product/catalog/attribute_types": { "get": { "operationId": "api_productcatalogattribute_types_get", "tags": [ "Product Attribute Type" ], "responses": { "200": { "description": "OK - returns a list of Attribute Types", "content": { "application/vnd.ibexa.api.AttributeTypeList+json": { "schema": { "$ref": "#/components/schemas/AttributeTypeListWrapper" } }, "application/vnd.ibexa.api.AttributeTypeList+xml": { "schema": { "$ref": "#/components/schemas/AttributeTypeList" } } } } }, "summary": "List Attribute Types", "description": "Lists all Attribute Types.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/attribute_types/{identifier}": { "get": { "operationId": "api_productcatalogattribute_types_identifier_get", "tags": [ "Product Attribute Type" ], "responses": { "200": { "description": "OK - returns the Attribute Type", "content": { "application/vnd.ibexa.api.AttributeType+json": { "schema": { "$ref": "#/components/schemas/AttributeTypeWrapper" } }, "application/vnd.ibexa.api.AttributeType+xml": { "schema": { "$ref": "#/components/schemas/AttributeType" } } } }, "404": { "description": "Error - The Attribute Type does not exist." } }, "summary": "Get Attribute Type", "description": "Gets an Attribute Type by its identifier.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Attribute Type is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/catalogs": { "post": { "operationId": "api_productcatalogcatalogs_post", "tags": [ "Product Catalog" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.CatalogCreate+json": { "schema": { "$ref": "#/components/schemas/CatalogWrapper" }, "example": { "Catalog": { "_media-type": "application/vnd.ibexa.api.Catalog+json", "identifier": "test_catalog_copied", "name": "Snow Equipment updated", "description": "Snow Equipment catalog for 2022", "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "created": 1666091820, "modified": 1666091820, "status": "draft", "Criteria": [ { "_media-type": "application/vnd.ibexa.api.ProductCode+json", "ProductCodeCriterion": { "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json", "codes": [ "ski" ] } }, { "_media-type": "application/vnd.ibexa.api.ProductAvailability+json", "ProductAvailabilityCriterion": { "_media-type": "application/vnd.ibexa.api.ProductAvailabilityCriterion+json", "is_available": false } }, { "_media-type": "application/vnd.ibexa.api.CreatedAt+json", "CreatedAtCriterion": { "_media-type": "application/vnd.ibexa.api.CreatedAtCriterion+json", "created_at": { "date": "2022-12-12 00:00:00.000000", "timezone_type": 3, "timezone": "Europe/Warsaw" }, "operator": ">=" } } ] } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update this catalog." }, "403": { "description": "Error - a catalog with the same name already exists." }, "404": { "description": "Error - no catalog with the given code exists." } }, "summary": "Create catalog", "description": "Creates a new catalog.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new catalog is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The catalog schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CatalogCreateController resource", "content": { "application/vnd.ibexa.api.CatalogCreate+json": { "schema": { "$ref": "#/components/schemas/CatalogCreateWrapper" }, "example": { "CatalogCreate": { "identifier": "test_catalog", "criteria": { "ProductCodeCriterion": [ "ski", "snowboard" ], "ProductAvailabilityCriterion": true, "ColorAttributeCriterion": { "identifier": "color", "value": [ "#000000", "#FFFFFF" ] }, "CreatedAtCriterion": { "operator": ">=", "created_at": "12-09-2022" }, "FloatAttributeCriterion": { "identifier": "width", "value": 16.6 }, "IntegerAttributeRangeCriterion": { "identifier": "length", "min": 180, "max": 230 } }, "names": { "eng-GB": "Snow Equipment" }, "status": "draft" } } } }, "required": false }, "deprecated": false } }, "/product/catalog/catalogs/copy/{identifier}": { "post": { "operationId": "api_productcatalogcatalogscopy_identifier_post", "tags": [ "Product Catalog" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Catalog+json": { "schema": { "$ref": "#/components/schemas/CatalogWrapper" }, "example": { "Catalog": { "_media-type": "application/vnd.ibexa.api.Catalog+json", "identifier": "test_catalog_copied", "name": "Snow Equipment updated", "description": "Snow Equipment catalog for 2022", "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "created": 1666091820, "modified": 1666091820, "status": "draft", "Criteria": [ { "_media-type": "application/vnd.ibexa.api.ProductCode+json", "ProductCodeCriterion": { "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json", "codes": [ "ski" ] } }, { "_media-type": "application/vnd.ibexa.api.ProductAvailability+json", "ProductAvailabilityCriterion": { "_media-type": "application/vnd.ibexa.api.ProductAvailabilityCriterion+json", "is_available": false } }, { "_media-type": "application/vnd.ibexa.api.CreatedAt+json", "CreatedAtCriterion": { "_media-type": "application/vnd.ibexa.api.CreatedAtCriterion+json", "created_at": { "date": "2022-12-12 00:00:00.000000", "timezone_type": 3, "timezone": "Europe/Warsaw" }, "operator": ">=" } } ] } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to copy this catalog." }, "403": { "description": "Error - a catalog with the same identifier already exists." }, "404": { "description": "Error - no catalog with the given identifier exists." } }, "summary": "Copy catalog", "description": "Copies a catalog.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the copied catalog is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "If set, the copied catalog is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CatalogCopyController resource", "content": { "application/vnd.ibexa.api.CatalogCopy+json": { "schema": { "$ref": "#/components/schemas/CatalogCopyWrapper" }, "example": { "CatalogCopy": { "identifier": "test_catalog_copied", "creator_id": 14 } } } }, "required": false }, "deprecated": false } }, "/product/catalog/catalogs/filters": { "get": { "operationId": "api_productcatalogcatalogsfilters_get", "tags": [ "Product Catalog" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ProductFilterList+json": { "schema": { "$ref": "#/components/schemas/ProductFilterListWrapper" }, "example": { "ProductFilterList": { "_media-type": "application/vnd.ibexa.api.ProductFilterList+json", "ProductFilter": [ { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "CreatedAtCriterion" }, { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "CreatedAtRangeCriterion" }, { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "ProductCategoryCriterion" }, { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "ColorAttributeCriterion" }, { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "FloatAttributeCriterion" }, { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "FloatAttributeRangeCriterion" }, { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "IntegerAttributeCriterion" }, { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "IntegerAttributeRangeCriterion" }, { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "SelectionAttributeCriterion" }, { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "ProductCodeCriterion" }, { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "ProductNameCriterion" }, { "_media-type": "application/vnd.ibexa.api.ProductFilter+json", "name": "ProductAvailabilityCriterion" } ] } } }, "application/vnd.ibexa.api.ProductFilterList+xml": { "schema": { "$ref": "#/components/schemas/ProductFilterList" } } } } }, "summary": "Load catalog filters", "description": "Loads product filters available for catalogs.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the filters are returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/catalogs/sort_clauses": { "get": { "operationId": "api_productcatalogcatalogssort_clauses_get", "tags": [ "Product Catalog" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ProductSortClauseList+json": { "schema": { "$ref": "#/components/schemas/ProductSortClauseListWrapper" }, "example": { "ProductSortClauseList": { "_media-type": "application/vnd.ibexa.api.ProductSortClauseList+json", "ProductSortClause": [ { "_media-type": "application/vnd.ibexa.api.ProductSortClause+json", "name": "ProductName" }, { "_media-type": "application/vnd.ibexa.api.ProductSortClause+json", "name": "ProductCode" }, { "_media-type": "application/vnd.ibexa.api.ProductSortClause+json", "name": "ProductAvailability" }, { "_media-type": "application/vnd.ibexa.api.ProductSortClause+json", "name": "CreatedAt" } ] } } }, "application/vnd.ibexa.api.ProductSortClauseList+xml": { "schema": { "$ref": "#/components/schemas/ProductSortClauseList" } } } } }, "summary": "Load catalog sort clauses", "description": "Loads product sort clauses available for catalogs.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the clauses are returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/catalogs/view": { "post": { "operationId": "api_productcatalogcatalogsview_post", "tags": [ "Product Catalog" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.CatalogView+json": { "schema": { "$ref": "#/components/schemas/CatalogViewWrapper" }, "example": { "CatalogView": { "_media-type": "application/vnd.ibexa.api.CatalogView+json", "identifier": "TitleView", "CatalogQuery": { "_media-type": "application/vnd.ibexa.api.CatalogQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 1, "CatalogList": { "_media-type": "application/vnd.ibexa.api.CatalogList+json", "Catalog": [ { "_media-type": "application/vnd.ibexa.api.Catalog+json", "identifier": "test", "name": "test", "description": "", "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "created": 1665479475, "modified": 1665479475, "status": "draft", "Criteria": [ { "_media-type": "application/vnd.ibexa.api.ProductCode+json", "ProductCodeCriterion": { "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json", "codes": [ "test" ] } } ] } ] } } } } }, "application/vnd.ibexa.api.CatalogView+xml": { "schema": { "$ref": "#/components/schemas/CatalogView" } } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "Filter catalogs", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CatalogViewController resource", "content": { "application/vnd.ibexa.api.CatalogViewInput+json": { "schema": { "$ref": "#/components/schemas/CatalogViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", "CatalogQuery": { "Query": { "CatalogIdentifierCriterion": "test", "CatalogNameCriterion": "test" } } } } }, "application/vnd.ibexa.api.CatalogViewInput+xml": { "schema": { "$ref": "#/components/schemas/CatalogViewInput" } } }, "required": false }, "deprecated": false } }, "/product/catalog/catalogs/{identifier}": { "get": { "operationId": "api_productcatalogcatalogs_identifier_get", "tags": [ "Product Catalog" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Catalog+json": { "schema": { "$ref": "#/components/schemas/CatalogWrapper" }, "example": { "Catalog": { "_media-type": "application/vnd.ibexa.api.Catalog+json", "identifier": "test_catalog_copied", "name": "Snow Equipment updated", "description": "Snow Equipment catalog for 2022", "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "created": 1666091820, "modified": 1666091820, "status": "draft", "Criteria": [ { "_media-type": "application/vnd.ibexa.api.ProductCode+json", "ProductCodeCriterion": { "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json", "codes": [ "ski" ] } }, { "_media-type": "application/vnd.ibexa.api.ProductAvailability+json", "ProductAvailabilityCriterion": { "_media-type": "application/vnd.ibexa.api.ProductAvailabilityCriterion+json", "is_available": false } }, { "_media-type": "application/vnd.ibexa.api.CreatedAt+json", "CreatedAtCriterion": { "_media-type": "application/vnd.ibexa.api.CreatedAtCriterion+json", "created_at": { "date": "2022-12-12 00:00:00.000000", "timezone_type": 3, "timezone": "Europe/Warsaw" }, "operator": ">=" } } ] } } }, "application/vnd.ibexa.api.Catalog+xml": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "401": { "description": "Error - the user is not authorized to view this catalog." }, "404": { "description": "Error - no catalog with the given identifier exists." } }, "summary": "Load catalog", "description": "Loads the given catalog.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the catalog is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_productcatalogcatalogs_identifier_delete", "tags": [ "Product Catalog" ], "responses": { "204": { "description": "No content - the given catalog is deleted." }, "401": { "description": "Error - the user is not authorized to delete this catalog." } }, "summary": "Delete catalog", "description": "Deletes the given catalog.", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_productcatalogcatalogs_identifier_patch", "tags": [ "Product Catalog" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Catalog+json": { "schema": { "$ref": "#/components/schemas/CatalogWrapper" }, "example": { "Catalog": { "_media-type": "application/vnd.ibexa.api.Catalog+json", "identifier": "test_catalog_copied", "name": "Snow Equipment updated", "description": "Snow Equipment catalog for 2022", "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "created": 1666091820, "modified": 1666091820, "status": "draft", "Criteria": [ { "_media-type": "application/vnd.ibexa.api.ProductCode+json", "ProductCodeCriterion": { "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json", "codes": [ "ski" ] } }, { "_media-type": "application/vnd.ibexa.api.ProductAvailability+json", "ProductAvailabilityCriterion": { "_media-type": "application/vnd.ibexa.api.ProductAvailabilityCriterion+json", "is_available": false } }, { "_media-type": "application/vnd.ibexa.api.CreatedAt+json", "CreatedAtCriterion": { "_media-type": "application/vnd.ibexa.api.CreatedAtCriterion+json", "created_at": { "date": "2022-12-12 00:00:00.000000", "timezone_type": 3, "timezone": "Europe/Warsaw" }, "operator": ">=" } } ] } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update this catalog." }, "403": { "description": "Error - a catalog with the same identifier already exists." }, "404": { "description": "Error - no catalog with the given identifier exists." } }, "summary": "Update catalog", "description": "Updates a catalog.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated catalog is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "If set, the updated catalog is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated CatalogUpdateController resource", "content": { "application/vnd.ibexa.api.CatalogUpdate+json": { "schema": { "$ref": "#/components/schemas/CatalogUpdateWrapper" }, "example": { "CatalogUpdate": { "identifier": "test_catalog_updated", "criteria": { "ProductCodeCriterion": [ "ski" ], "ProductAvailabilityCriterion": false, "CreatedAtCriterion": { "operator": ">=", "created_at": "12-12-2022" } }, "names": { "eng-GB": "Snow Equipment updated" }, "descriptions": { "eng-GB": "Snow Equipment catalog for 2022" }, "transition": "publish" } } } }, "required": false }, "deprecated": false } }, "/product/catalog/catalogs/{identifier}/products/view": { "post": { "operationId": "api_productcatalogcatalogs_identifierproductsview_post", "tags": [ "Product Catalog" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ProductView+json": { "schema": { "$ref": "#/components/schemas/ProductViewWrapper" }, "example": { "ProductView": { "_media-type": "application/vnd.ibexa.api.ProductView+json", "identifier": "TitleView", "ProductQuery": { "_media-type": "application/vnd.ibexa.api.ProductQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 2, "ProductList": { "_media-type": "application/vnd.ibexa.api.ProductList+json", "Product": [ { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "OTHER", "isBaseProduct": false, "isVariant": false, "name": "Other Office Desk", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "desk", "name": "Desk", "AttributeAssignmentList": [ { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": false, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "color", "name": "Color", "description": "", "type": "Selection", "type_identifier": "selection", "group": "Desk", "position": 0, "options": { "choices": [ { "label": { "eng-GB": "Black" }, "value": "black" }, { "label": { "eng-GB": "White" }, "value": "white" } ] }, "value": null } }, { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": false, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "width", "name": "Width", "description": "", "type": "Measurement (single)", "type_identifier": "measurement_single", "group": "Desk", "position": 0, "options": { "sign": "none", "type": "length", "unit": "centimeter", "defaultValue": null }, "value": null } } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/67", "_remoteId": "c5c22c68912af81992b74851f158db4a", "_id": 67, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/53" }, "Name": "Other Office Desk", "TranslatedName": "Other Office Desk", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/67/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/67/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/67/versions/2", "VersionInfo": { "id": 529, "versionNo": 2, "status": "PUBLISHED", "modificationDate": "2023-04-12T14:06:25+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-12T14:06:25+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Other Office Desk" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/67" } }, "Fields": { "field": [ { "id": 301, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Other Office Desk" }, { "id": 302, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 4, "code": "OTHER", "attributes": [ "white", [] ] } }, { "id": 303, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 304, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } }, { "id": 305, "fieldDefinitionIdentifier": "category", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", "fieldValue": { "taxonomy_entries": [], "taxonomy": "product_categories" } }, { "id": 306, "fieldDefinitionIdentifier": "field_64369cb9130a7", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_seo", "fieldValue": "" } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/67/versions/2/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/67/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-12T14:06:25+00:00", "publishedDate": "2023-04-12T11:59:17+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 2, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/67/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1681308385, "updated_at": 1681308385, "AttributesList": [ { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "color", "name": "Color", "description": "", "type": "Selection", "type_identifier": "selection", "group": "Desk", "position": 0, "options": { "choices": [ { "label": { "eng-GB": "Black" }, "value": "black" }, { "label": { "eng-GB": "White" }, "value": "white" } ] }, "value": "white" }, { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "width", "name": "Width", "description": "", "type": "Measurement (single)", "type_identifier": "measurement_single", "group": "Desk", "position": 0, "options": { "sign": "none", "type": "length", "unit": "centimeter", "defaultValue": null }, "value": null } ], "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "160.00", "base_amount": "160.00", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true }, "money": "16000", "base_money": "16000" } }, { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "ERGO", "isBaseProduct": false, "isVariant": false, "name": "Ergo Office Desk", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "desk", "name": "Desk", "AttributeAssignmentList": [ { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": false, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "color", "name": "Color", "description": "", "type": "Selection", "type_identifier": "selection", "group": "Desk", "position": 0, "options": { "choices": [ { "label": { "eng-GB": "Black" }, "value": "black" }, { "label": { "eng-GB": "White" }, "value": "white" } ] }, "value": null } }, { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": false, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "width", "name": "Width", "description": "", "type": "Measurement (single)", "type_identifier": "measurement_single", "group": "Desk", "position": 0, "options": { "sign": "none", "type": "length", "unit": "centimeter", "defaultValue": null }, "value": null } } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/66", "_remoteId": "1e7449c13671b56ed3907929a2af3ad9", "_id": 66, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/53" }, "Name": "Ergo Office Desk", "TranslatedName": "Ergo Office Desk", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/66/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/66/versions/2", "VersionInfo": { "id": 528, "versionNo": 2, "status": "PUBLISHED", "modificationDate": "2023-04-12T14:06:14+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2023-04-12T14:06:14+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Ergo Office Desk" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/66" } }, "Fields": { "field": [ { "id": 295, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Ergo Office Desk" }, { "id": 296, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 3, "code": "ERGO", "attributes": [ "black", [] ] } }, { "id": 297, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" } }, { "id": 298, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } }, { "id": 299, "fieldDefinitionIdentifier": "category", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", "fieldValue": { "taxonomy_entries": [], "taxonomy": "product_categories" } }, { "id": 300, "fieldDefinitionIdentifier": "field_64369cb9130a7", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_seo", "fieldValue": "" } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/66/versions/2/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/66/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-04-12T14:06:14+00:00", "publishedDate": "2023-04-12T11:58:00+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 2, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/66/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/placeholder", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1681308374, "updated_at": 1681308374, "AttributesList": [ { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "color", "name": "Color", "description": "", "type": "Selection", "type_identifier": "selection", "group": "Desk", "position": 0, "options": { "choices": [ { "label": { "eng-GB": "Black" }, "value": "black" }, { "label": { "eng-GB": "White" }, "value": "white" } ] }, "value": "black" }, { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "width", "name": "Width", "description": "", "type": "Measurement (single)", "type_identifier": "measurement_single", "group": "Desk", "position": 0, "options": { "sign": "none", "type": "length", "unit": "centimeter", "defaultValue": null }, "value": null } ], "Price": { "_media-type": "application/vnd.ibexa.api.Price+json", "amount": "99.00", "base_amount": "99.00", "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": true }, "money": "9900", "base_money": "9900" } } ] }, "aggregations": [ { "_media-type": "application/vnd.ibexa.api.RangeAggregationResult+json", "name": "price", "entries": [ { "_media-type": "application/vnd.ibexa.api.RangeAggregationResultEntry+json", "key": { "Range": { "_media-type": "application/vnd.ibexa.api.Range+json", "from": 0, "to": 10000 } }, "count": 1 } ] } ] } } } }, "application/vnd.ibexa.api.ProductView+xml": { "schema": { "$ref": "#/components/schemas/ProductView" } } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "Filter catalog products", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CatalogProductsViewController resource", "content": { "application/vnd.ibexa.api.ProductViewInput+json": { "schema": { "$ref": "#/components/schemas/ProductViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", "ProductQuery": { "Query": { "ProductCodeCriterion": "test", "ProductAvailabilityCriterion": true } } } } }, "application/vnd.ibexa.api.ProductViewInput+xml": { "schema": { "$ref": "#/components/schemas/ProductViewInput" } } }, "required": false }, "deprecated": false } }, "/product/catalog/currencies": { "get": { "operationId": "api_productcatalogcurrencies_get", "tags": [ "Product Currency" ], "responses": { "200": { "description": "OK - loads currencies.", "content": { "application/vnd.ibexa.api.CurrencyList+json": { "schema": { "$ref": "#/components/schemas/CurrencyListWrapper" }, "example": { "CurrencyList": { "_media-type": "application/vnd.ibexa.api.CurrencyList+json", "Currency": [ { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 1, "code": "AFN", "subunits": 1, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 3, "code": "ALL", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 4, "code": "DZD", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 5, "code": "USD", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 6, "code": "AOA", "subunits": 2, "enabled": false } ] } } } } }, "401": { "description": "Error - the user has no permission to read currencies." } }, "summary": "Load currencies", "description": "Loads the list of currencies.", "parameters": [ { "name": "Accept", "in": "header", "description": "CurrencyList - If set, the currency list returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_productcatalogcurrencies_post", "tags": [ "Product Currency" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Currency+json": { "schema": { "$ref": "#/components/schemas/CurrencyWrapper" }, "example": { "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 1, "code": "AFN", "subunits": 1, "enabled": false } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this currency." }, "406": { "description": "Error - a currency with this code already exists." } }, "summary": "Create currency", "description": "Creates a new currency.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new currency is returned in JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Currency schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CurrencyCreateController resource", "content": { "application/vnd.ibexa.api.CurrencyCreate+json": { "schema": { "$ref": "#/components/schemas/CurrencyCreateWrapper" }, "example": { "CurrencyCreate": { "code": "cur", "subunits": 1, "enabled": true } } } }, "required": false }, "deprecated": false } }, "/product/catalog/currencies/view": { "post": { "operationId": "api_productcatalogcurrenciesview_post", "tags": [ "Product Currency" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.CurrencyView+json": { "schema": { "$ref": "#/components/schemas/CurrencyViewWrapper" }, "example": { "CurrencyView": { "_media-type": "application/vnd.ibexa.api.CurrencyView+json", "identifier": "TitleView", "CurrencyQuery": { "_media-type": "application/vnd.ibexa.api.CurrencyQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 179, "CurrencyList": { "_media-type": "application/vnd.ibexa.api.CurrencyList+json", "Currency": [ { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 1, "code": "AFN", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 2, "code": "EUR", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 3, "code": "ALL", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 4, "code": "DZD", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 5, "code": "USD", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 6, "code": "AOA", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 7, "code": "XCD", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 8, "code": "ARS", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 9, "code": "AMD", "subunits": 2, "enabled": false }, { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 10, "code": "AWG", "subunits": 2, "enabled": false } ] } } } } }, "application/vnd.ibexa.api.CurrencyView+xml": { "schema": { "$ref": "#/components/schemas/CurrencyView" } } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "Filter currencies", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CurrencyViewController resource", "content": { "application/vnd.ibexa.api.CurrencyViewInput+json": { "schema": { "$ref": "#/components/schemas/CurrencyViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", "CurrencyQuery": { "limit": "10", "offset": "0" } } } }, "application/vnd.ibexa.api.CurrencyViewInput+xml": { "schema": { "$ref": "#/components/schemas/CurrencyViewInput" } } }, "required": false }, "deprecated": false } }, "/product/catalog/currencies/{id}": { "get": { "operationId": "api_productcatalogcurrencies_id_get", "tags": [ "Product Currency" ], "responses": { "200": { "description": "OK - loads the currency.", "content": { "application/vnd.ibexa.api.Currency+json": { "schema": { "$ref": "#/components/schemas/CurrencyWrapper" }, "example": { "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 1, "code": "AFN", "subunits": 1, "enabled": false } } } } }, "401": { "description": "Error - the user has no permission to read currencies." }, "404": { "description": "Error - the currency does not exist." } }, "summary": "Load currency", "description": "Loads a currency.", "parameters": [ { "name": "Accept", "in": "header", "description": "Currency - If set, the currency returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_productcatalogcurrencies_id_delete", "tags": [ "Product Currency" ], "responses": { "200": { "description": "No content - the given currency is deleted." }, "401": { "description": "Error - the user is not authorized to delete this currency." } }, "summary": "Delete currency", "description": "Deletes the given currency.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_productcatalogcurrencies_id_patch", "tags": [ "Product Currency" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Currency+json": { "schema": { "$ref": "#/components/schemas/CurrencyWrapper" }, "example": { "Currency": { "_media-type": "application/vnd.ibexa.api.Currency+json", "id": 1, "code": "AFN", "subunits": 1, "enabled": false } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this User." }, "403": { "description": "Error - a currency with the same ID already exists." }, "404": { "description": "Error - the currency with the given ID does not exist." } }, "summary": "Update currency", "description": "Updates a currency.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated currency is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The CurrencyUpdate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated CurrencyUpdateController resource", "content": { "application/vnd.ibexa.api.CurrencyUpdate+json": { "schema": { "$ref": "#/components/schemas/CurrencyUpdateWrapper" }, "example": { "CurrencyUpdate": { "subunits": 1, "enabled": false } } } }, "required": false }, "deprecated": false } }, "/product/catalog/customer_groups": { "get": { "operationId": "api_productcatalogcustomer_groups_get", "tags": [ "Product Customer Group" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.CustomerGroupList+json": { "schema": { "$ref": "#/components/schemas/CustomerGroupListWrapper" }, "example": { "CustomerGroupList": { "_media-type": "application/vnd.ibexa.api.CustomerGroupList+json", "CustomerGroup": [ { "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", "id": 1, "name": "Resellers", "identifier": "resellers", "description": "", "users": [], "global_price_rate": "0.00" }, { "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", "id": 2, "name": "Contractors", "identifier": "contractors", "description": "", "users": [], "global_price_rate": "-20.00" } ] } } } } }, "401": { "description": "Error - the user has no permission to read customer groups." } }, "summary": "Load customer groups", "description": "Returns a list of customer groups", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the customer groups list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_productcatalogcustomer_groups_post", "tags": [ "Product Customer Group" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.CustomerGroup+json": { "schema": { "$ref": "#/components/schemas/CustomerGroupWrapper" }, "example": { "CustomerGroup": { "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", "id": 1, "name": "Customer Group", "identifier": "customer_group", "description": "", "users": [], "global_price_rate": "1.00" } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this Customer Group." }, "403": { "description": "Error - a customer group with the same name already exists." } }, "summary": "Create customer group", "description": "Creates a new customer group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new customer group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The CustomerGroupCreate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CustomerGroupCreateController resource", "content": { "application/vnd.ibexa.api.CustomerGroupCreate+json": { "schema": { "$ref": "#/components/schemas/CustomerGroupCreateWrapper" }, "example": { "CustomerGroupCreate": { "identifier": "customer_group", "names": { "eng-GB": "Customer Group" }, "descriptions": { "eng-GB": "Customer Group description" }, "global_price_rate": "1" } } } }, "required": false }, "deprecated": false } }, "/product/catalog/customer_groups/view": { "post": { "operationId": "api_productcatalogcustomer_groupsview_post", "tags": [ "Product Customer Group" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.CustomerGroupView+json": { "schema": { "$ref": "#/components/schemas/CustomerGroupViewWrapper" }, "example": { "CustomerGroupView": { "_media-type": "application/vnd.ibexa.api.CustomerGroupView+json", "identifier": "TitleView", "CustomerGroupQuery": { "_media-type": "application/vnd.ibexa.api.CustomerGroupQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 1, "CustomerGroupList": { "_media-type": "application/vnd.ibexa.api.CustomerGroupList+json", "CustomerGroup": [ { "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", "id": 1, "name": "Business", "identifier": "business", "description": "Most trusted business customers, being our partners for at least 5 years.", "users": [], "global_price_rate": "15.00" } ] } } } } }, "application/vnd.ibexa.api.CustomerGroupView+xml": { "schema": { "$ref": "#/components/schemas/CustomerGroupView" } } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "Filter customer groups", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new CustomerGroupViewController resource", "content": { "application/vnd.ibexa.api.CustomerGroupViewInput+json": { "schema": { "$ref": "#/components/schemas/CustomerGroupViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", "CustomerGroupQuery": { "limit": "10", "offset": "0" } } } }, "application/vnd.ibexa.api.CustomerGroupViewInput+xml": { "schema": { "$ref": "#/components/schemas/CustomerGroupViewInput" } } }, "required": false }, "deprecated": false } }, "/product/catalog/customer_groups/{identifier}": { "get": { "operationId": "api_productcatalogcustomer_groups_identifier_get", "tags": [ "Product Customer Group" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.CustomerGroup+json": { "schema": { "$ref": "#/components/schemas/CustomerGroupWrapper" }, "example": { "CustomerGroup": { "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", "id": 1, "name": "Customer Group", "identifier": "customer_group", "description": "", "users": [], "global_price_rate": "1.00" } } } } }, "401": { "description": "Error - the user has no permission to read customer groups." } }, "summary": "Load customer group", "description": "Returns a customer group", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the customer group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_productcatalogcustomer_groups_identifier_delete", "tags": [ "Product Customer Group" ], "responses": { "204": { "description": "No content - the given customer group is deleted." }, "401": { "description": "Error - the user is not authorized to delete this customer group." } }, "summary": "Delete customer group", "description": "Deletes the given customer group.", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_productcatalogcustomer_groups_identifier_patch", "tags": [ "Product Customer Group" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.CustomerGroup+json": { "schema": { "$ref": "#/components/schemas/CustomerGroupWrapper" }, "example": { "CustomerGroup": { "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", "id": 1, "name": "Customer Group", "identifier": "customer_group", "description": "", "users": [], "global_price_rate": "1.00" } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update a customer group." } }, "summary": "Update customer group", "description": "Updates the given customer group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated customer group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The CustomerGroupUpdate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated CustomerGroupUpdateController resource", "content": { "application/vnd.ibexa.api.CustomerGroupUpdate+json": { "schema": { "$ref": "#/components/schemas/CustomerGroupUpdateWrapper" }, "example": { "CustomerGroupUpdate": { "identifier": "customer_group", "names": { "eng-GB": "Customer Group" }, "global_price_rate": "1" } } } }, "required": false }, "deprecated": false } }, "/product/catalog/customer_groups/{id}": { "get": { "operationId": "api_productcatalogcustomer_groups_id_get", "tags": [ "Product Customer Group" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.CustomerGroup+json": { "schema": { "$ref": "#/components/schemas/CustomerGroupWrapper" }, "example": { "CustomerGroup": { "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", "id": 1, "name": "Customer Group", "identifier": "customer_group", "description": "", "users": [], "global_price_rate": "1.00" } } } } }, "401": { "description": "Error - the user has no permission to read customer groups." } }, "summary": "Load customer group", "description": "Returns a customer group", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the customer group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/regions": { "get": { "operationId": "api_productcatalogregions_get", "tags": [ "Product Region" ], "responses": { "200": { "description": "OK - loads regions.", "content": { "application/vnd.ibexa.api.RegionList+json": { "schema": { "$ref": "#/components/schemas/RegionListWrapper" }, "example": { "RegionList": { "_media-type": "application/vnd.ibexa.api.RegionList+json", "Region": [ { "_media-type": "application/vnd.ibexa.api.Region+json", "identifier": "france" }, { "_media-type": "application/vnd.ibexa.api.Region+json", "identifier": "__REGION_2__" }, { "_media-type": "application/vnd.ibexa.api.Region+json", "identifier": "__REGION_1__" }, { "_media-type": "application/vnd.ibexa.api.Region+json", "identifier": "foo" }, { "_media-type": "application/vnd.ibexa.api.Region+json", "identifier": "bar" } ] } } }, "application/vnd.ibexa.api.RegionList+xml": { "schema": { "$ref": "#/components/schemas/RegionList" } } } }, "401": { "description": "Error - the user has no permission to read regions." } }, "summary": "Load regions", "description": "Loads the list of regions.", "parameters": [ { "name": "Accept", "in": "header", "description": "RegionList - If set, the regions list returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/regions/view": { "post": { "operationId": "api_productcatalogregionsview_post", "tags": [ "Product Region" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.RegionView+json": { "schema": { "$ref": "#/components/schemas/RegionViewWrapper" }, "example": { "RegionView": { "_media-type": "application/vnd.ibexa.api.RegionView+json", "identifier": "TitleView", "RegionQuery": { "_media-type": "application/vnd.ibexa.api.RegionQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 2, "RegionList": { "_media-type": "application/vnd.ibexa.api.RegionList+json", "Region": [ { "_media-type": "application/vnd.ibexa.api.Region+json", "identifier": "region_1" }, { "_media-type": "application/vnd.ibexa.api.Region+json", "identifier": "region_2" } ] } } } } }, "application/vnd.ibexa.api.RegionView+xml": { "schema": { "$ref": "#/components/schemas/RegionView" } } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "Filter regions", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new RegionViewController resource", "content": { "application/vnd.ibexa.api.RegionViewInput+json": { "schema": { "$ref": "#/components/schemas/RegionViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", "RegionQuery": { "limit": "10", "offset": "0" } } } }, "application/vnd.ibexa.api.RegionViewInput+xml": { "schema": { "$ref": "#/components/schemas/RegionViewInput" } } }, "required": false }, "deprecated": false } }, "/product/catalog/regions/{identifier}": { "get": { "operationId": "api_productcatalogregions_identifier_get", "tags": [ "Product Region" ], "responses": { "200": { "description": "OK - loads region.", "content": { "application/vnd.ibexa.api.Region+json": { "schema": { "$ref": "#/components/schemas/RegionWrapper" } }, "application/vnd.ibexa.api.Region+xml": { "schema": { "$ref": "#/components/schemas/Region" } } } }, "404": { "description": "Error - the region does not exist." } }, "summary": "Load region", "description": "Loads a region by its identifier", "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/product_types": { "get": { "operationId": "api_productcatalogproduct_types_get", "tags": [ "Product Type" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ProductTypeList+json": { "schema": { "$ref": "#/components/schemas/ProductTypeListWrapper" }, "example": { "ProductTypeList": { "_media-type": "application/vnd.ibexa.api.ProductTypeList+json", "ProductType": [ { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "s_rope", "name": "Static ropes", "AttributeAssignmentList": [] } ] } } }, "application/vnd.ibexa.api.ProductTypeList+xml": { "schema": { "$ref": "#/components/schemas/ProductTypeList" } } } }, "401": { "description": "Error - the user has no permission to read product type." } }, "summary": "Load product types (deprecated)", "description": "Returns a list of product types. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/product_types/view instead.", "parameters": [ { "name": "Accept", "in": "header", "description": "ProductTypeList - If set, the product type list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The ProductTypeList schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "content": { "application/vnd.ibexa.api.ProductTypeListGet+json": { "schema": { "$ref": "#/components/schemas/ProductTypeListGetWrapper" }, "example": { "ProductTypeListGet": { "name_prefix": "s", "offset": 0, "limit": 10 } } }, "application/vnd.ibexa.api.ProductTypeListGet+xml": { "schema": { "$ref": "#/components/schemas/ProductTypeListGet" } } }, "required": false }, "deprecated": false }, "post": { "operationId": "api_productcatalogproduct_types_post", "tags": [ "Product Type" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.ProductType+json": { "schema": { "$ref": "#/components/schemas/ProductTypeWrapper" }, "example": { "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "NEW", "name": "pt_1_updated", "AttributeAssignmentList": [ { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": true, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "size", "name": "Size", "description": "", "type": "Integer", "type_identifier": "integer", "value": 5, "group": "Hat", "position": 0, "options": [] } } ] } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this product type." }, "403": { "description": "Error - a product type with the same name already exists." }, "404": { "description": "Error - the product type with the given ID does not exist." } }, "summary": "Create product type", "description": "Creates a new product type.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new product type is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The ProductType schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ProductTypeCreateController resource", "content": { "application/vnd.ibexa.api.ProductTypeCreate+json": { "schema": { "$ref": "#/components/schemas/ProductTypeCreateWrapper" }, "example": { "ProductTypeCreate": { "ContentTypeCreateStruct": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2", "id": 2, "status": "DEFINED", "identifier": "test_pt321", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Article" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2021-06-28T11:31:22+00:00", "remoteId": "c15b600eb9198b1924063b5a68758232", "urlAliasSchema": "", "nameSchema": "", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": false, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/1", "id": 1, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "New article", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } } ] } }, "main_language_code": "eng-GB", "assigned_attributes": [ { "identifier": "testAttr", "is_required": false, "is_discriminator": true } ] } } } }, "required": false }, "deprecated": false } }, "/product/catalog/product_types/is_used/{identifier}": { "get": { "operationId": "api_productcatalogproduct_typesis_used_identifier_get", "tags": [ "Product Type" ], "responses": { "200": { "description": "OK - product type usage is returned.", "content": { "application/vnd.ibexa.api.ProductTypeUsage+json": { "schema": { "$ref": "#/components/schemas/ProductTypeUsageWrapper" } }, "application/vnd.ibexa.api.ProductTypeUsage+xml": { "schema": { "$ref": "#/components/schemas/ProductTypeUsage" } } } }, "404": { "description": "Error - product type not found." } }, "summary": "Check product type usage", "description": "Checks whether the product type is in use.", "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/product_types/view": { "post": { "operationId": "api_productcatalogproduct_typesview_post", "tags": [ "Product Type" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ProductTypeView+json": { "schema": { "$ref": "#/components/schemas/ProductTypeViewWrapper" }, "example": { "ProductTypeView": { "_media-type": "application/vnd.ibexa.api.ProductTypeView+json", "identifier": "TitleView", "ProductTypeQuery": { "_media-type": "application/vnd.ibexa.api.ProductTypeQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 1, "ProductTypeList": { "_media-type": "application/vnd.ibexa.api.ProductTypeList+json", "ProductType": [ { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "climbing_shoe", "name": "New Product Type", "AttributeAssignmentList": [ { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": false, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "measure", "name": "measure", "description": "", "type": "Measurement", "type_identifier": "measurement", "group": "Test Attribute group", "position": 0, "options": { "type": "length", "unit": "centimeter", "measurementRange": { "minimum": 12, "maximum": 15 }, "measurementDefaultRange": { "defaultRangeMinimumValue": null, "defaultRangeMaximumValue": null } } } }, { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": false, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "leather_color", "name": "leather color", "description": "", "type": "Color", "type_identifier": "color", "value": "#000000", "group": "Test Attribute group", "position": 0, "options": [] } } ] } ] } } } } }, "application/vnd.ibexa.api.ProductTypeView+xml": { "schema": { "$ref": "#/components/schemas/ProductTypeView" } } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "Filter product types", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ProductTypeViewController resource", "content": { "application/vnd.ibexa.api.ProductTypeViewInput+json": { "schema": { "$ref": "#/components/schemas/ProductTypeViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", "ProductTypeQuery": { "limit": "10", "offset": "0", "name_prefix": "new" } } } }, "application/vnd.ibexa.api.ProductTypeViewInput+xml": { "schema": { "$ref": "#/components/schemas/ProductTypeViewInput" } } }, "required": false }, "deprecated": false } }, "/product/catalog/product_types/{identifier}": { "get": { "operationId": "api_productcatalogproduct_types_identifier_get", "tags": [ "Product Type" ], "responses": { "200": { "description": "OK - load the product type", "content": { "application/vnd.ibexa.api.ProductTypeUsage+json": { "schema": { "$ref": "#/components/schemas/ProductTypeUsageWrapper" } }, "application/vnd.ibexa.api.ProductTypeUsage+xml": { "schema": { "$ref": "#/components/schemas/ProductTypeUsage" } } } }, "401": { "description": "Error - the user has no permission to read product type." }, "404": { "description": "Error - product type not found." } }, "summary": "Load product type", "description": "Returns the given product type.", "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/product_types/{id}": { "delete": { "operationId": "api_productcatalogproduct_types_id_delete", "tags": [ "Product Type" ], "responses": { "204": { "description": "No content - the given product type is deleted." }, "401": { "description": "Error - the user is not authorized to delete this product type." } }, "summary": "Delete product type", "description": "Deletes the given product type.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_productcatalogproduct_types_id_patch", "tags": [ "Product Type" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.ProductType+json": { "schema": { "$ref": "#/components/schemas/ProductTypeWrapper" }, "example": { "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "NEW", "name": "pt_1_updated", "AttributeAssignmentList": [ { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": true, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "size", "name": "Size", "description": "", "type": "Integer", "type_identifier": "integer", "value": 5, "group": "Hat", "position": 0, "options": [] } } ] } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this product type." }, "404": { "description": "Error - the product type with the given ID does not exist." } }, "summary": "Update product type", "description": "Updates product type.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated product type is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "If set, the updated product type is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ProductTypeUpdateController resource", "content": { "application/vnd.ibexa.api.ProductTypeUpdate+json": { "schema": { "$ref": "#/components/schemas/ProductTypeUpdateWrapper" }, "example": { "ProductTypeUpdate": { "ContentTypeUpdateStruct": { "names": { "value": [ { "_languageCode": "eng-GB", "#text": "pt_1_updated" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "updated" } ] } }, "assigned_attributes": [ { "identifier": "size", "is_required": false, "is_discriminator": true } ] } } } }, "required": false }, "deprecated": false } }, "/product/catalog/product_variant/{code}": { "get": { "operationId": "api_productcatalogproduct_variant_code_get", "tags": [ "Product Variant" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ProductVariant+json": { "schema": { "$ref": "#/components/schemas/ProductVariantWrapper" }, "example": { "ProductVariant": { "_media-type": "application/vnd.ibexa.api.ProductVariant+json", "code": "test", "name": "Macbook Air ", "Product": { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "mac_air", "name": "Macbook Air", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "laptop", "name": "Laptop", "AttributeAssignmentList": [ { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": true, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "number", "name": "number", "description": "", "type": "Float", "type_identifier": "float", "value": 1.5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } } }, { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": true, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "testattr", "name": "testAttr", "description": "", "type": "Integer", "type_identifier": "integer", "value": 5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } } } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/152", "_remoteId": "2d61ff8d0043eb299ca8c29c74f25441", "_id": 152, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/56" }, "Name": "Macbook Air", "TranslatedName": "Macbook Air", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/152/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/152/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/152/versions/1", "VersionInfo": { "id": 635, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2022-07-21T15:17:18+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2022-07-21T15:17:18+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Macbook Air" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/152" } }, "Fields": { "field": [ { "id": 716, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Macbook Air" }, { "id": 717, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 89, "code": "mac_air", "attributes": [] } }, { "id": 718, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
test
\n", "xhtml5edit": "\n

test

\n" } }, { "id": 719, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } }, { "id": 720, "fieldDefinitionIdentifier": "category", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", "fieldValue": { "taxonomy_entries": [], "taxonomy": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/152/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2022-07-21T15:17:18+02:00", "publishedDate": "2022-07-21T15:17:18+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/152/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1658409438, "updated_at": 1658409438, "AttributesList": [] }, "DiscriminatorAttributesList": [] } } } } }, "401": { "description": "Error - the user is not authorized to view this product variant." }, "404": { "description": "Error - no product variant with the given code exists." } }, "summary": "Load product variant", "description": "Loads the given product variant.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the product variant is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/product_variants/generate/{baseProductCode}": { "post": { "operationId": "api_productcatalogproduct_variantsgenerate_baseProductCode_post", "tags": [ "Product Variant" ], "responses": { "201": { "description": "No content - product variants are generated." }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this product variant." }, "403": { "description": "Error - a product variant with the same name already exists." }, "404": { "description": "Error - no base product with the given code exists." } }, "summary": "Generate product variants", "description": "Generates new product variants based on selected (discriminator) attributes.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new product variant is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The product variant schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "baseProductCode", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ProductVariantGenereateController resource", "content": { "application/vnd.ibexa.api.ProductVariantGenerate+json": { "schema": { "$ref": "#/components/schemas/ProductVariantGenerateWrapper" }, "example": { "ProductVariantGenerate": { "attributes": { "width": [ 123 ], "colors": [ "#000000", "#ffffff", "#d4d400", "#ff0000" ] } } } } }, "required": false }, "deprecated": false } }, "/product/catalog/product_variants/view/{baseProductCode}": { "post": { "operationId": "api_productcatalogproduct_variantsview_baseProductCode_post", "tags": [ "Product Variant" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ProductVariantView+json": { "schema": { "$ref": "#/components/schemas/ProductVariantViewWrapper" }, "example": { "ProductVariantView": { "_media-type": "application/vnd.ibexa.api.ProductVariantView+json", "identifier": "TitleView", "ProductVariantQuery": { "_media-type": "application/vnd.ibexa.api.ProductVariantQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 2, "ProductVariantList": { "_media-type": "application/vnd.ibexa.api.ProductVariantList+json", "ProductVariant": [ { "_media-type": "application/vnd.ibexa.api.ProductVariant+json", "code": "test", "name": "Macbook Air 2/10", "Product": { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "mac_air", "name": "Macbook Air", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "laptop", "name": "Laptop", "AttributeAssignmentList": [ { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": true, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "number", "name": "number", "description": "", "type": "Float", "type_identifier": "float", "value": 1.5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } } }, { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": true, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "testattr", "name": "testAttr", "description": "", "type": "Integer", "type_identifier": "integer", "value": 5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } } } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/152", "_remoteId": "2d61ff8d0043eb299ca8c29c74f25441", "_id": 152, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/56" }, "Name": "Macbook Air", "TranslatedName": "Macbook Air", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/152/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/152/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/152/versions/1", "VersionInfo": { "id": 635, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2022-07-21T15:17:18+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2022-07-21T15:17:18+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Macbook Air" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/152" } }, "Fields": { "field": [ { "id": 716, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Macbook Air" }, { "id": 717, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 89, "code": "mac_air", "attributes": [] } }, { "id": 718, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
test
\n", "xhtml5edit": "\n

test

\n" } }, { "id": 719, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } }, { "id": 720, "fieldDefinitionIdentifier": "category", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", "fieldValue": { "taxonomy_entries": [], "taxonomy": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/152/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2022-07-21T15:17:18+02:00", "publishedDate": "2022-07-21T15:17:18+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/152/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1658409438, "updated_at": 1658409438, "AttributesList": [] }, "DiscriminatorAttributesList": [ { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "number", "name": "number", "description": "", "type": "Float", "type_identifier": "float", "value": 1.5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } }, { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "testattr", "name": "testAttr", "description": "", "type": "Integer", "type_identifier": "integer", "value": 5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } } ] }, { "_media-type": "application/vnd.ibexa.api.ProductVariant+json", "code": "fdsfds", "name": "Macbook Air 32/232", "Product": { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "mac_air", "name": "Macbook Air", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "laptop", "name": "Laptop", "AttributeAssignmentList": [ { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": true, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "number", "name": "number", "description": "", "type": "Float", "type_identifier": "float", "value": 1.5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } } }, { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": true, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "testattr", "name": "testAttr", "description": "", "type": "Integer", "type_identifier": "integer", "value": 5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } } } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/152", "_remoteId": "2d61ff8d0043eb299ca8c29c74f25441", "_id": 152, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/56" }, "Name": "Macbook Air", "TranslatedName": "Macbook Air", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/152/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/152/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/152/versions/1", "VersionInfo": { "id": 635, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2022-07-21T15:17:18+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2022-07-21T15:17:18+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Macbook Air" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/152" } }, "Fields": { "field": [ { "id": 716, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Macbook Air" }, { "id": 717, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 89, "code": "mac_air", "attributes": [] } }, { "id": 718, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
test
\n", "xhtml5edit": "\n

test

\n" } }, { "id": 719, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } }, { "id": 720, "fieldDefinitionIdentifier": "category", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", "fieldValue": { "taxonomy_entries": [], "taxonomy": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/152/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2022-07-21T15:17:18+02:00", "publishedDate": "2022-07-21T15:17:18+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/152/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1658409438, "updated_at": 1658409438, "AttributesList": [] }, "DiscriminatorAttributesList": [ { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "number", "name": "number", "description": "", "type": "Float", "type_identifier": "float", "value": 1.5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } }, { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "testattr", "name": "testAttr", "description": "", "type": "Integer", "type_identifier": "integer", "value": 5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } } ] } ] } } } } }, "application/vnd.ibexa.api.ProductVariantView+xml": { "schema": { "$ref": "#/components/schemas/ProductVariantView" } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "404": { "description": "Error - the base product does not exist." } }, "summary": "Filter product variants", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "baseProductCode", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ProductVariantViewController resource", "content": { "application/vnd.ibexa.api.ProductVariantViewInput+json": { "schema": { "$ref": "#/components/schemas/ProductVariantViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", "ProductVariantQuery": { "offset": "0", "limit": "10" } } } }, "application/vnd.ibexa.api.ProductVariantViewInput+xml": { "schema": { "$ref": "#/components/schemas/ProductVariantViewInput" } } }, "required": false }, "deprecated": false } }, "/product/catalog/product_variants/{baseProductCode}": { "post": { "operationId": "api_productcatalogproduct_variants_baseProductCode_post", "tags": [ "Product Variant" ], "responses": { "201": { "description": "No content - product variant is created." }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this product variant." }, "403": { "description": "Error - a product variant with the same name already exists." }, "404": { "description": "Error - no base product with the given code exists." } }, "summary": "Create product variant", "description": "Creates a new product variant.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new product variant is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The product variant schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "baseProductCode", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ProductVariantCreateController resource", "content": { "application/vnd.ibexa.api.ProductVariantCreate+json": { "schema": { "$ref": "#/components/schemas/ProductVariantCreateWrapper" }, "example": { "ProductVariantCreate": { "attributes": { "width": 100, "height": 50, "color": "#000000" }, "code": "macbook_pro" } } } }, "required": false }, "deprecated": false } }, "/product/catalog/product_variants/{code}": { "delete": { "operationId": "api_productcatalogproduct_variants_code_delete", "tags": [ "Product Variant" ], "responses": { "204": { "description": "No content - product variant is deleted." }, "401": { "description": "Error - the user is not authorized to delete this product variant." } }, "summary": "Delete product variant", "description": "Deletes the given product variant.", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_productcatalogproduct_variants_code_patch", "tags": [ "Product Variant" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.ProductVariant+json": { "schema": { "$ref": "#/components/schemas/ProductVariantWrapper" }, "example": { "ProductVariant": { "_media-type": "application/vnd.ibexa.api.ProductVariant+json", "code": "test", "name": "Macbook Air ", "Product": { "_media-type": "application/vnd.ibexa.api.Product+json", "code": "mac_air", "name": "Macbook Air", "ProductType": { "_media-type": "application/vnd.ibexa.api.ProductType+json", "identifier": "laptop", "name": "Laptop", "AttributeAssignmentList": [ { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": true, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "number", "name": "number", "description": "", "type": "Float", "type_identifier": "float", "value": 1.5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } } }, { "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", "is_required": false, "is_discriminator": true, "Attribute": { "_media-type": "application/vnd.ibexa.api.Attribute+json", "identifier": "testattr", "name": "testAttr", "description": "", "type": "Integer", "type_identifier": "integer", "value": 5, "group": "test", "position": 0, "options": { "min": 4, "max": 5 } } } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/152", "_remoteId": "2d61ff8d0043eb299ca8c29c74f25441", "_id": 152, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/56" }, "Name": "Macbook Air", "TranslatedName": "Macbook Air", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/152/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/152/currentversion", "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/152/versions/1", "VersionInfo": { "id": 635, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2022-07-21T15:17:18+02:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2022-07-21T15:17:18+02:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Macbook Air" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/152" } }, "Fields": { "field": [ { "id": 716, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Macbook Air" }, { "id": 717, "fieldDefinitionIdentifier": "product_specification", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_product_specification", "fieldValue": { "id": 89, "code": "mac_air", "attributes": [] } }, { "id": 718, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { "xml": "\n
test
\n", "xhtml5edit": "\n

test

\n" } }, { "id": 719, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image_asset", "fieldValue": { "destinationContentId": null, "alternativeText": null, "source": null } }, { "id": 720, "fieldDefinitionIdentifier": "category", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", "fieldValue": { "taxonomy_entries": [], "taxonomy": null } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" } } }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/152/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2022-07-21T15:17:18+02:00", "publishedDate": "2022-07-21T15:17:18+02:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/152/objectstates" } }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", "width": null, "height": null, "mimeType": "image/svg+xml" }, "created_at": 1658409438, "updated_at": 1658409438, "AttributesList": [] }, "DiscriminatorAttributesList": [] } } } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update this product variant." }, "403": { "description": "Error - a product variant with the same code already exists." }, "404": { "description": "Error - no product variant with the given code exists." } }, "summary": "Update product variant", "description": "Updates product variant.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated product variant is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The product variant update schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "code", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ProductVariantUpdateController resource", "content": { "application/vnd.ibexa.api.ProductVariantUpdate+json": { "schema": { "$ref": "#/components/schemas/ProductVariantUpdateWrapper" }, "example": { "ProductVariantUpdate": { "code": "test", "attributes": { "number": 2, "testattr": 10 } } } } }, "required": false }, "deprecated": false } }, "/product/catalog/vat/{region}": { "get": { "operationId": "api_productcatalogvat_region_get", "tags": [ "Product Vat" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.VatCategoryList+json": { "schema": { "$ref": "#/components/schemas/VatCategoryListWrapper" }, "example": { "VatCategoryList": { "_media-type": "application/vnd.ibexa.api.VatCategoryList+json", "VatCategory": [ { "_media-type": "application/vnd.ibexa.api.VatCategory+json", "identifier": "standard", "region": "region_1", "vatValue": 18 }, { "_media-type": "application/vnd.ibexa.api.VatCategory+json", "identifier": "reduced", "region": "region_1", "vatValue": 6 }, { "_media-type": "application/vnd.ibexa.api.VatCategory+json", "identifier": "none", "region": "region_1", "vatValue": null } ] } } } } }, "401": { "description": "Error - the user is not authorized to read this object." }, "404": { "description": "Error - the VAT category region does not exist." } }, "summary": "Load VAT region", "description": "Loads a VAT category for the given region.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the VAT category list returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "region", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/product/catalog/vat/{region}/{identifier}": { "get": { "operationId": "api_productcatalogvat_region_identifier_get", "tags": [ "Product Vat" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.VatCategory+json": { "schema": { "$ref": "#/components/schemas/VatCategoryWrapper" }, "example": { "VatCategory": { "_media-type": "application/vnd.ibexa.api.VatCategory+json", "identifier": "standard", "region": "region_1", "vatValue": 18 } } } } }, "401": { "description": "Error - the user is not authorized to read this object." }, "404": { "description": "Error - the VAT category for the given identifier not exists." } }, "summary": "Load VAT specific region", "description": "Loads a VAT category for the given identifier.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the VAT category list returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "region", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/sections": { "get": { "operationId": "api_contentsections_get", "tags": [ "Section" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.SectionList+json": { "schema": { "$ref": "#/components/schemas/SectionListWrapper" }, "example": { "SectionList": { "_media-type": "application/vnd.ibexa.api.SectionList+json", "_href": "/api/ibexa/v2/content/sections", "Section": [ { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1", "sectionId": 1, "identifier": "standard", "name": "Standard" }, { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2", "sectionId": 2, "identifier": "users", "name": "Users" }, { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/3", "sectionId": 3, "identifier": "media", "name": "Media" }, { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/6", "sectionId": 6, "identifier": "form", "name": "Form" }, { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/7", "sectionId": 7, "identifier": "template", "name": "Template" }, { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/8", "sectionId": 8, "identifier": "restricted", "name": "Restricted" } ] } } }, "application/vnd.ibexa.api.SectionList+xml": { "schema": { "$ref": "#/components/schemas/SectionList" }, "example": "\n\n
\n 1\n standard\n Standard\n
\n
\n 2\n users\n Users\n
\n
\n 3\n media\n Media\n
\n
\n 6\n form\n Form\n
\n
\n 7\n template\n Template\n
\n
\n 8\n restricted\n Restricted\n
\n\n" } } }, "401": { "description": "Error - The user has no permission to read the Section." } }, "summary": "Get Sections", "description": "Returns a list of all Sections.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Section list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contentsections_post", "tags": [ "Section" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Section+json": { "schema": { "$ref": "#/components/schemas/SectionWrapper" }, "example": { "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/7", "sectionId": 7, "identifier": "template", "name": "Template" } } }, "application/vnd.ibexa.api.Section+xml": { "schema": { "$ref": "#/components/schemas/Section" }, "example": "\n
\n 7\n template\n Template\n
\n" } } } }, "summary": "Create new Section", "description": "Creates a new Section.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new Section is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Section input schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new SectionCreateController resource", "content": { "application/vnd.ibexa.api.SectionInput+json": { "schema": { "$ref": "#/components/schemas/SectionInputWrapper" }, "example": { "SectionInput": { "identifier": "restricted", "name": "Restricted" } } }, "application/vnd.ibexa.api.SectionInput+xml": { "schema": { "$ref": "#/components/schemas/SectionInput" }, "example": "\n\n restricted\n Restricted\n" } }, "required": false }, "deprecated": false } }, "/content/sections/{sectionId}": { "get": { "operationId": "api_contentsections_sectionId_get", "tags": [ "Section" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Section+json": { "schema": { "$ref": "#/components/schemas/SectionWrapper" }, "example": { "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/7", "sectionId": 7, "identifier": "template", "name": "Template" } } }, "application/vnd.ibexa.api.Section+xml": { "schema": { "$ref": "#/components/schemas/Section" }, "example": "\n
\n 7\n template\n Template\n
\n" } } }, "401": { "description": "Error - The user is not authorized to read this Section." }, "404": { "description": "Error - The Section does not exist." } }, "summary": "Get Section", "description": "Returns the Section by given Section ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Section is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "sectionId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contentsections_sectionId_delete", "tags": [ "Section" ], "responses": { "204": { "description": "No Content - given Section is deleted." }, "401": { "description": "Error - the user is not authorized to delete this Section." }, "404": { "description": "Error - the Section does not exist." } }, "summary": "Delete Section", "description": "The given Section is deleted.", "parameters": [ { "name": "sectionId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_contentsections_sectionId_patch", "tags": [ "Section" ], "responses": { "200": { "description": "OK - Section updated.", "content": { "application/vnd.ibexa.api.Section+json": { "schema": { "$ref": "#/components/schemas/SectionWrapper" }, "example": { "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/7", "sectionId": 7, "identifier": "template", "name": "Template" } } }, "application/vnd.ibexa.api.Section+xml": { "schema": { "$ref": "#/components/schemas/Section" }, "example": "\n
\n 7\n template\n Template\n
\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this Section." }, "403": { "description": "Error - a Section with the given identifier already exists." }, "412": { "description": "Error - the current ETag does not match with the one provided in the If-Match header." } }, "summary": "Update a Section", "description": "Updates a Section. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Section is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Section input schema encoded in XML or JSON.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "sectionId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated SectionUpdateController resource", "content": { "application/vnd.ibexa.api.SectionInput+json": { "schema": { "$ref": "#/components/schemas/SectionInputWrapper" }, "example": { "SectionInput": { "identifier": "restricted", "name": "Restricted" } } }, "application/vnd.ibexa.api.SectionInput+xml": { "schema": { "$ref": "#/components/schemas/SectionInput" }, "example": "\n\n restricted\n Restricted\n" } }, "required": false }, "deprecated": false } }, "/segment_groups": { "get": { "operationId": "api_segment_groups_get", "tags": [ "Segmentation" ], "responses": { "200": { "description": "OK - list the segment groups.", "content": { "application/vnd.ibexa.api.SegmentGroupList+json": { "schema": { "$ref": "#/components/schemas/SegmentGroupListWrapper" }, "example": { "SegmentGroupList": { "_media-type": "application/vnd.ibexa.api.SegmentGroupList+json", "_href": "/api/ibexa/v2/segment_groups", "SegmentGroup": [ { "_media-type": "application/vnd.ibexa.api.SegmentGroup+json", "_href": "/api/ibexa/v2/segment_groups/corporate_accounts", "id": 1, "identifier": "corporate_accounts", "name": "Corporate Accounts" } ] } } }, "application/vnd.ibexa.api.SegmentGroupList+xml": { "schema": { "$ref": "#/components/schemas/SegmentGroupList" }, "example": "\n\n \n 1\n corporate_accounts\n Corporate Accounts\n \n\n" } } }, "401": { "description": "Error - the user is not authorized to list segment groups.", "content": { "application/vnd.ibexa.api.ErrorMessage+json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } }, "application/vnd.ibexa.api.ErrorMessage+xml": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } } } }, "summary": "List segment groups", "description": "Lists segment groups.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the list of segment groups is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/segment_groups/{identifier}": { "get": { "operationId": "api_segment_groups_identifier_get", "tags": [ "Segmentation" ], "responses": { "200": { "description": "OK - return the segment group.", "content": { "application/vnd.ibexa.api.SegmentGroup+json": { "schema": { "$ref": "#/components/schemas/SegmentGroupWrapper" }, "example": { "SegmentGroup": { "_media-type": "application/vnd.ibexa.api.SegmentGroup+json", "_href": "/api/ibexa/v2/segment_groups/corporate_accounts", "id": 1, "identifier": "corporate_accounts", "name": "Corporate Accounts" } } }, "application/vnd.ibexa.api.SegmentGroup+xml": { "schema": { "$ref": "#/components/schemas/SegmentGroup" }, "example": "\n\n 1\n corporate_accounts\n Corporate Accounts\n\n" } } }, "401": { "description": "Error - the user is not authorized to load this segment group." }, "404": { "description": "Error - the identifier doesn't match any segment group." } }, "summary": "Load segment group", "description": "Loads segment group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the segment group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/segment_groups/{identifier}/segments": { "get": { "operationId": "api_segment_groups_identifiersegments_get", "tags": [ "Segmentation" ], "responses": { "200": { "description": "OK - list the group's segments.", "content": { "application/vnd.ibexa.api.SegmentList+json": { "schema": { "$ref": "#/components/schemas/SegmentListWrapper" }, "example": { "SegmentList": { "_media-type": "application/vnd.ibexa.api.SegmentList+json", "_href": "/api/ibexa/v2/segment_groups/corporate_accounts/segments", "Segment": [] } } }, "application/vnd.ibexa.api.SegmentList+xml": { "schema": { "$ref": "#/components/schemas/SegmentList" }, "example": "\n\n" } } }, "401": { "description": "Error - the user is not authorized to load this group's segments." }, "404": { "description": "Error - the identifier doesn't match any segment group." } }, "summary": "List segment group's segments", "description": "Lists segment group's segments.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the segment group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/segments/{identifier}": { "get": { "operationId": "api_segments_identifier_get", "tags": [ "Segmentation" ], "responses": { "200": { "description": "OK - Return the segment.", "content": { "application/vnd.ibexa.api.Segment+json": { "schema": { "$ref": "#/components/schemas/SegmentWrapper" } }, "application/vnd.ibexa.api.Segment+xml": { "schema": { "$ref": "#/components/schemas/Segment" } } } }, "401": { "description": "Error - the user is not authorized to load this group's segments." }, "404": { "description": "Error - the identifier doesn't match any segment group." } }, "summary": "Load segment", "description": "Loads the identified segment.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the segment is returned in XML or JSON", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Experience", "color": "#D3822B" }, { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/shipments": { "get": { "operationId": "api_shipments_get", "tags": [ "Shipping" ], "responses": { "200": { "description": "OK - loads the shipments.", "content": { "application/vnd.ibexa.api.ShipmentRefList+json": { "schema": { "$ref": "#/components/schemas/ShipmentRefListWrapper" }, "example": { "ShipmentRefList": { "_media-type": "application/vnd.ibexa.api.ShipmentRefList+json", "_href": "/api/ibexa/v2/shipments", "shipmentRefList": [ { "_media-type": "application/vnd.ibexa.api.Shipment+json", "_href": "/api/ibexa/v2/shipments/foo" }, { "_media-type": "application/vnd.ibexa.api.Shipment+json", "_href": "/api/ibexa/v2/shipments/bar" }, { "_media-type": "application/vnd.ibexa.api.Shipment+json", "_href": "/api/ibexa/v2/shipments/baz" }, { "_media-type": "application/vnd.ibexa.api.Shipment+json", "_href": "/api/ibexa/v2/shipments/qux" } ] } } }, "application/vnd.ibexa.api.ShipmentRefList+xml": { "schema": { "$ref": "#/components/schemas/ShipmentRefList" }, "example": "\n\n \n \n \n \n\n" } } }, "401": { "description": "Error - the user has no permission to read shipment lists." }, "404": { "description": "Error - the shipment does not exist." } }, "summary": "Load shipments", "description": "Loads a list of shipments.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the shipments are returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/shipments/{identifier}": { "get": { "operationId": "api_shipments_identifier_get", "tags": [ "Shipping" ], "responses": { "200": { "description": "OK - loads the shipment.", "content": { "application/vnd.ibexa.api.Shipment+json": { "schema": { "$ref": "#/components/schemas/ShipmentWrapper" }, "example": { "Shipment": { "_media-type": "application/vnd.ibexa.api.Shipment+json", "_href": "/api/ibexa/v2/shipments/new_identifier", "id": 1, "identifier": "new_identifier", "status": "prepared", "transitions": { "transitionList": [ "send-to-carrier", "cancel" ] }, "Order": { "_media-type": "application/vnd.ibexa.api.Order+json", "_href": "/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f" }, "Amount": { "value": "2257", "currency": "EUR" }, "createdAt": "2023-06-26T15:40:28+02:00", "updatedAt": "2023-06-26T15:40:28+02:00", "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Method": { "_media-type": "application/vnd.ibexa.api.ShippingMethod+json", "_href": "/api/ibexa/v2/shipping/methods/parcel_locker_delivery" } } } }, "application/vnd.ibexa.api.Shipment+xml": { "schema": { "$ref": "#/components/schemas/Shipment" }, "example": "\n\n 1\n new_identifier\n prepared\n \n send-to-carrier\n cancel\n \n \n \n 2257\n EUR\n \n 2023-06-26T15:40:28+02:00\n 2023-06-26T15:40:28+02:00\n \n \n\n" } } }, "401": { "description": "Error - the user has no permission to read shipments." }, "404": { "description": "Error - the shipment does not exist." } }, "summary": "Load a single shipment based on its identifier", "description": "Loads a single shipment based on its identifier.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the shipment is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "delete": { "operationId": "api_shipments_identifier_delete", "tags": [ "Shipping" ], "responses": { "204": { "description": "No content - shipment is deleted." }, "401": { "description": "Error - the user is not authorized to delete this shipment." }, "404": { "description": "Error - the shipment with the given ID does not exist." } }, "summary": "Delete shipment", "description": "Deletes a shipment.", "parameters": [ { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] }, "patch": { "operationId": "api_shipments_identifier_patch", "tags": [ "Shipping" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Shipment+json": { "schema": { "$ref": "#/components/schemas/ShipmentWrapper" }, "example": { "Shipment": { "_media-type": "application/vnd.ibexa.api.Shipment+json", "_href": "/api/ibexa/v2/shipments/new_identifier", "id": 1, "identifier": "new_identifier", "status": "prepared", "transitions": { "transitionList": [ "send-to-carrier", "cancel" ] }, "Order": { "_media-type": "application/vnd.ibexa.api.Order+json", "_href": "/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f" }, "Amount": { "value": "2257", "currency": "EUR" }, "createdAt": "2023-06-26T15:40:28+02:00", "updatedAt": "2023-06-26T15:40:28+02:00", "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Method": { "_media-type": "application/vnd.ibexa.api.ShippingMethod+json", "_href": "/api/ibexa/v2/shipping/methods/parcel_locker_delivery" } } } }, "application/vnd.ibexa.api.Shipment+xml": { "schema": { "$ref": "#/components/schemas/Shipment" }, "example": "\n\n 1\n new_identifier\n prepared\n \n send-to-carrier\n cancel\n \n \n \n 2257\n EUR\n \n 2023-06-26T15:40:28+02:00\n 2023-06-26T15:40:28+02:00\n \n \n\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update this shipment." }, "404": { "description": "Error - the shipment with the given ID does not exist." }, "406": { "description": "Error - the shipment cannot be cancelled due to not-allowed workflow transition" } }, "summary": "Update shipment", "description": "Updates a shipment.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated shipment is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The ShipmentUpdate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ShipmentUpdateController resource", "content": { "application/vnd.ibexa.api.ShipmentUpdate+json": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateWrapper" }, "example": { "ShipmentUpdate": { "identifier": "new_identifier", "transition": "prepare", "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Context": { "item1": "value1", "item2": "value2" } } } }, "application/vnd.ibexa.api.ShipmentUpdate+xml": { "schema": { "$ref": "#/components/schemas/ShipmentUpdate" }, "example": "\n\n new_identifier\n prepare\n \n \n value1\n value2\n \n\n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/shipping/method-types": { "get": { "operationId": "api_shippingmethod-types_get", "tags": [ "Shipping" ], "responses": { "200": { "description": "OK - loads the shipping method.", "content": { "application/vnd.ibexa.api.ShippingMethodTypesList+json": { "schema": { "$ref": "#/components/schemas/ShippingMethodTypesListWrapper" }, "example": { "ShippingMethodTypesList": { "_media-type": "application/vnd.ibexa.api.ShippingMethodTypesList+json", "_href": "/api/ibexa/v2/shipping/method-types", "ShippingMethodTypes": [ { "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json", "_href": "/api/ibexa/v2/shipping/method-types/flat_rate", "identifier": "flat_rate", "name": "Flat rate" }, { "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json", "_href": "/api/ibexa/v2/shipping/method-types/free", "identifier": "free", "name": "Free shipping" } ] } } }, "application/vnd.ibexa.api.ShippingMethodTypesList+xml": { "schema": { "$ref": "#/components/schemas/ShippingMethodTypesList" }, "example": "\n\n \n flat_rate\n Flat rate\n \n \n free\n Free shipping\n \n\n" } } }, "401": { "description": "Error - the user has no permission to read shipping methods types." }, "404": { "description": "Error - the shipping method type does not exist." } }, "summary": "Load shipping methods types", "description": "Loads shipping methods types.", "parameters": [ { "name": "Accept", "in": "header", "description": "Shipping method type reference - if set, the shipping method is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/shipping/method-types/{identifier}": { "get": { "operationId": "api_shippingmethod-types_identifier_get", "tags": [ "Shipping" ], "responses": { "200": { "description": "OK - loads the shipping method.", "content": { "application/vnd.ibexa.api.ShippingMethodType+json": { "schema": { "$ref": "#/components/schemas/ShippingMethodTypeWrapper" }, "example": { "ShippingMethodType": { "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json", "_href": "/api/ibexa/v2/shipping/method-types/flat_rate", "identifier": "flat_rate", "name": "Flat rate" } } }, "application/vnd.ibexa.api.ShippingMethodType+xml": { "schema": { "$ref": "#/components/schemas/ShippingMethodType" }, "example": "\n\n flat_rate\n Flat rate\n\n" } } }, "401": { "description": "Error - the user has no permission to read shipping methods." }, "404": { "description": "Error - the shipping method type does not exist." } }, "summary": "Load shipping method type based on its identifier", "description": "Loads shipping methods type based on their identifiers.", "parameters": [ { "name": "Accept", "in": "header", "description": "Shipping method type - if set, the shipping method is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/shipping/methods": { "get": { "operationId": "api_shippingmethods_get", "tags": [ "Shipping" ], "responses": { "200": { "description": "OK - list the shipping methods.", "content": { "application/vnd.ibexa.api.ShippingMethodRefList+json": { "schema": { "$ref": "#/components/schemas/ShippingMethodRefListWrapper" }, "example": { "ShippingMethodRefList": { "_media-type": "application/vnd.ibexa.api.ShippingMethodRefList+json", "_href": "/api/ibexa/v2/shipping/methods", "ShippingMethodRefs": [ { "_media-type": "application/vnd.ibexa.api.ShippingMethod+json", "_href": "/api/ibexa/v2/shipping/methods/parcel_delivery" }, { "_media-type": "application/vnd.ibexa.api.ShippingMethod+json", "_href": "/api/ibexa/v2/shipping/methods/parcel_locker_delivery" } ] } } }, "application/vnd.ibexa.api.ShippingMethodRefList+xml": { "schema": { "$ref": "#/components/schemas/ShippingMethodRefList" }, "example": "\n\n \n \n\n" } } }, "401": { "description": "Error - the user has no permission to read shipping methods." } }, "summary": "Load shipping methods", "description": "Loads shipping methods.", "parameters": [ { "name": "Accept", "in": "header", "description": "Shipping method reference - if set, the shipping method is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/shipping/methods/{identifier}": { "get": { "operationId": "api_shippingmethods_identifier_get", "tags": [ "Shipping" ], "responses": { "200": { "description": "OK - loads the shipping method.", "content": { "application/vnd.ibexa.api.ShippingMethod+json": { "schema": { "$ref": "#/components/schemas/ShippingMethodWrapper" }, "example": { "ShippingMethod": { "_media-type": "application/vnd.ibexa.api.ShippingMethod+json", "_href": "/api/ibexa/v2/shipping/methods/method1", "identifier": "method1", "name": "AmE Method 1", "names": { "value": [ { "_languageCode": "eng-US", "#text": "AmE Method 1" }, { "_languageCode": "eng-GB", "#text": "BrE Method 1" } ] }, "description": "AmE Description of Method 1", "descriptions": { "value": [ { "_languageCode": "eng-US", "#text": "AmE Description of Method 1" }, { "_languageCode": "eng-GB", "#text": "BrE Description of Method 1" } ] }, "enabled": true, "options": { "option": [ { "_key": "price", "#text": "20.0000" }, { "_key": "currency", "#text": "EUR" } ] }, "regions": { "RegionRefList": [ { "_media-type": "application/vnd.ibexa.api.Region+json", "_href": "/api/ibexa/v2/product/catalog/regions/default" } ] }, "type": { "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json", "_href": "/api/ibexa/v2/shipping/method-types/flat_rate" } } } }, "application/vnd.ibexa.api.ShippingMethod+xml": { "schema": { "$ref": "#/components/schemas/ShippingMethod" }, "example": "\n\n method1\n AmE Method 1\n \n AmE Method 1\n BrE Method 1\n \n AmE Description of Method 1\n \n AmE Description of Method 1\n BrE Description of Method 1\n \n true\n \n 20.0000\n EUR\n \n \n \n \n \n\n" } } }, "401": { "description": "Error - the user has no permission to read shipping methods." }, "404": { "description": "Error - the shipping method does not exist." } }, "summary": "Load shipping method based on its identifier", "description": "Loads shipping method based on its identifier.", "parameters": [ { "name": "Accept", "in": "header", "description": "Shipping method - if set, the shipping method is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" } ] } }, "/shopping-list": { "get": { "operationId": "api_shopping-list_get", "tags": [ "Shopping List" ], "responses": { "200": { "description": "Shopping list collection returned.", "content": { "application/vnd.ibexa.api.ShoppingListCollection+json": { "schema": { "$ref": "#/components/schemas/ShoppingListCollectionWrapper" }, "example": { "ShoppingListCollection": { "totalCount": 2, "count": 2, "ShoppingList": [ { "identifier": "550e8400-e29b-41d4-a716-446655440000", "name": "My Shopping List", "isDefault": true, "owner": { "_href": "/api/ibexa/v2/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" }, "entries": [ { "identifier": "650e8400-e29b-41d4-a716-446655440001", "product": { "_href": "/api/ibexa/v2/product/catalog/products/PRODUCT-001", "_media-type": "application/vnd.ibexa.api.Product+json", "code": "PRODUCT-001", "name": "Sample Product" }, "addedAt": "2024-10-29T12:15:00+00:00" } ], "createdAt": "2024-10-29T12:00:00+00:00", "updatedAt": "2024-10-29T12:00:00+00:00" }, { "identifier": "660e8400-e29b-41d4-a716-446655440001", "name": "Weekend Shopping", "isDefault": false, "owner": { "_href": "/api/ibexa/v2/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" }, "entries": [], "createdAt": "2024-10-30T08:30:00+00:00", "updatedAt": "2024-10-30T08:30:00+00:00" } ] } } }, "application/vnd.ibexa.api.ShoppingListCollection+xml": { "schema": { "$ref": "#/components/schemas/ShoppingListCollection" }, "example": "\n\n 2\n 2\n \n 550e8400-e29b-41d4-a716-446655440000\n My Shopping List\n 1\n \n \n 650e8400-e29b-41d4-a716-446655440001\n \n PRODUCT-001\n Sample Product\n \n 2024-10-29T12:15:00+00:00\n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:00:00+00:00\n \n \n 660e8400-e29b-41d4-a716-446655440001\n Weekend Shopping\n 0\n \n \n 2024-10-30T08:30:00+00:00\n 2024-10-30T08:30:00+00:00\n \n\n" } } }, "401": { "description": "Error - The user is not authorized to list shopping lists." } }, "summary": "List shopping lists", "description": "Returns a list of shopping lists owned by the current user.", "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of shopping lists to return. Default is 25.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "default": 25 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "offset", "in": "query", "description": "The offset for pagination. Default is 0.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "default": 0 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "name", "in": "query", "description": "Filter shopping lists by name (partial match).", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdFrom", "in": "query", "description": "Filter shopping lists created on or after this date (ISO 8601 format).", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdTo", "in": "query", "description": "Filter shopping lists created on or before this date (ISO 8601 format).", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "updatedFrom", "in": "query", "description": "Filter shopping lists updated on or after this date (ISO 8601 format).", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "updatedTo", "in": "query", "description": "Filter shopping lists updated on or before this date (ISO 8601 format).", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "isDefault", "in": "query", "description": "Filter shopping lists by default flag. Use \"true\" for default lists only, \"false\" for non-default lists only.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "true", "false" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "ownerId", "in": "query", "description": "Filter shopping lists by owner user ID.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "sort", "in": "query", "description": "Sort shopping lists by field. Available fields: name, is_default, created_at, updated_at.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "name", "is_default", "created_at", "updated_at" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "order", "in": "query", "description": "Sort direction. Default is \"asc\".", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] }, "post": { "operationId": "api_shopping-list_post", "tags": [ "Shopping List" ], "responses": { "201": { "description": "Shopping list created.", "content": { "application/vnd.ibexa.api.ShoppingList+json": { "schema": { "$ref": "#/components/schemas/ShoppingListWrapper" }, "example": { "ShoppingList": { "identifier": "550e8400-e29b-41d4-a716-446655440000", "name": "My Shopping List", "isDefault": false, "owner": { "_href": "/api/ibexa/v2/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" }, "entries": [ { "identifier": "650e8400-e29b-41d4-a716-446655440001", "product": { "_href": "/api/ibexa/v2/product/catalog/products/PRODUCT-001", "_media-type": "application/vnd.ibexa.api.Product+json", "code": "PRODUCT-001", "name": "Sample Product" }, "addedAt": "2024-10-29T12:15:00+00:00" } ], "createdAt": "2024-10-29T12:00:00+00:00", "updatedAt": "2024-10-29T12:00:00+00:00" } } }, "application/vnd.ibexa.api.ShoppingList+xml": { "schema": { "$ref": "#/components/schemas/ShoppingList" }, "example": "\n\n 550e8400-e29b-41d4-a716-446655440000\n My Shopping List\n 0\n \n \n 650e8400-e29b-41d4-a716-446655440001\n \n PRODUCT-001\n Sample Product\n \n 2024-10-29T12:15:00+00:00\n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:00:00+00:00\n\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to create a shopping list." }, "403": { "description": "Error - Invalid request (e.g., missing required name)." }, "406": { "description": "Error - Shopping list limit exceeded for the current user." } }, "summary": "Create shopping list", "description": "Creates a new shopping list for the current user. The list will be owned by the authenticated user.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ShoppingListCreateController resource", "content": { "application/vnd.ibexa.api.ShoppingListCreate+json": { "schema": { "$ref": "#/components/schemas/ShoppingListCreateWrapper" }, "example": { "ShoppingListCreate": { "name": "My Shopping List" } } }, "application/vnd.ibexa.api.ShoppingListCreate+xml": { "schema": { "$ref": "#/components/schemas/ShoppingListCreate" }, "example": "\n\n My Shopping List\n\n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] } }, "/shopping-list/default/entries": { "post": { "operationId": "api_shopping-listdefaultentries_post", "tags": [ "Shopping List" ], "responses": { "200": { "description": "Entries added successfully. Returns the default shopping list.", "content": { "application/vnd.ibexa.api.ShoppingList+json": { "schema": { "$ref": "#/components/schemas/ShoppingListWrapper" }, "example": { "ShoppingList": { "identifier": "550e8400-e29b-41d4-a716-446655440000", "name": "My Shopping List", "isDefault": false, "owner": { "_href": "/api/ibexa/v2/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" }, "entries": [ { "identifier": "650e8400-e29b-41d4-a716-446655440001", "product": { "_href": "/api/ibexa/v2/product/catalog/products/PRODUCT-001", "_media-type": "application/vnd.ibexa.api.Product+json", "code": "PRODUCT-001", "name": "Sample Product" }, "addedAt": "2024-10-29T12:15:00+00:00" } ], "createdAt": "2024-10-29T12:00:00+00:00", "updatedAt": "2024-10-29T12:00:00+00:00" } } }, "application/vnd.ibexa.api.ShoppingList+xml": { "schema": { "$ref": "#/components/schemas/ShoppingList" }, "example": "\n\n 550e8400-e29b-41d4-a716-446655440000\n My Shopping List\n 0\n \n \n 650e8400-e29b-41d4-a716-446655440001\n \n PRODUCT-001\n Sample Product\n \n 2024-10-29T12:15:00+00:00\n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:00:00+00:00\n\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to add entries to the default shopping list." }, "403": { "description": "Error - Invalid request (e.g., invalid product code, duplicate entry)." }, "406": { "description": "Error - Shopping list entry limit exceeded." } }, "summary": "Add entries to default shopping list", "description": "Adds one or more product entries to the default shopping list. If the default shopping list does not exist, it will be created automatically.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ShoppingListAddToDefaultEntriesController resource", "content": { "application/vnd.ibexa.api.ShoppingListEntriesAdd+json": { "schema": { "$ref": "#/components/schemas/ShoppingListEntriesAddWrapper" }, "example": { "ShoppingListEntriesAdd": { "entries": [ { "productCode": "PRODUCT-001" }, { "productCode": "PRODUCT-002" } ] } } }, "application/vnd.ibexa.api.ShoppingListEntriesAdd+xml": { "schema": { "$ref": "#/components/schemas/ShoppingListEntriesAdd" }, "example": "\n\n \n \n PRODUCT-001\n \n \n PRODUCT-002\n \n \n\n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] } }, "/shopping-list/{identifier}": { "get": { "operationId": "api_shopping-list_identifier_get", "tags": [ "Shopping List" ], "responses": { "200": { "description": "OK - returns the shopping list", "content": { "application/vnd.ibexa.api.ShoppingList+json": { "schema": { "$ref": "#/components/schemas/ShoppingListWrapper" }, "example": { "ShoppingList": { "identifier": "550e8400-e29b-41d4-a716-446655440000", "name": "My Shopping List", "isDefault": false, "owner": { "_href": "/api/ibexa/v2/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" }, "entries": [ { "identifier": "650e8400-e29b-41d4-a716-446655440001", "product": { "_href": "/api/ibexa/v2/product/catalog/products/PRODUCT-001", "_media-type": "application/vnd.ibexa.api.Product+json", "code": "PRODUCT-001", "name": "Sample Product" }, "addedAt": "2024-10-29T12:15:00+00:00" }, { "identifier": "650e8400-e29b-41d4-a716-446655440002", "product": { "_href": "/api/ibexa/v2/product/catalog/products/PRODUCT-002", "_media-type": "application/vnd.ibexa.api.Product+json", "code": "PRODUCT-002", "name": "Another Product" }, "addedAt": "2024-10-29T12:30:00+00:00" } ], "createdAt": "2024-10-29T12:00:00+00:00", "updatedAt": "2024-10-29T12:00:00+00:00" } } }, "application/vnd.ibexa.api.ShoppingList+xml": { "schema": { "$ref": "#/components/schemas/ShoppingList" }, "example": "\n\n 550e8400-e29b-41d4-a716-446655440000\n My Shopping List\n 0\n \n \n 650e8400-e29b-41d4-a716-446655440001\n \n PRODUCT-001\n Sample Product\n \n 2024-10-29T12:15:00+00:00\n \n \n 650e8400-e29b-41d4-a716-446655440002\n \n PRODUCT-002\n Another Product\n \n 2024-10-29T12:30:00+00:00\n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:00:00+00:00\n\n" } } }, "401": { "description": "Error - the user is not authorized to access this shopping list." }, "404": { "description": "Error - the identifier does not match any shopping list." } }, "summary": "Get shopping list", "description": "Gets a shopping list by its identifier.", "parameters": [ { "name": "identifier", "in": "path", "description": "The shopping list identifier (UUID)", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] }, "delete": { "operationId": "api_shopping-list_identifier_delete", "tags": [ "Shopping List" ], "responses": { "204": { "description": "No Content - shopping list deleted successfully." }, "401": { "description": "Error - The user is not authorized to delete this shopping list." }, "403": { "description": "Error - Cannot delete the default shopping list." }, "404": { "description": "Error - Shopping list with the given identifier does not exist." } }, "summary": "Delete shopping list", "description": "Deletes a shopping list by its identifier. The default shopping list cannot be deleted.", "parameters": [ { "name": "identifier", "in": "path", "description": "The shopping list identifier (UUID).", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] }, "patch": { "operationId": "api_shopping-list_identifier_patch", "tags": [ "Shopping List" ], "responses": { "200": { "description": "Shopping list updated.", "content": { "application/vnd.ibexa.api.ShoppingList+json": { "schema": { "$ref": "#/components/schemas/ShoppingListWrapper" }, "example": { "ShoppingList": { "identifier": "550e8400-e29b-41d4-a716-446655440000", "name": "Updated Shopping List Name", "isDefault": false, "owner": { "_href": "/api/ibexa/v2/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" }, "entries": [ { "identifier": "650e8400-e29b-41d4-a716-446655440001", "product": { "_href": "/api/ibexa/v2/product/catalog/products/PRODUCT-001", "_media-type": "application/vnd.ibexa.api.Product+json", "code": "PRODUCT-001", "name": "Sample Product" }, "addedAt": "2024-10-29T12:15:00+00:00" } ], "createdAt": "2024-10-29T12:00:00+00:00", "updatedAt": "2024-10-29T12:30:00+00:00" } } }, "application/vnd.ibexa.api.ShoppingList+xml": { "schema": { "$ref": "#/components/schemas/ShoppingList" }, "example": "\n\n 550e8400-e29b-41d4-a716-446655440000\n Updated Shopping List Name\n 0\n \n \n 650e8400-e29b-41d4-a716-446655440001\n \n PRODUCT-001\n Sample Product\n \n 2024-10-29T12:15:00+00:00\n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:30:00+00:00\n\n" } } }, "204": { "description": "Shopping list updated (no content returned)." }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to update this shopping list." }, "403": { "description": "Error - Invalid request (e.g., validation failed)." }, "404": { "description": "Error - The shopping list does not exist." } }, "summary": "Update shopping list", "description": "Updates an existing shopping list. Only the name can be updated.", "parameters": [ { "name": "identifier", "in": "path", "description": "The shopping list identifier (UUID).", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ShoppingListUpdateController resource", "content": { "application/vnd.ibexa.api.ShoppingListUpdate+json": { "schema": { "$ref": "#/components/schemas/ShoppingListUpdateWrapper" }, "example": { "ShoppingListUpdate": { "name": "Updated Shopping List Name" } } }, "application/vnd.ibexa.api.ShoppingListUpdate+xml": { "schema": { "$ref": "#/components/schemas/ShoppingListUpdate" }, "example": "\n\n Updated Shopping List Name\n\n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] } }, "/shopping-list/{identifier}/add-entries-to-cart": { "post": { "operationId": "api_shopping-list_identifieradd-entries-to-cart_post", "tags": [ "Shopping List" ], "responses": { "200": { "description": "OK - returns the cart with added shopping list entries", "content": { "application/vnd.ibexa.api.Cart+json": { "schema": { "$ref": "#/components/schemas/CartWrapper" } }, "application/vnd.ibexa.api.Cart+xml": { "schema": { "$ref": "#/components/schemas/Cart" } } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to add shopping list entries to cart." }, "404": { "description": "Error - the shopping list or entry identifiers don't match any existing resource." } }, "summary": "Add Selected Entries from Shopping List to Default Cart", "description": "Adds selected entries from the given Shopping List to the default Cart (creates a new Cart if not found).", "parameters": [ { "name": "identifier", "in": "path", "description": "The Shopping List identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new AddEntriesToCartController resource", "content": { "application/vnd.ibexa.api.ShoppingListEntryIdentifiers+json": { "schema": { "$ref": "#/components/schemas/ShoppingListEntryIdentifiersWrapper" }, "example": { "$ref": "#/components/examples/ShoppingListEntryIdentifiersJsonExample" } }, "application/vnd.ibexa.api.ShoppingListEntryIdentifiers+xml": { "schema": { "$ref": "#/components/schemas/ShoppingListEntryIdentifiers" }, "example": { "$ref": "#/components/examples/ShoppingListEntryIdentifiersXmlExample" } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] } }, "/shopping-list/{identifier}/add-entries-to-cart/{cartIdentifier}": { "post": { "operationId": "api_shopping-list_identifieradd-entries-to-cart_cartIdentifier_post", "tags": [ "Shopping List" ], "responses": { "200": { "description": "OK - returns the cart with added shopping list entries", "content": { "application/vnd.ibexa.api.Cart+json": { "schema": { "$ref": "#/components/schemas/CartWrapper" } }, "application/vnd.ibexa.api.Cart+xml": { "schema": { "$ref": "#/components/schemas/Cart" } } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to add shopping list entries to cart." }, "404": { "description": "Error - the shopping list, cart, or entry identifiers don't match any existing resource." } }, "summary": "Add Selected Entries from Shopping List to Specific Cart", "description": "Adds selected entries from the given Shopping List to the specified Cart.", "parameters": [ { "name": "identifier", "in": "path", "description": "The Shopping List identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "cartIdentifier", "in": "path", "description": "The Cart identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new AddEntriesToCartController resource", "content": { "application/vnd.ibexa.api.ShoppingListEntryIdentifiers+json": { "schema": { "$ref": "#/components/schemas/ShoppingListEntryIdentifiersWrapper" }, "example": { "$ref": "#/components/examples/ShoppingListEntryIdentifiersJsonExample" } }, "application/vnd.ibexa.api.ShoppingListEntryIdentifiers+xml": { "schema": { "$ref": "#/components/schemas/ShoppingListEntryIdentifiers" }, "example": { "$ref": "#/components/examples/ShoppingListEntryIdentifiersXmlExample" } } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] } }, "/shopping-list/{identifier}/add-to-cart": { "post": { "operationId": "api_shopping-list_identifieradd-to-cart_post", "tags": [ "Shopping List" ], "responses": { "200": { "description": "OK - returns the cart with added shopping list entries", "content": { "application/vnd.ibexa.api.Cart+json": { "schema": { "$ref": "#/components/schemas/CartWrapper" } }, "application/vnd.ibexa.api.Cart+xml": { "schema": { "$ref": "#/components/schemas/Cart" } } } }, "401": { "description": "Error - the user is not authorized to add shopping list to cart." }, "404": { "description": "Error - the shopping list identifier doesn't match any existing resource." } }, "summary": "Add Shopping List to Default Cart", "description": "Adds all entries from the given Shopping List to the default Cart (creates a new Cart if not found).", "parameters": [ { "name": "identifier", "in": "path", "description": "The Shopping List identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "No payload required", "content": [], "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] } }, "/shopping-list/{identifier}/add-to-cart/{cartIdentifier}": { "post": { "operationId": "api_shopping-list_identifieradd-to-cart_cartIdentifier_post", "tags": [ "Shopping List" ], "responses": { "200": { "description": "OK - returns the cart with added shopping list entries", "content": { "application/vnd.ibexa.api.Cart+json": { "schema": { "$ref": "#/components/schemas/CartWrapper" } }, "application/vnd.ibexa.api.Cart+xml": { "schema": { "$ref": "#/components/schemas/Cart" } } } }, "401": { "description": "Error - the user is not authorized to add shopping list to cart." }, "404": { "description": "Error - the shopping list or cart identifier doesn't match any existing resource." } }, "summary": "Add Shopping List to Specific Cart", "description": "Adds all entries from the given Shopping List to the specified Cart.", "parameters": [ { "name": "identifier", "in": "path", "description": "The Shopping List identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "cartIdentifier", "in": "path", "description": "The Cart identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "No payload required", "content": [], "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] } }, "/shopping-list/{identifier}/clear": { "post": { "operationId": "api_shopping-list_identifierclear_post", "tags": [ "Shopping List" ], "responses": { "200": { "description": "Shopping list cleared successfully. Returns the updated shopping list with no entries.", "content": { "application/vnd.ibexa.api.ShoppingList+json": { "schema": { "$ref": "#/components/schemas/ShoppingListWrapper" }, "example": { "ShoppingList": { "identifier": "550e8400-e29b-41d4-a716-446655440000", "name": "My Shopping List", "isDefault": false, "owner": { "_href": "/api/ibexa/v2/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" }, "entries": [], "createdAt": "2024-10-29T12:00:00+00:00", "updatedAt": "2024-10-29T12:15:00+00:00" } } }, "application/vnd.ibexa.api.ShoppingList+xml": { "schema": { "$ref": "#/components/schemas/ShoppingList" }, "example": "\n\n 550e8400-e29b-41d4-a716-446655440000\n My Shopping List\n 0\n \n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:15:00+00:00\n\n" } } }, "401": { "description": "Error - The user is not authorized to clear this shopping list." }, "403": { "description": "Error - Invalid request." }, "404": { "description": "Error - Shopping list not found." } }, "summary": "Clear shopping list", "description": "Removes all entries from a shopping list while keeping the list itself.", "parameters": [ { "name": "identifier", "in": "path", "description": "The unique identifier (UUID) of the shopping list.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "No payload required", "content": [], "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] } }, "/shopping-list/{identifier}/entries": { "post": { "operationId": "api_shopping-list_identifierentries_post", "tags": [ "Shopping List" ], "responses": { "200": { "description": "Entries added successfully. Returns the updated shopping list.", "content": { "application/vnd.ibexa.api.ShoppingList+json": { "schema": { "$ref": "#/components/schemas/ShoppingListWrapper" }, "example": { "ShoppingList": { "identifier": "550e8400-e29b-41d4-a716-446655440000", "name": "My Shopping List", "isDefault": false, "owner": { "_href": "/api/ibexa/v2/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" }, "entries": [ { "identifier": "650e8400-e29b-41d4-a716-446655440001", "product": { "_href": "/api/ibexa/v2/product/catalog/products/PRODUCT-001", "_media-type": "application/vnd.ibexa.api.Product+json", "code": "PRODUCT-001", "name": "Sample Product" }, "addedAt": "2024-10-29T12:15:00+00:00" } ], "createdAt": "2024-10-29T12:00:00+00:00", "updatedAt": "2024-10-29T12:00:00+00:00" } } }, "application/vnd.ibexa.api.ShoppingList+xml": { "schema": { "$ref": "#/components/schemas/ShoppingList" }, "example": "\n\n 550e8400-e29b-41d4-a716-446655440000\n My Shopping List\n 0\n \n \n 650e8400-e29b-41d4-a716-446655440001\n \n PRODUCT-001\n Sample Product\n \n 2024-10-29T12:15:00+00:00\n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:00:00+00:00\n\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to add entries to this shopping list." }, "403": { "description": "Error - Invalid request (e.g., invalid product code, duplicate entry)." }, "406": { "description": "Error - Shopping list entry limit exceeded." }, "404": { "description": "Error - Shopping list not found." } }, "summary": "Add entries to shopping list", "description": "Adds one or more product entries to an existing shopping list.", "parameters": [ { "name": "identifier", "in": "path", "description": "The unique identifier (UUID) of the shopping list.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ShoppingListAddEntriesController resource", "content": { "application/vnd.ibexa.api.ShoppingListEntriesAdd+json": { "schema": { "$ref": "#/components/schemas/ShoppingListEntriesAddWrapper" }, "example": { "ShoppingListEntriesAdd": { "entries": [ { "productCode": "PRODUCT-001" }, { "productCode": "PRODUCT-002" } ] } } }, "application/vnd.ibexa.api.ShoppingListEntriesAdd+xml": { "schema": { "$ref": "#/components/schemas/ShoppingListEntriesAdd" }, "example": "\n\n \n \n PRODUCT-001\n \n \n PRODUCT-002\n \n \n\n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] } }, "/shopping-list/{identifier}/entries/remove": { "post": { "operationId": "api_shopping-list_identifierentriesremove_post", "tags": [ "Shopping List" ], "responses": { "200": { "description": "Entries removed successfully. Returns the updated shopping list.", "content": { "application/vnd.ibexa.api.ShoppingList+json": { "schema": { "$ref": "#/components/schemas/ShoppingListWrapper" }, "example": { "ShoppingList": { "identifier": "550e8400-e29b-41d4-a716-446655440000", "name": "My Shopping List", "isDefault": false, "owner": { "_href": "/api/ibexa/v2/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" }, "entries": [ { "identifier": "650e8400-e29b-41d4-a716-446655440001", "product": { "_href": "/api/ibexa/v2/product/catalog/products/PRODUCT-001", "_media-type": "application/vnd.ibexa.api.Product+json", "code": "PRODUCT-001", "name": "Sample Product" }, "addedAt": "2024-10-29T12:15:00+00:00" } ], "createdAt": "2024-10-29T12:00:00+00:00", "updatedAt": "2024-10-29T12:00:00+00:00" } } }, "application/vnd.ibexa.api.ShoppingList+xml": { "schema": { "$ref": "#/components/schemas/ShoppingList" }, "example": "\n\n 550e8400-e29b-41d4-a716-446655440000\n My Shopping List\n 0\n \n \n 650e8400-e29b-41d4-a716-446655440001\n \n PRODUCT-001\n Sample Product\n \n 2024-10-29T12:15:00+00:00\n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:00:00+00:00\n\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to remove entries from this shopping list." }, "403": { "description": "Error - Invalid request (e.g., invalid entry identifier, entry does not exist)." }, "404": { "description": "Error - Shopping list not found." } }, "summary": "Remove entries from shopping list", "description": "Removes one or more product entries from an existing shopping list by their identifiers.", "parameters": [ { "name": "identifier", "in": "path", "description": "The unique identifier (UUID) of the shopping list.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "CSRF Token is needed to execute this unsafe request.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ShoppingListRemoveEntriesController resource", "content": { "application/vnd.ibexa.api.ShoppingListEntriesRemove+json": { "schema": { "$ref": "#/components/schemas/ShoppingListEntriesRemoveWrapper" }, "example": { "ShoppingListEntriesRemove": { "identifiers": [ "650e8400-e29b-41d4-a716-446655440001", "650e8400-e29b-41d4-a716-446655440002" ] } } }, "application/vnd.ibexa.api.ShoppingListEntriesRemove+xml": { "schema": { "$ref": "#/components/schemas/ShoppingListEntriesRemove" }, "example": "\n\n \n 650e8400-e29b-41d4-a716-446655440001\n 650e8400-e29b-41d4-a716-446655440002\n \n\n" } }, "required": false }, "deprecated": false, "x-badges": [ { "name": "Commerce", "color": "#A32768", "position": "after" }, { "name": "LTS Update", "color": "#5DA7C0", "position": "after" } ] } }, "/taxonomy/{taxonomyName}/entries": { "delete": { "operationId": "api_taxonomy_taxonomyNameentries_delete", "tags": [ "Taxonomy" ], "responses": { "204": { "description": "No Content - The entries have been deleted." }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to delete some of the entries." } }, "summary": "Delete Entries", "description": "Bulk removes several taxonomy entries.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Target Entries schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "taxonomyName", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "content": { "application/vnd.ibexa.api.TaxonomyEntryBulkRemove+json": { "schema": { "$ref": "#/components/schemas/TaxonomyEntryBulkRemoveWrapper" }, "example": { "TaxonomyEntryBulkRemove": { "entries": [ 2, 3 ] } } }, "application/vnd.ibexa.api.TaxonomyEntryBulkRemove+xml": { "schema": { "$ref": "#/components/schemas/TaxonomyEntryBulkRemove" } } }, "required": false }, "deprecated": false } }, "/taxonomy/{taxonomyName}/entries/move": { "post": { "operationId": "api_taxonomy_taxonomyNameentriesmove_post", "tags": [ "Taxonomy" ], "responses": { "204": { "description": "No Content - The entries have been moved." }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to move some of the entries." }, "404": { "description": "Error - Some to-be-moved or sibling entries do not exist." } }, "summary": "Move Entries", "description": "Bulk move several taxonomy entries relative to sibling.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The Entry moves schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "taxonomyName", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new TaxonomyEntryBulkMoveController resource", "content": { "application/vnd.ibexa.api.TaxonomyEntryBulkMove+json": { "schema": { "$ref": "#/components/schemas/TaxonomyEntryBulkMoveWrapper" }, "example": { "TaxonomyEntryBulkMove": { "entries": [ { "entry": 2, "sibling": 1, "position": "next" }, { "entry": 3, "sibling": 1, "position": "prev" } ] } } }, "application/vnd.ibexa.api.TaxonomyEntryBulkMove+xml": { "schema": { "$ref": "#/components/schemas/TaxonomyEntryBulkMove" } } }, "required": false }, "deprecated": false } }, "/taxonomy/{taxonomyName}/entry-assignment/{id}": { "get": { "operationId": "api_taxonomy_taxonomyNameentry-assignment_id_get", "tags": [ "Taxonomy" ], "responses": { "200": { "description": "OK - returns the taxonomy entry Assignment.", "content": { "application/vnd.ibexa.api.TaxonomyEntryAssignment+json": { "schema": { "$ref": "#/components/schemas/TaxonomyEntryAssignmentWrapper" } }, "application/vnd.ibexa.api.TaxonomyEntryAssignment+xml": { "schema": { "$ref": "#/components/schemas/TaxonomyEntryAssignment" } } } }, "404": { "description": "Error - the assignment does not exist." } }, "summary": "Get Assignment by ID", "description": "Gets taxonomy entry Assignment by its ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Assignment is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "taxonomyName", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/taxonomy/{taxonomyName}/entry-assignments/assign-to-content": { "post": { "operationId": "api_taxonomy_taxonomyNameentry-assignmentsassign-to-content_post", "tags": [ "Taxonomy" ], "responses": { "201": { "description": "No Content." }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to assign this Entry." } }, "summary": "Assign entry", "description": "Assigns taxonomy entry to a content item.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "taxonomyName", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new TaxonomyEntryAssignmentAssignController resource", "content": { "application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json": { "schema": { "$ref": "#/components/schemas/TaxonomyEntryAssignToContentWrapper" }, "example": { "TaxonomyEntryAssignToContent": { "content": 130, "entries": [ 2, 3 ] } } } }, "required": false }, "deprecated": false } }, "/taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId}": { "get": { "operationId": "api_taxonomy_taxonomyNameentry-assignmentscontent-id_contentId_get", "tags": [ "Taxonomy" ], "responses": { "200": { "description": "OK - returns the assigment collection.", "content": { "application/vnd.ibexa.api.EntryAssignmentCollection+json": { "schema": { "$ref": "#/components/schemas/EntryAssignmentCollectionWrapper" }, "example": { "EntryAssignmentCollection": { "_media-type": "application/vnd.ibexa.api.EntryAssignmentCollection+json", "content": { "_media-type": "application/vnd.ibexa.api.Content+json", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/1", "_remoteId": "9459d3c29e15006e45197295722c7ade", "_id": 1, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1" }, "Name": "Ibexa Platform", "TranslatedName": "Ibexa Platform", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/1/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/1/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/1/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-01-01T00:00:00+00:00", "publishedDate": "2015-11-30T13:10:46+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 10, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/1/objectstates" } } }, "assignments": [ { "_media-type": "application/vnd.ibexa.api.TaxonomyEntryAssignment+json", "id": 1, "content": { "_media-type": "application/vnd.ibexa.api.Content+json", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/1", "_remoteId": "9459d3c29e15006e45197295722c7ade", "_id": 1, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1" }, "Name": "Ibexa Platform", "TranslatedName": "Ibexa Platform", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/1/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/1/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/1/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2023-01-01T00:00:00+00:00", "publishedDate": "2015-11-30T13:10:46+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 10, "alwaysAvailable": true, "isHidden": false, "status": "PUBLISHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/1/objectstates" } } }, "entry": { "_media-type": "application/vnd.ibexa.api.TaxonomyEntry+json", "TaxonomyEntry": { "_media-type": "application/vnd.ibexa.api.TaxonomyEntry+json", "id": 3, "identifier": "example", "name": "Example", "contentId": 65, "content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/65" }, "taxonomy": "tags" } } } ] } } }, "application/vnd.ibexa.api.EntryAssignmentCollection+xml": { "schema": { "$ref": "#/components/schemas/EntryAssignmentCollection" }, "example": "\n\n \n \n \n Ibexa Platform\n Ibexa Platform\n \n \n
\n \n \n 2023-01-01T00:00:00+00:00\n 2015-11-30T13:10:46+00:00\n eng-GB\n 10\n true\n false\n PUBLISHED\n \n \n \n \n 1\n \n \n \n Ibexa Platform\n Ibexa Platform\n \n \n
\n \n \n 2023-01-01T00:00:00+00:00\n 2015-11-30T13:10:46+00:00\n eng-GB\n 10\n true\n false\n PUBLISHED\n \n \n \n \n \n 3\n example\n Example\n 65\n \n tags\n \n \n \n" } } }, "404": { "description": "Error - the Content does not exists." } }, "summary": "Get Assignments to a Content", "description": "Gets taxonomy entries assigned to a content item by its ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the assignments are returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "taxonomyName", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/taxonomy/{taxonomyName}/entry-assignments/unassign-from-content": { "post": { "operationId": "api_taxonomy_taxonomyNameentry-assignmentsunassign-from-content_post", "tags": [ "Taxonomy" ], "responses": { "201": { "description": "No Content." }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to unassign this entry." } }, "summary": "Unassign entry", "description": "Unassigns taxonomy entry from a content item.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "taxonomyName", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new TaxonomyEntryAssignmentUnassignController resource", "content": { "application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json": { "schema": { "$ref": "#/components/schemas/TaxonomyEntryUnassignFromContentWrapper" }, "example": { "TaxonomyEntryUnassignFromContent": { "content": 130, "entries": [ 2, 3 ] } } } }, "required": false }, "deprecated": false } }, "/taxonomy/{taxonomyName}/entry/content-id/{contentId}": { "get": { "operationId": "api_taxonomy_taxonomyNameentrycontent-id_contentId_get", "tags": [ "Taxonomy" ], "responses": { "200": { "description": "OK - returns the taxonomy Entry.", "content": { "application/vnd.ibexa.api.TaxonomyEntry+json": { "schema": { "$ref": "#/components/schemas/TaxonomyEntryWrapper" } }, "application/vnd.ibexa.api.TaxonomyEntry+xml": { "schema": { "$ref": "#/components/schemas/TaxonomyEntry" } } } }, "401": { "description": "Error - the user is not authorized to read this Entry." }, "404": { "description": "Error - the Entry does not exists." } }, "summary": "Get Entry by Content ID", "description": "Loads taxonomy Entry by its Content ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Taxonomy Entry is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "taxonomyName", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/taxonomy/{taxonomyName}/entry/identifier/{identifier}": { "get": { "operationId": "api_taxonomy_taxonomyNameentryidentifier_identifier_get", "tags": [ "Taxonomy" ], "responses": { "200": { "description": "OK - returns the taxonomy Entry.", "content": { "application/vnd.ibexa.api.TaxonomyEntry+json": { "schema": { "$ref": "#/components/schemas/TaxonomyEntryWrapper" } }, "application/vnd.ibexa.api.TaxonomyEntry+xml": { "schema": { "$ref": "#/components/schemas/TaxonomyEntry" } } } }, "401": { "description": "Error - the user is not authorized to read this Entry." }, "404": { "description": "Error - the Entry does not exists." } }, "summary": "Get Entry by identifier", "description": "Loads taxonomy Entry by its Entry identifier.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Taxonomy Entry is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "taxonomyName", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "identifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/taxonomy/{taxonomyName}/entry/{id}": { "get": { "operationId": "api_taxonomy_taxonomyNameentry_id_get", "tags": [ "Taxonomy" ], "responses": { "200": { "description": "OK - returns the taxonomy Entry.", "content": { "application/vnd.ibexa.api.TaxonomyEntry+json": { "schema": { "$ref": "#/components/schemas/TaxonomyEntryWrapper" } }, "application/vnd.ibexa.api.TaxonomyEntry+xml": { "schema": { "$ref": "#/components/schemas/TaxonomyEntry" } } } }, "401": { "description": "Error - the user is not authorized to read this Entry." }, "404": { "description": "Error - the Entry does not exists." } }, "summary": "Get Entry by ID", "description": "Loads taxonomy Entry by its Entry ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Taxonomy Entry is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "taxonomyName", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/trash": { "get": { "operationId": "api_contenttrash_get", "tags": [ "Trash" ], "responses": { "200": { "description": "OK - returns the list of items in the Trash.", "content": { "application/vnd.ibexa.api.Trash+json": { "schema": { "$ref": "#/components/schemas/TrashWrapper" }, "example": { "Trash": { "_media-type": "application/vnd.ibexa.api.Trash+json", "_href": "/api/ibexa/v2/content/trash", "TrashItem": [ { "_media-type": "application/vnd.ibexa.api.TrashItem+json", "_href": "/api/ibexa/v2/content/trash/87", "id": 87, "priority": 0, "hidden": false, "invisible": false, "ParentLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/57" }, "pathString": "/1/2/57/87/", "depth": 3, "childCount": 0, "remoteId": "7cc6565354858f39a794bf64aa2c2761", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/91" }, "sortField": "PATH", "sortOrder": "ASC", "ContentInfo": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/91", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/91", "_remoteId": "de906bef76f08700662bfaf1579871f0", "_id": 91, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2" }, "Name": "test_article", "TranslatedName": "test_article", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/91/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/91/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/91/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/11" }, "lastModificationDate": "2021-07-19T08:31:01+00:00", "publishedDate": "2021-07-19T08:31:01+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": false, "isHidden": false, "status": "TRASHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/91/objectstates" } } } }, { "_media-type": "application/vnd.ibexa.api.TrashItem+json", "_href": "/api/ibexa/v2/content/trash/89", "id": 89, "priority": 0, "hidden": false, "invisible": false, "ParentLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2" }, "pathString": "/1/2/89/", "depth": 2, "childCount": 0, "remoteId": "256c2e7d71e927bab32a901878827312", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/96" }, "sortField": "PATH", "sortOrder": "ASC", "ContentInfo": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/96", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/96", "_remoteId": "d5bad9eb55cfe8572adf04452a2b206e", "_id": 96, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1" }, "Name": "All Articles test", "TranslatedName": "All Articles test", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/96/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/96/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/96/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "lastModificationDate": "2021-07-19T12:43:02+00:00", "publishedDate": "2021-07-19T12:42:47+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 2, "alwaysAvailable": true, "isHidden": false, "status": "TRASHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/96/objectstates" } } } } ] } } }, "application/vnd.ibexa.api.Trash+xml": { "schema": { "$ref": "#/components/schemas/Trash" }, "example": "\n\n \n 58\n 0\n false\n false\n \n /1/2/56/58/\n 3\n 0\n 59800915ad2eb8514de0bebe84f6ccba\n \n PATH\n ASC\n \n \n \n Folder 1\n \n \n
\n \n \n 2019-02-06T09:03:09+01:00\n 2019-02-06T09:03:09+01:00\n eng-GB\n 1\n true\n \n \n \n \n\n" } } }, "401": { "description": "Error - The user has no permission to read the Trash." } }, "summary": "List Trash items", "description": "Returns a list of all items in the Trash.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Trash item list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contenttrash_delete", "tags": [ "Trash" ], "responses": { "204": { "description": "No Content - Trash emptied." }, "401": { "description": "Error - The user is not authorized to empty all items from Trash." } }, "summary": "Empty Trash", "description": "Empties the Trash.", "parameters": [], "deprecated": false } }, "/content/trash/{trashItemid}": { "get": { "operationId": "api_contenttrash_trashItemid_get", "tags": [ "Trash" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.TrashItem+json": { "schema": { "$ref": "#/components/schemas/TrashItemWrapper" }, "example": { "TrashItem": { "_media-type": "application/vnd.ibexa.api.TrashItem+json", "_href": "/api/ibexa/v2/content/trash/87", "id": 87, "priority": 0, "hidden": false, "invisible": false, "ParentLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/2/57" }, "pathString": "/1/2/57/87/", "depth": 3, "childCount": 0, "remoteId": "7cc6565354858f39a794bf64aa2c2761", "Content": { "_media-type": "application/vnd.ibexa.api.Content+json", "_href": "/api/ibexa/v2/content/objects/91" }, "sortField": "PATH", "sortOrder": "ASC", "ContentInfo": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/91", "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/91", "_remoteId": "de906bef76f08700662bfaf1579871f0", "_id": 91, "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2" }, "Name": "test_article", "TranslatedName": "test_article", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/91/versions" }, "CurrentVersion": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/91/currentversion" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/91/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/11" }, "lastModificationDate": "2021-07-19T08:31:01+00:00", "publishedDate": "2021-07-19T08:31:01+00:00", "mainLanguageCode": "eng-GB", "currentVersionNo": 1, "alwaysAvailable": false, "isHidden": false, "status": "TRASHED", "ObjectStates": { "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", "_href": "/api/ibexa/v2/content/objects/91/objectstates" } } } } } }, "application/vnd.ibexa.api.TrashItem+xml": { "schema": { "$ref": "#/components/schemas/TrashItem" }, "example": "\n\n 81\n 0\n false\n false\n \n /1/2/42/81/\n 3\n 0\n 135e8a84b61848a67be36e9552d2724d\n \n PATH\n ASC\n \n \n \n Folder 1\n \n \n
\n \n \n 2019-04-25T12:45:58+02:00\n 2019-04-25T12:45:58+02:00\n eng-GB\n 1\n true\n TRASHED\n \n \n \n\n" } } }, "401": { "description": "Error - The user has no permission to read the item in Trash." }, "404": { "description": "Error - An item in Trash with the provided ID does not exist." } }, "summary": "Get Trash item", "description": "Returns the item in Trash with the provided ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the item in Trash is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "trashItemid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contenttrash_trashItemid_delete", "tags": [ "Trash" ], "responses": { "204": { "description": "No Content - item deleted." }, "401": { "description": "Error - The user is not authorized to delete the provided item." }, "404": { "description": "Error - The provided item does not exist in Trash." } }, "summary": "Delete Trash item", "description": "Deletes the provided item from Trash.", "parameters": [ { "name": "trashItemid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/types": { "get": { "operationId": "api_contenttypes_get", "tags": [ "Type" ], "responses": { "200": { "description": "OK - returns a list of content types.", "content": { "application/vnd.ibexa.api.ContentTypeInfoList+json": { "schema": { "$ref": "#/components/schemas/ContentTypeInfoListWrapper" }, "example": { "ContentTypeList": { "_media-type": "application/vnd.ibexa.api.ContentTypeList+json", "_href": "/api/ibexa/v2/content/typegroups/1/types", "ContentType": [ { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2", "id": 2, "status": "DEFINED", "identifier": "article", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Article" } ] }, "descriptions": { "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2004-04-20T09:56:29+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/2/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2/draft" }, "remoteId": "c15b600eb9198b1924063b5a68758232", "urlAliasSchema": null, "nameSchema": "", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": false, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/1", "id": 1, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "New article", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/152", "id": 152, "identifier": "short_title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/153", "id": 153, "identifier": "author", "fieldType": "ibexa_author", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": [], "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Author" } ] }, "descriptions": { "value": [] }, "fieldSettings": { "defaultAuthor": 1 }, "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/120", "id": 120, "identifier": "intro", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Intro" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/121", "id": 121, "identifier": "body", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 5, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Body" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/123", "id": 123, "identifier": "enable_comments", "fieldType": "ibexa_boolean", "fieldGroup": "", "position": 6, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": false, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Enable comments" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/154", "id": 154, "identifier": "image", "fieldType": "ibexa_object_relation", "fieldGroup": "", "position": 7, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "destinationContentId": null }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Image" } ] }, "descriptions": { "value": [] }, "fieldSettings": { "selectionMethod": "SELECTION_BROWSE", "selectionRoot": "", "selectionContentTypes": [] }, "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1", "id": 1, "status": "DEFINED", "identifier": "folder", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Folder" } ] }, "descriptions": { "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2015-11-29T21:14:32+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/1/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1/draft" }, "remoteId": "a3d405b81be900468eb153d774f4f0d2", "urlAliasSchema": null, "nameSchema": "", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/4", "id": 4, "identifier": "name", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "Folder", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Name" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/155", "id": 155, "identifier": "short_name", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short name" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 100, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/119", "id": 119, "identifier": "short_description", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short description" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/156", "id": 156, "identifier": "description", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "\n
\n", "xhtml5edit": "\n
\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Description" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/43", "id": 43, "status": "DEFINED", "identifier": "form", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Form" } ] }, "descriptions": { "value": [] }, "creationDate": "2018-09-17T06:46:13+00:00", "modificationDate": "2018-09-17T06:47:14+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/43/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/43/draft" }, "remoteId": "6f7f21df775a33c1e4bbc76b48c38476", "urlAliasSchema": "", "nameSchema": "", "isContainer": false, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PUBLISHED", "defaultSortOrder": "DESC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions/188", "id": 188, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions/189", "id": 189, "identifier": "form", "fieldType": "ibexa_form", "fieldGroup": "content", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "fields": [], "content_id": null, "content_field_id": null, "language_code": null }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Form" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/42", "id": 42, "status": "DEFINED", "identifier": "landing_page", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] }, "creationDate": "2015-07-03T12:00:26+00:00", "modificationDate": "2015-07-03T12:00:26+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/42/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/42/draft" }, "remoteId": "60c03e9758465eb69d56b3afb6adf18e", "urlAliasSchema": "", "nameSchema": "<name>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PUBLISHED", "defaultSortOrder": "DESC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/185", "id": 185, "identifier": "name", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 10, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/186", "id": 186, "identifier": "description", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 20, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Description" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page description" } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/187", "id": 187, "identifier": "page", "fieldType": "ibexa_landing_page", "fieldGroup": "content", "position": 30, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "layout": "default", "zones": [ { "id": "default_id", "name": "default", "blocks": [] } ] }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "fieldSettings": { "availableBlocks": null, "availableLayouts": null, "editorMode": "page_view_mode" }, "validatorConfiguration": [] } ] } } ] } } }, "application/vnd.ibexa.api.ContentTypeInfoList+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeInfoList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeList media-type=\"application/vnd.ibexa.api.ContentTypeList+xml\" href=\"/api/ibexa/v2/content/typegroups/1/types\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/2\">\n <id>2</id>\n <status>DEFINED</status>\n <identifier>article</identifier>\n <names>\n <value languageCode=\"eng-GB\">Article</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T09:21:38+00:00</creationDate>\n <modificationDate>2004-04-20T09:56:29+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/2/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/2/draft\"/>\n <remoteId>c15b600eb9198b1924063b5a68758232</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_title|title></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>false</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/1\">\n <id>1</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>New article</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/152\">\n <id>152</id>\n <identifier>short_title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/153\">\n <id>153</id>\n <identifier>author</identifier>\n <fieldType>ibexa_author</fieldType>\n <fieldGroup></fieldGroup>\n <position>3</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Author</value>\n </names>\n <descriptions/>\n <fieldSettings>\n <value key=\"defaultAuthor\">1</value>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/120\">\n <id>120</id>\n <identifier>intro</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>4</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Intro</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/121\">\n <id>121</id>\n <identifier>body</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>5</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Body</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/123\">\n <id>123</id>\n <identifier>enable_comments</identifier>\n <fieldType>ibexa_boolean</fieldType>\n <fieldGroup></fieldGroup>\n <position>6</position>\n <isTranslatable>false</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>false</defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Enable comments</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/154\">\n <id>154</id>\n <identifier>image</identifier>\n <fieldType>ibexa_object_relation</fieldType>\n <fieldGroup></fieldGroup>\n <position>7</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"destinationContentId\"/>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Image</value>\n </names>\n <descriptions/>\n <fieldSettings>\n <value key=\"selectionMethod\">SELECTION_BROWSE</value>\n <value key=\"selectionRoot\"></value>\n <value key=\"selectionContentTypes\"/>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1\">\n <id>1</id>\n <status>DEFINED</status>\n <identifier>folder</identifier>\n <names>\n <value languageCode=\"eng-GB\">Folder</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T09:21:38+00:00</creationDate>\n <modificationDate>2015-11-29T21:14:32+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/1/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1/draft\"/>\n <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_name|name></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/4\">\n <id>4</id>\n <identifier>name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>Folder</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Name</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/155\">\n <id>155</id>\n <identifier>short_name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short name</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">100</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/119\">\n <id>119</id>\n <identifier>short_description</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>3</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short description</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/156\">\n <id>156</id>\n <identifier>description</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>4</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Description</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/43\">\n <id>43</id>\n <status>DEFINED</status>\n <identifier>form</identifier>\n <names>\n <value languageCode=\"eng-GB\">Form</value>\n </names>\n <descriptions/>\n <creationDate>2018-09-17T06:46:13+00:00</creationDate>\n <modificationDate>2018-09-17T06:47:14+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/43/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/43/draft\"/>\n <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><title></nameSchema>\n <isContainer>false</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PUBLISHED</defaultSortField>\n <defaultSortOrder>DESC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions/188\">\n <id>188</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions/189\">\n <id>189</id>\n <identifier>form</identifier>\n <fieldType>ibexa_form</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"fields\"/>\n <value key=\"content_id\"/>\n <value key=\"content_field_id\"/>\n <value key=\"language_code\"/>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Form</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/42\">\n <id>42</id>\n <status>DEFINED</status>\n <identifier>landing_page</identifier>\n <names>\n <value languageCode=\"eng-GB\">Landing page</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2015-07-03T12:00:26+00:00</creationDate>\n <modificationDate>2015-07-03T12:00:26+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/42/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/42/draft\"/>\n <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><name></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PUBLISHED</defaultSortField>\n <defaultSortOrder>DESC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/185\">\n <id>185</id>\n <identifier>name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>10</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Title</value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/186\">\n <id>186</id>\n <identifier>description</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>20</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Description</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Landing page description</value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/187\">\n <id>187</id>\n <identifier>page</identifier>\n <fieldType>ibexa_landing_page</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>30</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"layout\">default</value>\n <value key=\"zones\">\n <value>\n <value key=\"id\">default_id</value>\n <value key=\"name\">default</value>\n <value key=\"blocks\"/></value>\n </value>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Landing page</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Landing page</value>\n </descriptions>\n <fieldSettings>\n <value key=\"availableBlocks\"/>\n <value key=\"availableLayouts\"/>\n <value key=\"editorMode\">page_view_mode</value>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n</ContentTypeList>\n" }, "application/vnd.ibexa.api.ContentTypeList+json": { "schema": { "$ref": "#/components/schemas/ContentTypeListWrapper" } }, "application/vnd.ibexa.api.ContentTypeList+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeList" } } } }, "401": { "description": "Error - The user has no permission to read the content types." } }, "summary": "List content types", "description": "Returns a list of content types.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the list of content type info objects or content types (including Field definitions) is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/types/view": { "post": { "operationId": "api_contenttypesview_post", "tags": [ "Type" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ContentTypeList+json": { "schema": { "$ref": "#/components/schemas/ContentTypeInfoListWrapper" }, "example": { "ContentTypeList": { "_media-type": "application/vnd.ibexa.api.ContentTypeList+json", "_href": "/api/ibexa/v2/content/typegroups/1/types", "ContentType": [ { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2", "id": 2, "status": "DEFINED", "identifier": "article", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Article" } ] }, "descriptions": { "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2004-04-20T09:56:29+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/2/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2/draft" }, "remoteId": "c15b600eb9198b1924063b5a68758232", "urlAliasSchema": null, "nameSchema": "<short_title|title>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": false, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/1", "id": 1, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "New article", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/152", "id": 152, "identifier": "short_title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/153", "id": 153, "identifier": "author", "fieldType": "ibexa_author", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": [], "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Author" } ] }, "descriptions": { "value": [] }, "fieldSettings": { "defaultAuthor": 1 }, "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/120", "id": 120, "identifier": "intro", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Intro" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/121", "id": 121, "identifier": "body", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 5, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Body" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/123", "id": 123, "identifier": "enable_comments", "fieldType": "ibexa_boolean", "fieldGroup": "", "position": 6, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": false, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Enable comments" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/154", "id": 154, "identifier": "image", "fieldType": "ibexa_object_relation", "fieldGroup": "", "position": 7, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "destinationContentId": null }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Image" } ] }, "descriptions": { "value": [] }, "fieldSettings": { "selectionMethod": "SELECTION_BROWSE", "selectionRoot": "", "selectionContentTypes": [] }, "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1", "id": 1, "status": "DEFINED", "identifier": "folder", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Folder" } ] }, "descriptions": { "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2015-11-29T21:14:32+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/1/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1/draft" }, "remoteId": "a3d405b81be900468eb153d774f4f0d2", "urlAliasSchema": null, "nameSchema": "<short_name|name>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/4", "id": 4, "identifier": "name", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "Folder", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Name" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/155", "id": 155, "identifier": "short_name", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short name" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 100, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/119", "id": 119, "identifier": "short_description", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short description" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/156", "id": 156, "identifier": "description", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Description" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/43", "id": 43, "status": "DEFINED", "identifier": "form", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Form" } ] }, "descriptions": { "value": [] }, "creationDate": "2018-09-17T06:46:13+00:00", "modificationDate": "2018-09-17T06:47:14+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/43/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/43/draft" }, "remoteId": "6f7f21df775a33c1e4bbc76b48c38476", "urlAliasSchema": "", "nameSchema": "<title>", "isContainer": false, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PUBLISHED", "defaultSortOrder": "DESC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions/188", "id": 188, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions/189", "id": 189, "identifier": "form", "fieldType": "ibexa_form", "fieldGroup": "content", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "fields": [], "content_id": null, "content_field_id": null, "language_code": null }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Form" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/42", "id": 42, "status": "DEFINED", "identifier": "landing_page", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] }, "creationDate": "2015-07-03T12:00:26+00:00", "modificationDate": "2015-07-03T12:00:26+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/42/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/42/draft" }, "remoteId": "60c03e9758465eb69d56b3afb6adf18e", "urlAliasSchema": "", "nameSchema": "<name>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PUBLISHED", "defaultSortOrder": "DESC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/185", "id": 185, "identifier": "name", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 10, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/186", "id": 186, "identifier": "description", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 20, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Description" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page description" } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/187", "id": 187, "identifier": "page", "fieldType": "ibexa_landing_page", "fieldGroup": "content", "position": 30, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "layout": "default", "zones": [ { "id": "default_id", "name": "default", "blocks": [] } ] }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "fieldSettings": { "availableBlocks": null, "availableLayouts": null, "editorMode": "page_view_mode" }, "validatorConfiguration": [] } ] } } ] } } }, "application/vnd.ibexa.api.ContentTypeList+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeInfoList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeList media-type=\"application/vnd.ibexa.api.ContentTypeList+xml\" href=\"/api/ibexa/v2/content/typegroups/1/types\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/2\">\n <id>2</id>\n <status>DEFINED</status>\n <identifier>article</identifier>\n <names>\n <value languageCode=\"eng-GB\">Article</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T09:21:38+00:00</creationDate>\n <modificationDate>2004-04-20T09:56:29+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/2/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/2/draft\"/>\n <remoteId>c15b600eb9198b1924063b5a68758232</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_title|title></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>false</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/1\">\n <id>1</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>New article</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/152\">\n <id>152</id>\n <identifier>short_title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/153\">\n <id>153</id>\n <identifier>author</identifier>\n <fieldType>ibexa_author</fieldType>\n <fieldGroup></fieldGroup>\n <position>3</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Author</value>\n </names>\n <descriptions/>\n <fieldSettings>\n <value key=\"defaultAuthor\">1</value>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/120\">\n <id>120</id>\n <identifier>intro</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>4</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Intro</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/121\">\n <id>121</id>\n <identifier>body</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>5</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Body</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/123\">\n <id>123</id>\n <identifier>enable_comments</identifier>\n <fieldType>ibexa_boolean</fieldType>\n <fieldGroup></fieldGroup>\n <position>6</position>\n <isTranslatable>false</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>false</defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Enable comments</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/154\">\n <id>154</id>\n <identifier>image</identifier>\n <fieldType>ibexa_object_relation</fieldType>\n <fieldGroup></fieldGroup>\n <position>7</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"destinationContentId\"/>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Image</value>\n </names>\n <descriptions/>\n <fieldSettings>\n <value key=\"selectionMethod\">SELECTION_BROWSE</value>\n <value key=\"selectionRoot\"></value>\n <value key=\"selectionContentTypes\"/>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1\">\n <id>1</id>\n <status>DEFINED</status>\n <identifier>folder</identifier>\n <names>\n <value languageCode=\"eng-GB\">Folder</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T09:21:38+00:00</creationDate>\n <modificationDate>2015-11-29T21:14:32+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/1/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1/draft\"/>\n <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_name|name></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/4\">\n <id>4</id>\n <identifier>name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>Folder</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Name</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/155\">\n <id>155</id>\n <identifier>short_name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short name</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">100</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/119\">\n <id>119</id>\n <identifier>short_description</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>3</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short description</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/156\">\n <id>156</id>\n <identifier>description</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>4</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Description</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/43\">\n <id>43</id>\n <status>DEFINED</status>\n <identifier>form</identifier>\n <names>\n <value languageCode=\"eng-GB\">Form</value>\n </names>\n <descriptions/>\n <creationDate>2018-09-17T06:46:13+00:00</creationDate>\n <modificationDate>2018-09-17T06:47:14+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/43/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/43/draft\"/>\n <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><title></nameSchema>\n <isContainer>false</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PUBLISHED</defaultSortField>\n <defaultSortOrder>DESC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions/188\">\n <id>188</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions/189\">\n <id>189</id>\n <identifier>form</identifier>\n <fieldType>ibexa_form</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"fields\"/>\n <value key=\"content_id\"/>\n <value key=\"content_field_id\"/>\n <value key=\"language_code\"/>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Form</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/42\">\n <id>42</id>\n <status>DEFINED</status>\n <identifier>landing_page</identifier>\n <names>\n <value languageCode=\"eng-GB\">Landing page</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2015-07-03T12:00:26+00:00</creationDate>\n <modificationDate>2015-07-03T12:00:26+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/42/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/42/draft\"/>\n <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><name></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PUBLISHED</defaultSortField>\n <defaultSortOrder>DESC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/185\">\n <id>185</id>\n <identifier>name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>10</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Title</value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/186\">\n <id>186</id>\n <identifier>description</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>20</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Description</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Landing page description</value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/187\">\n <id>187</id>\n <identifier>page</identifier>\n <fieldType>ibexa_landing_page</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>30</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"layout\">default</value>\n <value key=\"zones\">\n <value>\n <value key=\"id\">default_id</value>\n <value key=\"name\">default</value>\n <value key=\"blocks\"/></value>\n </value>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Landing page</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Landing page</value>\n </descriptions>\n <fieldSettings>\n <value key=\"availableBlocks\"/>\n <value key=\"availableLayouts\"/>\n <value key=\"editorMode\">page_view_mode</value>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n</ContentTypeList>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "Filter content types", "description": "Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API.", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentTypeCreateViewController resource", "content": { "application/vnd.ibexa.api.ContentTypeViewInput+json": { "schema": { "$ref": "#/components/schemas/ContentTypeViewInputWrapper" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ViewInput>\n <identifier>ContentTypeView</identifier>\n <ContentTypeQuery>\n <limit>10</limit>\n <offset>1</offset>\n <Query>\n <ContentTypeIdCriterion>1</ContentTypeIdCriterion>\n <ContentTypeIdCriterion>2</ContentTypeIdCriterion>\n <ContentTypeIdentifierCriterion>folder</ContentTypeIdentifierCriterion>\n <IsSystemCriterion>true</IsSystemCriterion>\n <ContentTypeGroupIdCriterion>1</ContentTypeGroupIdCriterion>\n <ContainsFieldDefinitionIdCriterion>2</ContainsFieldDefinitionIdCriterion>\n </Query>\n <SortClauses>\n <Identifier>descending</Identifier>\n <Id>ascending</Id>\n </SortClauses>\n </ContentTypeQuery>\n</ViewInput>\n" }, "application/vnd.ibexa.api.ContentTypeViewInput+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeViewInput" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ViewInput>\n <identifier>ContentTypeView</identifier>\n <ContentTypeQuery>\n <limit>10</limit>\n <offset>1</offset>\n <Query>\n <ContentTypeIdCriterion>1</ContentTypeIdCriterion>\n <ContentTypeIdCriterion>2</ContentTypeIdCriterion>\n <ContentTypeIdentifierCriterion>folder</ContentTypeIdentifierCriterion>\n <IsSystemCriterion>true</IsSystemCriterion>\n <ContentTypeGroupIdCriterion>1</ContentTypeGroupIdCriterion>\n <ContainsFieldDefinitionIdCriterion>2</ContainsFieldDefinitionIdCriterion>\n </Query>\n <SortClauses>\n <Identifier>descending</Identifier>\n <Id>ascending</Id>\n </SortClauses>\n </ContentTypeQuery>\n</ViewInput>\n" } }, "required": false }, "deprecated": false } }, "/content/types/{contentTypeId}": { "get": { "operationId": "api_contenttypes_contentTypeId_get", "tags": [ "Type" ], "responses": { "200": { "description": "OK - returns the content type.", "content": { "application/vnd.ibexa.api.ContentType+json": { "schema": { "$ref": "#/components/schemas/ContentTypeWrapper" }, "example": { "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2", "id": 2, "status": "DEFINED", "identifier": "article", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Article" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2021-06-28T11:31:22+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/2/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2/draft" }, "remoteId": "c15b600eb9198b1924063b5a68758232", "urlAliasSchema": "", "nameSchema": "<short_title|title>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": false, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/1", "id": 1, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "New article", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/152", "id": 152, "identifier": "short_title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short title" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/153", "id": 153, "identifier": "author", "fieldType": "ibexa_author", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": [], "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Author" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": { "defaultAuthor": 1 }, "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/120", "id": 120, "identifier": "intro", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Intro" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/121", "id": 121, "identifier": "body", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 5, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Body" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/123", "id": 123, "identifier": "enable_comments", "fieldType": "ibexa_boolean", "fieldGroup": "", "position": 6, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": false, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Enable comments" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/195", "id": 195, "identifier": "image", "fieldType": "ibexa_image_asset", "fieldGroup": "content", "position": 7, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": { "destinationContentId": null, "alternativeText": null, "source": null }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Image" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] } ] } } } }, "application/vnd.ibexa.api.ContentType+xml": { "schema": { "$ref": "#/components/schemas/ContentType" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/14\">\n <id>14</id>\n <status>DEFINED</status>\n <identifier>copy_of_article_14</identifier>\n <names>\n <value languageCode=\"eng-GB\">Updated content type name</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">This is an updated content type description</value>\n </descriptions>\n <creationDate>2019-02-06T10:56:36+01:00</creationDate>\n <modificationDate>2019-02-25T12:15:51+01:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/14/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/14/draft\"/>\n <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_title|title></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>false</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/14/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/14/fieldDefinitions/188\">\n <id>188</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>New article</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n </FieldDefinitions>\n</ContentType>\n" } } }, "401": { "description": "Error - The user is not authorized to read this content type." }, "404": { "description": "Error - The content type does not exist." } }, "summary": "Get content type", "description": "Returns the content type with the provided ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the content type is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contenttypes_contentTypeId_post", "tags": [ "Type" ], "responses": { "201": { "description": "Draft created.", "content": { "application/vnd.ibexa.api.ContentTypeInfo+json": { "schema": { "$ref": "#/components/schemas/ContentTypeInfoWrapper" }, "example": { "ContentTypeInfo": { "_media-type": "application/vnd.ibexa.api.ContentTypeInfo+json", "_href": "/api/ibexa/v2/content/types/2/draft", "id": 2, "status": "DRAFT", "identifier": "article", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Updated content type name" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "This is an updated content type description" } ] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2021-08-11T11:58:24+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/2/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2/draft" }, "remoteId": "c15b600eb9198b1924063b5a68758232", "urlAliasSchema": null, "nameSchema": "<short_title|title>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PATH", "defaultSortOrder": "ASC" } } }, "application/vnd.ibexa.api.ContentTypeInfo+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeInfo" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeInfo media-type=\"application/vnd.ibexa.api.ContentTypeInfo+xml\" href=\"/api/ibexa/v2/content/types/14/draft\">\n <id>14</id>\n <status>DRAFT</status>\n <identifier>new_content_type</identifier>\n <names>\n <value languageCode=\"eng-GB\">Updated content type name</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">This is an updated content type description</value>\n </descriptions>\n <creationDate>2019-02-06T10:56:36+01:00</creationDate>\n <modificationDate>2019-02-25T12:15:51+01:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/14/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/14/draft\"/>\n <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_title|title></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>false</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n</ContentTypeInfo>\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to create the draft." }, "403": { "description": "Error - A content type with the given new identifier already exists. A draft already exists." } }, "summary": "Create Draft", "description": "Creates a draft and updates it with the given data.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new content type draft is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The content type Update schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentTypeDraftCreateController resource", "content": { "application/vnd.ibexa.api.ContentTypeUpdate+json": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdateWrapper" }, "example": { "ContentTypeUpdate": { "_media-type": "application/vnd.ibexa.api.ContentTypeUpdate", "defaultAlwaysAvailable": "true" } } }, "application/vnd.ibexa.api.ContentTypeUpdate+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeUpdate>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n</ContentTypeUpdate>\n" } }, "required": false }, "deprecated": false }, "delete": { "operationId": "api_contenttypes_contentTypeId_delete", "tags": [ "Type" ], "responses": { "204": { "description": "No Content - content type deleted." }, "401": { "description": "Error - The user is not authorized to delete this content type." }, "403": { "description": "Error - There are object instances of this content type." }, "404": { "description": "Error - The content type does not exist." } }, "summary": "Delete content type", "description": "Deletes the provided content type.", "parameters": [ { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/types/{contentTypeId}/draft": { "get": { "operationId": "api_contenttypes_contentTypeIddraft_get", "tags": [ "Type" ], "responses": { "200": { "description": "OK - returns the content type.", "content": { "application/vnd.ibexa.api.ContentType+json": { "schema": { "$ref": "#/components/schemas/ContentTypeWrapper" }, "example": { "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2", "id": 2, "status": "DEFINED", "identifier": "article", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Article" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2021-06-28T11:31:22+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/2/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2/draft" }, "remoteId": "c15b600eb9198b1924063b5a68758232", "urlAliasSchema": "", "nameSchema": "<short_title|title>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": false, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/1", "id": 1, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "New article", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/152", "id": 152, "identifier": "short_title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short title" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/153", "id": 153, "identifier": "author", "fieldType": "ibexa_author", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": [], "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Author" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": { "defaultAuthor": 1 }, "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/120", "id": 120, "identifier": "intro", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Intro" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/121", "id": 121, "identifier": "body", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 5, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Body" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/123", "id": 123, "identifier": "enable_comments", "fieldType": "ibexa_boolean", "fieldGroup": "", "position": 6, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": false, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Enable comments" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/195", "id": 195, "identifier": "image", "fieldType": "ibexa_image_asset", "fieldGroup": "content", "position": 7, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": { "destinationContentId": null, "alternativeText": null, "source": null }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Image" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] } ] } } } }, "application/vnd.ibexa.api.ContentType+xml": { "schema": { "$ref": "#/components/schemas/ContentType" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/14\">\n <id>14</id>\n <status>DEFINED</status>\n <identifier>copy_of_article_14</identifier>\n <names>\n <value languageCode=\"eng-GB\">Updated content type name</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">This is an updated content type description</value>\n </descriptions>\n <creationDate>2019-02-06T10:56:36+01:00</creationDate>\n <modificationDate>2019-02-25T12:15:51+01:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/14/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/14/draft\"/>\n <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_title|title></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>false</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/14/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/14/fieldDefinitions/188\">\n <id>188</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>New article</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n </FieldDefinitions>\n</ContentType>\n" } } }, "401": { "description": "Error - The user is not authorized to read this content type." }, "404": { "description": "Error - The content type does not exist or does not have a draft." } }, "summary": "Get content type draft", "description": "Returns the draft of the content type with the provided ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the content type is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contenttypes_contentTypeIddraft_delete", "tags": [ "Type" ], "responses": { "204": { "description": "No Content - content type draft deleted." }, "401": { "description": "Error - The user is not authorized to delete this content type draft." }, "404": { "description": "Error - The content type draft does not exist." } }, "summary": "Delete content type draft", "description": "Deletes the provided content type draft.", "parameters": [ { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_contenttypes_contentTypeIddraft_patch", "tags": [ "Type" ], "responses": { "200": { "description": "Draft metadata updated.", "content": { "application/vnd.ibexa.api.ContentTypeInfo+json": { "schema": { "$ref": "#/components/schemas/ContentTypeInfoWrapper" }, "example": { "ContentTypeInfo": { "_media-type": "application/vnd.ibexa.api.ContentTypeInfo+json", "_href": "/api/ibexa/v2/content/types/2/draft", "id": 2, "status": "DRAFT", "identifier": "article", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Updated content type name" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "This is an updated content type description" } ] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2021-08-11T11:58:24+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/2/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2/draft" }, "remoteId": "c15b600eb9198b1924063b5a68758232", "urlAliasSchema": null, "nameSchema": "<short_title|title>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PATH", "defaultSortOrder": "ASC" } } }, "application/vnd.ibexa.api.ContentTypeInfo+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeInfo" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeInfo media-type=\"application/vnd.ibexa.api.ContentTypeInfo+xml\" href=\"/api/ibexa/v2/content/types/14/draft\">\n <id>14</id>\n <status>DRAFT</status>\n <identifier>new_content_type</identifier>\n <names>\n <value languageCode=\"eng-GB\">Updated content type name</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">This is an updated content type description</value>\n </descriptions>\n <creationDate>2019-02-06T10:56:36+01:00</creationDate>\n <modificationDate>2019-02-25T12:15:51+01:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/14/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/14/draft\"/>\n <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_title|title></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>false</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n</ContentTypeInfo>\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to update the draft." }, "403": { "description": "Error - A content type with the given new identifier already exists." }, "404": { "description": "Error - There is no draft for this content type." } }, "summary": "Update content type draft", "description": "Updates metadata of a draft. This method does not handle Field definitions. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new content type draft is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The content type update schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ContentTypeDraftUpdateController resource", "content": { "application/vnd.ibexa.api.ContentTypeUpdate+json": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdateWrapper" }, "example": { "ContentTypeUpdate": { "_media-type": "application/vnd.ibexa.api.ContentTypeUpdate", "defaultAlwaysAvailable": "true" } } }, "application/vnd.ibexa.api.ContentTypeUpdate+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeUpdate>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n</ContentTypeUpdate>\n" } }, "required": false }, "deprecated": false } }, "/content/types/{contentTypeId}/draft/fieldDefinitions": { "get": { "operationId": "api_contenttypes_contentTypeIddraftfieldDefinitions_get", "tags": [ "Type" ], "responses": { "200": { "description": "OK - return a list of Field definitions.", "content": { "application/vnd.ibexa.api.FieldDefinitionList+json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionsWrapper" } }, "application/vnd.ibexa.api.FieldDefinitionList+xml": { "schema": { "$ref": "#/components/schemas/FieldDefinitions" } } } }, "404": { "description": "Error - The content type draft does not exist." } }, "summary": "Get Draft Field definition list", "description": "Returns all Field definitions of the provided content type Draft.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Field definitions are returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contenttypes_contentTypeIddraftfieldDefinitions_post", "tags": [ "Type" ], "responses": { "201": { "description": "Field definition created.", "content": { "application/vnd.ibexa.api.FieldDefinition+json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionWrapper" }, "example": { "FieldDefinition": { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/195", "id": 195, "identifier": "image", "fieldType": "ibexa_image_asset", "fieldGroup": "content", "position": 7, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": { "destinationContentId": null, "alternativeText": null, "source": null }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Image" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] } } }, "application/vnd.ibexa.api.FieldDefinition+xml": { "schema": { "$ref": "#/components/schemas/FieldDefinition" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/195\">\n <id>195</id>\n <identifier>image</identifier>\n <fieldType>ibexa_image_asset</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>7</position>\n <isTranslatable>false</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"destinationContentId\"/>\n <value key=\"alternativeText\"/>\n <value key=\"source\"/>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Image</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n</FieldDefinition>\n" } } }, "400": { "description": "Error - The input does not match the input schema definition or validation on the Field definition fails." }, "401": { "description": "Error - The user is not authorized to add a Field definition." }, "403": { "description": "Error - A Field definition with the same identifier already exists in the given content type. The Field definition is of singular type, already existing in the given content type. The Field definition you want to add is of a type that can't be added to a content type that already has content instances." } }, "summary": "Add content type Draft Field definition", "description": "Creates a new Field definition for the given content type.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new Field definition is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Field Definition Create schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentTypeDraftFieldDefinitionAddController resource", "content": { "application/vnd.ibexa.api.FieldDefinitionCreate+json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionCreateWrapper" } }, "application/vnd.ibexa.api.FieldDefinitionCreate+xml": { "schema": { "$ref": "#/components/schemas/FieldDefinitionCreate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<FieldDefinitionCreate>\n <identifier>name</identifier>\n <fieldType>ibexa_string</fieldType>\n <isRequired>true</isRequired>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">32</value>\n <value key=\"minStringLength\">8</value>\n </value>\n</validatorConfiguration>\n</FieldDefinitionCreate>\n" } }, "required": false }, "deprecated": false } }, "/content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}": { "get": { "operationId": "api_contenttypes_contentTypeIddraftfieldDefinitions_fieldDefinitionId_get", "tags": [ "Type" ], "responses": { "200": { "description": "OK - returns the Field definition.", "content": { "application/vnd.ibexa.api.FieldDefinition+json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionWrapper" }, "example": { "FieldDefinition": { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/195", "id": 195, "identifier": "image", "fieldType": "ibexa_image_asset", "fieldGroup": "content", "position": 7, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": { "destinationContentId": null, "alternativeText": null, "source": null }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Image" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] } } }, "application/vnd.ibexa.api.FieldDefinition+xml": { "schema": { "$ref": "#/components/schemas/FieldDefinition" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/195\">\n <id>195</id>\n <identifier>image</identifier>\n <fieldType>ibexa_image_asset</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>7</position>\n <isTranslatable>false</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"destinationContentId\"/>\n <value key=\"alternativeText\"/>\n <value key=\"source\"/>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Image</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n</FieldDefinition>\n" } } }, "401": { "description": "Error - The user is not authorized to read the content type draft." }, "404": { "description": "Error - The content type or draft does not exist." } }, "summary": "Get content type Draft Field definition", "description": "Returns the Field definition by the given ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Field definition is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "fieldDefinitionId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contenttypes_contentTypeIddraftfieldDefinitions_fieldDefinitionId_delete", "tags": [ "Type" ], "responses": { "204": { "description": "No Content - Field definition deleted." }, "401": { "description": "Error - The user is not authorized to delete this content type." }, "403": { "description": "Error - There is no draft of the content type assigned to the authenticated user." } }, "summary": "Delete content type Draft Field definition", "description": "Deletes the provided Field definition.", "parameters": [ { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "fieldDefinitionId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_contenttypes_contentTypeIddraftfieldDefinitions_fieldDefinitionId_patch", "tags": [ "Type" ], "responses": { "200": { "description": "OK - attributes updated.", "content": { "application/vnd.ibexa.api.FieldDefinition+json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionWrapper" }, "example": { "FieldDefinition": { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/195", "id": 195, "identifier": "image", "fieldType": "ibexa_image_asset", "fieldGroup": "content", "position": 7, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": { "destinationContentId": null, "alternativeText": null, "source": null }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Image" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] } } }, "application/vnd.ibexa.api.FieldDefinition+xml": { "schema": { "$ref": "#/components/schemas/FieldDefinition" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/195\">\n <id>195</id>\n <identifier>image</identifier>\n <fieldType>ibexa_image_asset</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>7</position>\n <isTranslatable>false</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"destinationContentId\"/>\n <value key=\"alternativeText\"/>\n <value key=\"source\"/>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Image</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n</FieldDefinition>\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to update the Field definition." }, "403": { "description": "Error - A Field definition with the given identifier already exists in the given content type." } }, "summary": "Update content type Draft Field definition", "description": "Updates the attributes of a Field definition.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Field definition is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The Field definition update schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "fieldDefinitionId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ContentTypeDraftFieldDefinitionUpdateController resource", "content": { "application/vnd.ibexa.api.FieldDefinitionUpdate+json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionUpdateWrapper" } }, "application/vnd.ibexa.api.FieldDefinitionUpdate+xml": { "schema": { "$ref": "#/components/schemas/FieldDefinitionUpdate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<FieldDefinitionUpdate>\n <fieldGroup>new_field_group</fieldGroup>\n <position>10</position>\n</FieldDefinitionUpdate>\n" } }, "required": false }, "deprecated": false } }, "/content/types/{contentTypeId}/fieldDefinitions": { "get": { "operationId": "api_contenttypes_contentTypeIdfieldDefinitions_get", "tags": [ "Type" ], "responses": { "200": { "description": "OK - return a list of Field definitions.", "content": { "application/vnd.ibexa.api.FieldDefinitionList+json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionsWrapper" } }, "application/vnd.ibexa.api.FieldDefinitionList+xml": { "schema": { "$ref": "#/components/schemas/FieldDefinitions" } } } }, "404": { "description": "Error - The content type does not exist." } }, "summary": "Get Field definition list", "description": "Returns all Field definitions of the provided content type.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Field definitions are returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/types/{contentTypeId}/fieldDefinitions/{fieldDefinitionId}": { "get": { "operationId": "api_contenttypes_contentTypeIdfieldDefinitions_fieldDefinitionId_get", "tags": [ "Type" ], "responses": { "200": { "description": "OK - returns the Field definition.", "content": { "application/vnd.ibexa.api.FieldDefinition+json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionWrapper" }, "example": { "FieldDefinition": { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/195", "id": 195, "identifier": "image", "fieldType": "ibexa_image_asset", "fieldGroup": "content", "position": 7, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": { "destinationContentId": null, "alternativeText": null, "source": null }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Image" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": null } ] }, "fieldSettings": [], "validatorConfiguration": [] } } }, "application/vnd.ibexa.api.FieldDefinition+xml": { "schema": { "$ref": "#/components/schemas/FieldDefinition" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/195\">\n <id>195</id>\n <identifier>image</identifier>\n <fieldType>ibexa_image_asset</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>7</position>\n <isTranslatable>false</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"destinationContentId\"/>\n <value key=\"alternativeText\"/>\n <value key=\"source\"/>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Image</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n</FieldDefinition>\n" } } }, "401": { "description": "Error - The user is not authorized to read the content type." }, "404": { "description": "Error - The content type does not exist." } }, "summary": "Get Field definition", "description": "Returns the Field definition by the given ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Field definition is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "fieldDefinitionId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/types/{contentTypeId}/groups": { "get": { "operationId": "api_contenttypes_contentTypeIdgroups_get", "tags": [ "Type" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ContentTypeGroupRefList+json": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupRefListWrapper" }, "example": { "ContentTypeGroupRefList": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/typegroups/2/types", "ContentTypeGroupRef": [ { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_href": "/api/ibexa/v2/content/typegroups/1", "unlink": { "_href": "/api/ibexa/v2/content/types/2/groups/1", "_method": "DELETE" } }, { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_href": "/api/ibexa/v2/content/typegroups/2", "unlink": { "_href": "/api/ibexa/v2/content/types/2/groups/2", "_method": "DELETE" } } ] } } }, "application/vnd.ibexa.api.ContentTypeGroupRefList+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupRefList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroupRefList media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/typegroups/15/types\">\n <ContentTypeGroupRef media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/1\">\n <unlink href=\"/api/ibexa/v2/content/types/15/groups/1\" method=\"DELETE\"/>\n </ContentTypeGroupRef>\n <ContentTypeGroupRef media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/2\">\n <unlink href=\"/api/ibexa/v2/content/types/15/groups/2\" method=\"DELETE\"/>\n </ContentTypeGroupRef>\n</ContentTypeGroupRefList>\n" } } }, "401": { "description": "Error - The user is not authorized to read this content type." }, "404": { "description": "Error - The content type does not exist." } }, "summary": "Get groups of content type", "description": "Returns the content type group to which content type belongs to.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the content type group list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contenttypes_contentTypeIdgroups_post", "tags": [ "Type" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ContentTypeGroupRefList+json": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupRefListWrapper" }, "example": { "ContentTypeGroupRefList": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/typegroups/2/types", "ContentTypeGroupRef": [ { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_href": "/api/ibexa/v2/content/typegroups/1", "unlink": { "_href": "/api/ibexa/v2/content/types/2/groups/1", "_method": "DELETE" } }, { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_href": "/api/ibexa/v2/content/typegroups/2", "unlink": { "_href": "/api/ibexa/v2/content/types/2/groups/2", "_method": "DELETE" } } ] } } }, "application/vnd.ibexa.api.ContentTypeGroupRefList+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupRefList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroupRefList media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/typegroups/15/types\">\n <ContentTypeGroupRef media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/1\">\n <unlink href=\"/api/ibexa/v2/content/types/15/groups/1\" method=\"DELETE\"/>\n </ContentTypeGroupRef>\n <ContentTypeGroupRef media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/2\">\n <unlink href=\"/api/ibexa/v2/content/types/15/groups/2\" method=\"DELETE\"/>\n </ContentTypeGroupRef>\n</ContentTypeGroupRefList>\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to add a group." }, "403": { "description": "Error - The content type is already assigned to the group." } }, "summary": "Link group to content type", "description": "Links a content type group to the content type and returns the updated group list.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated content type group list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentTypeLinkToGroupController resource", "content": [], "required": false }, "deprecated": false } }, "/content/types/{contentTypeId}/groups/{id}": { "delete": { "operationId": "api_contenttypes_contentTypeIdgroups_id_delete", "tags": [ "Type" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.ContentTypeGroupRefList+json": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupRefListWrapper" }, "example": { "ContentTypeGroupRefList": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/typegroups/2/types", "ContentTypeGroupRef": [ { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_href": "/api/ibexa/v2/content/typegroups/1", "unlink": { "_href": "/api/ibexa/v2/content/types/2/groups/1", "_method": "DELETE" } }, { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_href": "/api/ibexa/v2/content/typegroups/2", "unlink": { "_href": "/api/ibexa/v2/content/types/2/groups/2", "_method": "DELETE" } } ] } } }, "application/vnd.ibexa.api.ContentTypeGroupRefList+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupRefList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroupRefList media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/typegroups/15/types\">\n <ContentTypeGroupRef media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/1\">\n <unlink href=\"/api/ibexa/v2/content/types/15/groups/1\" method=\"DELETE\"/>\n </ContentTypeGroupRef>\n <ContentTypeGroupRef media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/2\">\n <unlink href=\"/api/ibexa/v2/content/types/15/groups/2\" method=\"DELETE\"/>\n </ContentTypeGroupRef>\n</ContentTypeGroupRefList>\n" } } }, "401": { "description": "Error - The user is not authorized to delete this content type." }, "403": { "description": "Error - content type cannot be unlinked from the only remaining group." }, "404": { "description": "Error - The resource does not exist." }, "204": { "description": "ContentTypeUnlinkFromGroupController resource deleted" } }, "summary": "Unlink group from content type", "description": "Removes the given group from the content type and returns the updated group list.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated content type group list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/typegroups": { "get": { "operationId": "api_contenttypegroups_get", "tags": [ "Type Groups" ], "responses": { "200": { "description": "OK - returns a list of content type groups.", "content": { "application/vnd.ibexa.api.ContentTypeGroupList+json": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupListWrapper" }, "example": { "ContentTypeGroupList": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupList+json", "_href": "/api/ibexa/v2/content/typegroups", "ContentTypeGroup": [ { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_href": "/api/ibexa/v2/content/typegroups/1", "id": 1, "identifier": "Content", "created": "2002-09-05T09:08:48+00:00", "modified": "2002-10-06T16:35:06+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "ContentTypes": { "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json", "_href": "/api/ibexa/v2/content/typegroups/1/types" } }, { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_href": "/api/ibexa/v2/content/typegroups/2", "id": 2, "identifier": "Users", "created": "2002-09-05T09:09:01+00:00", "modified": "2002-10-06T16:35:13+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "ContentTypes": { "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json", "_href": "/api/ibexa/v2/content/typegroups/2/types" } }, { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_href": "/api/ibexa/v2/content/typegroups/3", "id": 3, "identifier": "Media", "created": "2002-09-14T13:22:23+00:00", "modified": "2002-10-06T16:35:20+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "ContentTypes": { "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json", "_href": "/api/ibexa/v2/content/typegroups/3/types" } } ] } } }, "application/vnd.ibexa.api.ContentTypeGroupList+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroupList media-type=\"application/vnd.ibexa.api.ContentTypeGroupList+xml\" href=\"/api/ibexa/v2/content/typegroups\">\n <ContentTypeGroup media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/1\">\n <id>1</id>\n <identifier>Content</identifier>\n <created>2002-09-05T11:08:48+02:00</created>\n <modified>2002-10-06T18:35:06+02:00</modified>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <ContentTypes media-type=\"application/vnd.ibexa.api.ContentTypeInfoList+xml\" href=\"/api/ibexa/v2/content/typegroups/1/types\"/>\n </ContentTypeGroup>\n <ContentTypeGroup media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/2\">\n <id>2</id>\n <identifier>Users</identifier>\n <created>2002-09-05T11:09:01+02:00</created>\n <modified>2002-10-06T18:35:13+02:00</modified>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <ContentTypes media-type=\"application/vnd.ibexa.api.ContentTypeInfoList+xml\" href=\"/api/ibexa/v2/content/typegroups/2/types\"/>\n </ContentTypeGroup>\n <ContentTypeGroup media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/3\">\n <id>3</id>\n <identifier>Media</identifier>\n <created>2002-09-14T15:22:23+02:00</created>\n <modified>2002-10-06T18:35:20+02:00</modified>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <ContentTypes media-type=\"application/vnd.ibexa.api.ContentTypeInfoList+xml\" href=\"/api/ibexa/v2/content/typegroups/3/types\"/>\n </ContentTypeGroup>\n</ContentTypeGroupList>\n" } } }, "307": { "description": "Temporary redirect." }, "401": { "description": "Error - The user has no permission to read content types." }, "404": { "description": "Error - The content type group with the given identifier does not exist." } }, "summary": "Get content type groups", "description": "Returns a list of all content type groups. If an identifier is provided, loads the content type group for this identifier.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the content type group list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contenttypegroups_post", "tags": [ "Type Groups" ], "responses": { "201": { "description": "Content type group created.", "content": { "application/vnd.ibexa.api.ContentTypeGroup+json": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupWrapper" }, "example": { "ContentTypeGroup": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_href": "/api/ibexa/v2/content/typegroups/4", "id": 4, "identifier": "updatedIdentifer", "created": "2021-08-11T09:44:18+00:00", "modified": "2021-08-11T10:10:04+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "ContentTypes": { "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json", "_href": "/api/ibexa/v2/content/typegroups/6/types" } } } }, "application/vnd.ibexa.api.ContentTypeGroup+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeGroup" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroup href=\"/content/typesgroups/7\" media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\">\n <id>7</id>\n <identifier>newContentTypeGroup</identifier>\n <created>2012-02-31T12:45:00</created>\n <modified>2012-02-31T12:45:00</modified>\n <Creator href=\"/user/users/13\" media-type=\"application/vnd.ibexa.api.User+xml\"/>\n <Modifier href=\"/user/users/13\" media-type=\"application/vnd.ibexa.api.User+xml\"/>\n <ContentTypes href=\"/content/typegroups/7/types\" media-type=\"application/vnd.ibexa.api.ContentTypeList+xml\"/>\n</ContentTypeGroup>\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to create this content type group." }, "403": { "description": "Error - A content type group with the same identifier already exists." } }, "summary": "Create content type group", "description": "Creates a new content type group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new content type group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The content type group input schema encoded in XML or JSON.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentTypeGroupCreateController resource", "content": { "application/vnd.ibexa.api.ContentTypeGroupInput+json": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupInputWrapper" }, "example": { "ContentTypeGroupInput": { "identifier": "newContentTypeGroup" } } }, "application/vnd.ibexa.api.ContentTypeGroupInput+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupInput" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroupInput>\n <identifier>newContentTypeGroup</identifier>\n</ContentTypeGroupInput>\n" } }, "required": false }, "deprecated": false } }, "/content/typegroups/{contentTypeGroupId}": { "get": { "operationId": "api_contenttypegroups_contentTypeGroupId_get", "tags": [ "Type Groups" ], "responses": { "200": { "description": "OK - returns the content type group.", "content": { "application/vnd.ibexa.api.ContentTypeGroup+json": { "schema": { "$ref": "#/components/schemas/ContentTypeListWrapper" }, "example": { "ContentTypeList": { "_media-type": "application/vnd.ibexa.api.ContentTypeList+json", "_href": "/api/ibexa/v2/content/typegroups/1/types", "ContentType": [ { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2", "id": 2, "status": "DEFINED", "identifier": "article", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Article" } ] }, "descriptions": { "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2004-04-20T09:56:29+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/2/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2/draft" }, "remoteId": "c15b600eb9198b1924063b5a68758232", "urlAliasSchema": null, "nameSchema": "<short_title|title>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": false, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/1", "id": 1, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "New article", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/152", "id": 152, "identifier": "short_title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/153", "id": 153, "identifier": "author", "fieldType": "ibexa_author", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": [], "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Author" } ] }, "descriptions": { "value": [] }, "fieldSettings": { "defaultAuthor": 1 }, "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/120", "id": 120, "identifier": "intro", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Intro" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/121", "id": 121, "identifier": "body", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 5, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Body" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/123", "id": 123, "identifier": "enable_comments", "fieldType": "ibexa_boolean", "fieldGroup": "", "position": 6, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": false, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Enable comments" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/154", "id": 154, "identifier": "image", "fieldType": "ibexa_object_relation", "fieldGroup": "", "position": 7, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "destinationContentId": null }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Image" } ] }, "descriptions": { "value": [] }, "fieldSettings": { "selectionMethod": "SELECTION_BROWSE", "selectionRoot": "", "selectionContentTypes": [] }, "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1", "id": 1, "status": "DEFINED", "identifier": "folder", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Folder" } ] }, "descriptions": { "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2015-11-29T21:14:32+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/1/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1/draft" }, "remoteId": "a3d405b81be900468eb153d774f4f0d2", "urlAliasSchema": null, "nameSchema": "<short_name|name>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/4", "id": 4, "identifier": "name", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "Folder", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Name" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/155", "id": 155, "identifier": "short_name", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short name" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 100, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/119", "id": 119, "identifier": "short_description", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short description" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/156", "id": 156, "identifier": "description", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Description" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/43", "id": 43, "status": "DEFINED", "identifier": "form", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Form" } ] }, "descriptions": { "value": [] }, "creationDate": "2018-09-17T06:46:13+00:00", "modificationDate": "2018-09-17T06:47:14+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/43/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/43/draft" }, "remoteId": "6f7f21df775a33c1e4bbc76b48c38476", "urlAliasSchema": "", "nameSchema": "<title>", "isContainer": false, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PUBLISHED", "defaultSortOrder": "DESC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions/188", "id": 188, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions/189", "id": 189, "identifier": "form", "fieldType": "ibexa_form", "fieldGroup": "content", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "fields": [], "content_id": null, "content_field_id": null, "language_code": null }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Form" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/42", "id": 42, "status": "DEFINED", "identifier": "landing_page", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] }, "creationDate": "2015-07-03T12:00:26+00:00", "modificationDate": "2015-07-03T12:00:26+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/42/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/42/draft" }, "remoteId": "60c03e9758465eb69d56b3afb6adf18e", "urlAliasSchema": "", "nameSchema": "<name>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PUBLISHED", "defaultSortOrder": "DESC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/185", "id": 185, "identifier": "name", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 10, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/186", "id": 186, "identifier": "description", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 20, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Description" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page description" } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/187", "id": 187, "identifier": "page", "fieldType": "ibexa_landing_page", "fieldGroup": "content", "position": 30, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "layout": "default", "zones": [ { "id": "default_id", "name": "default", "blocks": [] } ] }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "fieldSettings": { "availableBlocks": null, "availableLayouts": null, "editorMode": "page_view_mode" }, "validatorConfiguration": [] } ] } } ] } } }, "application/vnd.ibexa.api.ContentTypeGroup+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeList media-type=\"application/vnd.ibexa.api.ContentTypeList+xml\" href=\"/api/ibexa/v2/content/typegroups/1/types\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/2\">\n <id>2</id>\n <status>DEFINED</status>\n <identifier>article</identifier>\n <names>\n <value languageCode=\"eng-GB\">Article</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T09:21:38+00:00</creationDate>\n <modificationDate>2004-04-20T09:56:29+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/2/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/2/draft\"/>\n <remoteId>c15b600eb9198b1924063b5a68758232</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_title|title></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>false</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/1\">\n <id>1</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>New article</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/152\">\n <id>152</id>\n <identifier>short_title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/153\">\n <id>153</id>\n <identifier>author</identifier>\n <fieldType>ibexa_author</fieldType>\n <fieldGroup></fieldGroup>\n <position>3</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Author</value>\n </names>\n <descriptions/>\n <fieldSettings>\n <value key=\"defaultAuthor\">1</value>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/120\">\n <id>120</id>\n <identifier>intro</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>4</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Intro</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/121\">\n <id>121</id>\n <identifier>body</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>5</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Body</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/123\">\n <id>123</id>\n <identifier>enable_comments</identifier>\n <fieldType>ibexa_boolean</fieldType>\n <fieldGroup></fieldGroup>\n <position>6</position>\n <isTranslatable>false</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>false</defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Enable comments</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/154\">\n <id>154</id>\n <identifier>image</identifier>\n <fieldType>ibexa_object_relation</fieldType>\n <fieldGroup></fieldGroup>\n <position>7</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"destinationContentId\"/>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Image</value>\n </names>\n <descriptions/>\n <fieldSettings>\n <value key=\"selectionMethod\">SELECTION_BROWSE</value>\n <value key=\"selectionRoot\"></value>\n <value key=\"selectionContentTypes\"/>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1\">\n <id>1</id>\n <status>DEFINED</status>\n <identifier>folder</identifier>\n <names>\n <value languageCode=\"eng-GB\">Folder</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T09:21:38+00:00</creationDate>\n <modificationDate>2015-11-29T21:14:32+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/1/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1/draft\"/>\n <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_name|name></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/4\">\n <id>4</id>\n <identifier>name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>Folder</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Name</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/155\">\n <id>155</id>\n <identifier>short_name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short name</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">100</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/119\">\n <id>119</id>\n <identifier>short_description</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>3</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short description</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/156\">\n <id>156</id>\n <identifier>description</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>4</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Description</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/43\">\n <id>43</id>\n <status>DEFINED</status>\n <identifier>form</identifier>\n <names>\n <value languageCode=\"eng-GB\">Form</value>\n </names>\n <descriptions/>\n <creationDate>2018-09-17T06:46:13+00:00</creationDate>\n <modificationDate>2018-09-17T06:47:14+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/43/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/43/draft\"/>\n <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><title></nameSchema>\n <isContainer>false</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PUBLISHED</defaultSortField>\n <defaultSortOrder>DESC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions/188\">\n <id>188</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions/189\">\n <id>189</id>\n <identifier>form</identifier>\n <fieldType>ibexa_form</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"fields\"/>\n <value key=\"content_id\"/>\n <value key=\"content_field_id\"/>\n <value key=\"language_code\"/>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Form</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/42\">\n <id>42</id>\n <status>DEFINED</status>\n <identifier>landing_page</identifier>\n <names>\n <value languageCode=\"eng-GB\">Landing page</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2015-07-03T12:00:26+00:00</creationDate>\n <modificationDate>2015-07-03T12:00:26+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/42/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/42/draft\"/>\n <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><name></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PUBLISHED</defaultSortField>\n <defaultSortOrder>DESC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/185\">\n <id>185</id>\n <identifier>name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>10</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Title</value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/186\">\n <id>186</id>\n <identifier>description</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>20</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Description</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Landing page description</value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/187\">\n <id>187</id>\n <identifier>page</identifier>\n <fieldType>ibexa_landing_page</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>30</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"layout\">default</value>\n <value key=\"zones\">\n <value>\n <value key=\"id\">default_id</value>\n <value key=\"name\">default</value>\n <value key=\"blocks\"/></value>\n </value>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Landing page</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Landing page</value>\n </descriptions>\n <fieldSettings>\n <value key=\"availableBlocks\"/>\n <value key=\"availableLayouts\"/>\n <value key=\"editorMode\">page_view_mode</value>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n</ContentTypeList>\n" } } }, "401": { "description": "Error - The user is not authorized to read this content type group." }, "404": { "description": "Error - The content type group does not exist." } }, "summary": "Get content type group", "description": "Returns the content type group with provided ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the content type group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contenttypegroups_contentTypeGroupId_delete", "tags": [ "Type Groups" ], "responses": { "204": { "description": "No Content - content type group deleted." }, "401": { "description": "Error - The user is not authorized to delete this content type group." }, "403": { "description": "Error - The content type group is not empty." }, "404": { "description": "Error - The content type group does not exist." } }, "summary": "Delete content type group", "description": "Deletes the provided content type group.", "parameters": [ { "name": "contentTypeGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_contenttypegroups_contentTypeGroupId_patch", "tags": [ "Type Groups" ], "responses": { "200": { "description": "Content type group updated.", "content": { "application/vnd.ibexa.api.ContentTypeGroup+json": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupWrapper" }, "example": { "ContentTypeGroup": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", "_href": "/api/ibexa/v2/content/typegroups/4", "id": 4, "identifier": "updatedIdentifer", "created": "2021-08-11T09:44:18+00:00", "modified": "2021-08-11T10:10:04+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "ContentTypes": { "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json", "_href": "/api/ibexa/v2/content/typegroups/6/types" } } } }, "application/vnd.ibexa.api.ContentTypeGroup+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeGroup" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroup href=\"/content/typesgroups/7\" media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\">\n <id>7</id>\n <identifier>newContentTypeGroup</identifier>\n <created>2012-02-31T12:45:00</created>\n <modified>2012-02-31T12:45:00</modified>\n <Creator href=\"/user/users/13\" media-type=\"application/vnd.ibexa.api.User+xml\"/>\n <Modifier href=\"/user/users/13\" media-type=\"application/vnd.ibexa.api.User+xml\"/>\n <ContentTypes href=\"/content/typegroups/7/types\" media-type=\"application/vnd.ibexa.api.ContentTypeList+xml\"/>\n</ContentTypeGroup>\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to create this content type group." }, "403": { "description": "Error - A content type group with the given identifier already exists." }, "412": { "description": "Error - The current ETag does not match the one provided in the If-Match header." } }, "summary": "Update content type group", "description": "Updates a content type group. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated content type group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The content type group input schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "ETag causes patching only if the specified ETag is the current one. Otherwise a 412 is returned.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated ContentTypeGroupUpdateController resource", "content": { "application/vnd.ibexa.api.ContentTypeGroupInput+json": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupInputWrapper" }, "example": { "ContentTypeGroupInput": { "identifier": "newContentTypeGroup" } } }, "application/vnd.ibexa.api.ContentTypeGroupInput+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeGroupInput" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroupInput>\n <identifier>newContentTypeGroup</identifier>\n</ContentTypeGroupInput>\n" } }, "required": false }, "deprecated": false } }, "/content/typegroups/{contentTypeGroupId}/types": { "get": { "operationId": "api_contenttypegroups_contentTypeGroupIdtypes_get", "tags": [ "Type Groups" ], "responses": { "200": { "description": "OK - returns a list on content types.", "content": { "application/vnd.ibexa.api.ContentTypeInfoList+json": { "schema": { "$ref": "#/components/schemas/ContentTypeInfoListWrapper" }, "example": { "ContentTypeList": { "_media-type": "application/vnd.ibexa.api.ContentTypeList+json", "_href": "/api/ibexa/v2/content/typegroups/1/types", "ContentType": [ { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2", "id": 2, "status": "DEFINED", "identifier": "article", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Article" } ] }, "descriptions": { "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2004-04-20T09:56:29+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/2/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2/draft" }, "remoteId": "c15b600eb9198b1924063b5a68758232", "urlAliasSchema": null, "nameSchema": "<short_title|title>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": false, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/1", "id": 1, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "New article", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/152", "id": 152, "identifier": "short_title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/153", "id": 153, "identifier": "author", "fieldType": "ibexa_author", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": [], "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Author" } ] }, "descriptions": { "value": [] }, "fieldSettings": { "defaultAuthor": 1 }, "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/120", "id": 120, "identifier": "intro", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Intro" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/121", "id": 121, "identifier": "body", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 5, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Body" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/123", "id": 123, "identifier": "enable_comments", "fieldType": "ibexa_boolean", "fieldGroup": "", "position": 6, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": false, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Enable comments" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/154", "id": 154, "identifier": "image", "fieldType": "ibexa_object_relation", "fieldGroup": "", "position": 7, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "destinationContentId": null }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Image" } ] }, "descriptions": { "value": [] }, "fieldSettings": { "selectionMethod": "SELECTION_BROWSE", "selectionRoot": "", "selectionContentTypes": [] }, "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1", "id": 1, "status": "DEFINED", "identifier": "folder", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Folder" } ] }, "descriptions": { "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2015-11-29T21:14:32+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/1/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1/draft" }, "remoteId": "a3d405b81be900468eb153d774f4f0d2", "urlAliasSchema": null, "nameSchema": "<short_name|name>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/4", "id": 4, "identifier": "name", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "Folder", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Name" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/155", "id": 155, "identifier": "short_name", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short name" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 100, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/119", "id": 119, "identifier": "short_description", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short description" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/156", "id": 156, "identifier": "description", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Description" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/43", "id": 43, "status": "DEFINED", "identifier": "form", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Form" } ] }, "descriptions": { "value": [] }, "creationDate": "2018-09-17T06:46:13+00:00", "modificationDate": "2018-09-17T06:47:14+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/43/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/43/draft" }, "remoteId": "6f7f21df775a33c1e4bbc76b48c38476", "urlAliasSchema": "", "nameSchema": "<title>", "isContainer": false, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PUBLISHED", "defaultSortOrder": "DESC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions/188", "id": 188, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions/189", "id": 189, "identifier": "form", "fieldType": "ibexa_form", "fieldGroup": "content", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "fields": [], "content_id": null, "content_field_id": null, "language_code": null }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Form" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/42", "id": 42, "status": "DEFINED", "identifier": "landing_page", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] }, "creationDate": "2015-07-03T12:00:26+00:00", "modificationDate": "2015-07-03T12:00:26+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/42/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/42/draft" }, "remoteId": "60c03e9758465eb69d56b3afb6adf18e", "urlAliasSchema": "", "nameSchema": "<name>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PUBLISHED", "defaultSortOrder": "DESC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/185", "id": 185, "identifier": "name", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 10, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/186", "id": 186, "identifier": "description", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 20, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Description" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page description" } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/187", "id": 187, "identifier": "page", "fieldType": "ibexa_landing_page", "fieldGroup": "content", "position": 30, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "layout": "default", "zones": [ { "id": "default_id", "name": "default", "blocks": [] } ] }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "fieldSettings": { "availableBlocks": null, "availableLayouts": null, "editorMode": "page_view_mode" }, "validatorConfiguration": [] } ] } } ] } } }, "application/vnd.ibexa.api.ContentTypeInfoList+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeInfoList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeInfoList media-type=\"application/vnd.ibexa.api.ContentTypeInfoList+xml\" href=\"/api/ibexa/v2/content/typegroups/1/types\">\n <ContentTypeInfo media-type=\"application/vnd.ibexa.api.ContentTypeInfo+xml\" href=\"/api/ibexa/v2/content/types/2\">\n <id>2</id>\n <status>DEFINED</status>\n <identifier>article</identifier>\n <names>\n <value languageCode=\"eng-GB\">Article</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T11:21:38+02:00</creationDate>\n <modificationDate>2004-04-20T11:56:29+02:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/2/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/2/draft\"/>\n <remoteId>c15b600eb9198b1924063b5a68758232</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_title|title></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>false</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n </ContentTypeInfo>\n <ContentTypeInfo media-type=\"application/vnd.ibexa.api.ContentTypeInfo+xml\" href=\"/api/ibexa/v2/content/types/1\">\n <id>1</id>\n <status>DEFINED</status>\n <identifier>folder</identifier>\n <names>\n <value languageCode=\"eng-GB\">Folder</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T11:21:38+02:00</creationDate>\n <modificationDate>2015-11-29T22:14:32+01:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/1/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1/draft\"/>\n <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_name|name></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n </ContentTypeInfo>\n</ContentTypeInfoList>\n" }, "application/vnd.ibexa.api.ContentTypeList+json": { "schema": { "$ref": "#/components/schemas/ContentTypeListWrapper" }, "example": { "ContentTypeList": { "_media-type": "application/vnd.ibexa.api.ContentTypeList+json", "_href": "/api/ibexa/v2/content/typegroups/1/types", "ContentType": [ { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2", "id": 2, "status": "DEFINED", "identifier": "article", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Article" } ] }, "descriptions": { "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2004-04-20T09:56:29+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/2/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/2/draft" }, "remoteId": "c15b600eb9198b1924063b5a68758232", "urlAliasSchema": null, "nameSchema": "<short_title|title>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": false, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/1", "id": 1, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "New article", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/152", "id": 152, "identifier": "short_title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/153", "id": 153, "identifier": "author", "fieldType": "ibexa_author", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": [], "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Author" } ] }, "descriptions": { "value": [] }, "fieldSettings": { "defaultAuthor": 1 }, "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/120", "id": 120, "identifier": "intro", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Intro" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/121", "id": 121, "identifier": "body", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 5, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Body" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/123", "id": 123, "identifier": "enable_comments", "fieldType": "ibexa_boolean", "fieldGroup": "", "position": 6, "isTranslatable": false, "isRequired": false, "isInfoCollector": false, "defaultValue": false, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Enable comments" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/154", "id": 154, "identifier": "image", "fieldType": "ibexa_object_relation", "fieldGroup": "", "position": 7, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "destinationContentId": null }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Image" } ] }, "descriptions": { "value": [] }, "fieldSettings": { "selectionMethod": "SELECTION_BROWSE", "selectionRoot": "", "selectionContentTypes": [] }, "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1", "id": 1, "status": "DEFINED", "identifier": "folder", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Folder" } ] }, "descriptions": { "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", "modificationDate": "2015-11-29T21:14:32+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/1/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/1/draft" }, "remoteId": "a3d405b81be900468eb153d774f4f0d2", "urlAliasSchema": null, "nameSchema": "<short_name|name>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/4", "id": 4, "identifier": "name", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "Folder", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Name" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/155", "id": 155, "identifier": "short_name", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short name" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": 100, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/119", "id": 119, "identifier": "short_description", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Short description" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/156", "id": 156, "identifier": "description", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Description" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/43", "id": 43, "status": "DEFINED", "identifier": "form", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Form" } ] }, "descriptions": { "value": [] }, "creationDate": "2018-09-17T06:46:13+00:00", "modificationDate": "2018-09-17T06:47:14+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/43/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/43/draft" }, "remoteId": "6f7f21df775a33c1e4bbc76b48c38476", "urlAliasSchema": "", "nameSchema": "<title>", "isContainer": false, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PUBLISHED", "defaultSortOrder": "DESC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions/188", "id": 188, "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/43/fieldDefinitions/189", "id": 189, "identifier": "form", "fieldType": "ibexa_form", "fieldGroup": "content", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "fields": [], "content_id": null, "content_field_id": null, "language_code": null }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Form" } ] }, "descriptions": { "value": [] }, "fieldSettings": [], "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/42", "id": 42, "status": "DEFINED", "identifier": "landing_page", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "" } ] }, "creationDate": "2015-07-03T12:00:26+00:00", "modificationDate": "2015-07-03T12:00:26+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Modifier": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", "_href": "/api/ibexa/v2/content/types/42/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/42/draft" }, "remoteId": "60c03e9758465eb69d56b3afb6adf18e", "urlAliasSchema": "", "nameSchema": "<name>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PUBLISHED", "defaultSortOrder": "DESC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/185", "id": 185, "identifier": "name", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 10, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/186", "id": 186, "identifier": "description", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 20, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Description" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page description" } ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/187", "id": 187, "identifier": "page", "fieldType": "ibexa_landing_page", "fieldGroup": "content", "position": 30, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { "layout": "default", "zones": [ { "id": "default_id", "name": "default", "blocks": [] } ] }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "Landing page" } ] }, "fieldSettings": { "availableBlocks": null, "availableLayouts": null, "editorMode": "page_view_mode" }, "validatorConfiguration": [] } ] } } ] } } }, "application/vnd.ibexa.api.ContentTypeList+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeList media-type=\"application/vnd.ibexa.api.ContentTypeList+xml\" href=\"/api/ibexa/v2/content/typegroups/1/types\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/2\">\n <id>2</id>\n <status>DEFINED</status>\n <identifier>article</identifier>\n <names>\n <value languageCode=\"eng-GB\">Article</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T09:21:38+00:00</creationDate>\n <modificationDate>2004-04-20T09:56:29+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/2/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/2/draft\"/>\n <remoteId>c15b600eb9198b1924063b5a68758232</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_title|title></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>false</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/1\">\n <id>1</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>New article</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/152\">\n <id>152</id>\n <identifier>short_title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/153\">\n <id>153</id>\n <identifier>author</identifier>\n <fieldType>ibexa_author</fieldType>\n <fieldGroup></fieldGroup>\n <position>3</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Author</value>\n </names>\n <descriptions/>\n <fieldSettings>\n <value key=\"defaultAuthor\">1</value>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/120\">\n <id>120</id>\n <identifier>intro</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>4</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Intro</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/121\">\n <id>121</id>\n <identifier>body</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>5</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Body</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/123\">\n <id>123</id>\n <identifier>enable_comments</identifier>\n <fieldType>ibexa_boolean</fieldType>\n <fieldGroup></fieldGroup>\n <position>6</position>\n <isTranslatable>false</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>false</defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Enable comments</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/2/fieldDefinitions/154\">\n <id>154</id>\n <identifier>image</identifier>\n <fieldType>ibexa_object_relation</fieldType>\n <fieldGroup></fieldGroup>\n <position>7</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"destinationContentId\"/>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Image</value>\n </names>\n <descriptions/>\n <fieldSettings>\n <value key=\"selectionMethod\">SELECTION_BROWSE</value>\n <value key=\"selectionRoot\"></value>\n <value key=\"selectionContentTypes\"/>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1\">\n <id>1</id>\n <status>DEFINED</status>\n <identifier>folder</identifier>\n <names>\n <value languageCode=\"eng-GB\">Folder</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T09:21:38+00:00</creationDate>\n <modificationDate>2015-11-29T21:14:32+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/1/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1/draft\"/>\n <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_name|name></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/4\">\n <id>4</id>\n <identifier>name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>Folder</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Name</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/155\">\n <id>155</id>\n <identifier>short_name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short name</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">100</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/119\">\n <id>119</id>\n <identifier>short_description</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>3</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Short description</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/1/fieldDefinitions/156\">\n <id>156</id>\n <identifier>description</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup></fieldGroup>\n <position>4</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/>\n</value>\n <value key=\"xhtml5edit\"><?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/>\n</value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Description</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/43\">\n <id>43</id>\n <status>DEFINED</status>\n <identifier>form</identifier>\n <names>\n <value languageCode=\"eng-GB\">Form</value>\n </names>\n <descriptions/>\n <creationDate>2018-09-17T06:46:13+00:00</creationDate>\n <modificationDate>2018-09-17T06:47:14+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/43/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/43/draft\"/>\n <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><title></nameSchema>\n <isContainer>false</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PUBLISHED</defaultSortField>\n <defaultSortOrder>DESC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions/188\">\n <id>188</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/43/fieldDefinitions/189\">\n <id>189</id>\n <identifier>form</identifier>\n <fieldType>ibexa_form</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"fields\"/>\n <value key=\"content_id\"/>\n <value key=\"content_field_id\"/>\n <value key=\"language_code\"/>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Form</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/42\">\n <id>42</id>\n <status>DEFINED</status>\n <identifier>landing_page</identifier>\n <names>\n <value languageCode=\"eng-GB\">Landing page</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2015-07-03T12:00:26+00:00</creationDate>\n <modificationDate>2015-07-03T12:00:26+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/42/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/42/draft\"/>\n <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><name></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PUBLISHED</defaultSortField>\n <defaultSortOrder>DESC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/185\">\n <id>185</id>\n <identifier>name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>10</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Title</value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/186\">\n <id>186</id>\n <identifier>description</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>20</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Description</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Landing page description</value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/42/fieldDefinitions/187\">\n <id>187</id>\n <identifier>page</identifier>\n <fieldType>ibexa_landing_page</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>30</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"layout\">default</value>\n <value key=\"zones\">\n <value>\n <value key=\"id\">default_id</value>\n <value key=\"name\">default</value>\n <value key=\"blocks\"/></value>\n </value>\n </defaultValue>\n <isSearchable>false</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Landing page</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">Landing page</value>\n </descriptions>\n <fieldSettings>\n <value key=\"availableBlocks\"/>\n <value key=\"availableLayouts\"/>\n <value key=\"editorMode\">page_view_mode</value>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n </FieldDefinitions>\n </ContentType>\n</ContentTypeList>\n" } } }, "401": { "description": "Error - The user has no permission to read the content types." } }, "summary": "List content types for group", "description": "Returns a list of content types in the provided group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the list of content type info objects or content types (including Field definitions) is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contenttypegroups_contentTypeGroupIdtypes_post", "tags": [ "Type Groups" ], "responses": { "201": { "description": "Content type created.", "content": { "application/vnd.ibexa.api.ContentType+json": { "schema": { "$ref": "#/components/schemas/ContentTypeWrapper" } }, "application/vnd.ibexa.api.ContentType+xml": { "schema": { "$ref": "#/components/schemas/ContentType" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/14\">\n <id>14</id>\n <status>DEFINED</status>\n <identifier>copy_of_article_14</identifier>\n <names>\n <value languageCode=\"eng-GB\">Updated content type name</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">This is an updated content type description</value>\n </descriptions>\n <creationDate>2019-02-06T10:56:36+01:00</creationDate>\n <modificationDate>2019-02-25T12:15:51+01:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Modifier media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <Groups media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/types/14/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/14/draft\"/>\n <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><short_title|title></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <defaultAlwaysAvailable>false</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions media-type=\"application/vnd.ibexa.api.FieldDefinitionList+xml\" href=\"/api/ibexa/v2/content/types/14/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/14/fieldDefinitions/188\">\n <id>188</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>New article</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n </FieldDefinitions>\n</ContentType>\n" } } }, "400": { "description": "Error - The input does not match the input schema definition. Validation on a Field definition fails. Validation of the content type fails, e.g. multiple Fields of a same singular Field Type are provided. Publish is set to true and the input is not complete e.g. no Field definitions are provided." }, "401": { "description": "Error - The user is not authorized to create this content type." }, "403": { "description": "Error - A content type with same identifier already exists." } }, "summary": "Create content type", "description": "Creates a new content type draft in the given content type group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new content type or draft is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The content type Create schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "contentTypeGroupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ContentTypeCreateController resource", "content": { "application/vnd.ibexa.api.ContentTypeCreate+json": { "schema": { "$ref": "#/components/schemas/ContentTypeCreateWrapper" }, "example": { "ContentTypeCreate": { "identifier": "new_content_type", "names": { "value": [ { "_languageCode": "eng-GB", "#text": "New content type" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "This is a description" } ] }, "remoteId": "remoteId-qwerty548", "urlAliasSchema": "<title>", "nameSchema": "<title>", "isContainer": true, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "FieldDefinition": [ { "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "content", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, "defaultValue": "New Title", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Title" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "This is the title" } ] } }, { "identifier": "summary", "fieldType": "ibexa_richtext", "fieldGroup": "content", "position": 2, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Summary" } ] }, "descriptions": { "value": [ { "_languageCode": "eng-GB", "#text": "This is the summary" } ] } } ] } } } }, "application/vnd.ibexa.api.ContentTypeCreate+xml": { "schema": { "$ref": "#/components/schemas/ContentTypeCreate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeCreate>\n <identifier>newContentType</identifier>\n <names>\n <value languageCode=\"eng-US\">New content type</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-US\">This is a description</value>\n </descriptions>\n <remoteId>remoteId-qwert548</remoteId>\n <urlAliasSchema><title></urlAliasSchema>\n <nameSchema><title></nameSchema>\n <isContainer>true</isContainer>\n <mainLanguageCode>eng-US</mainLanguageCode>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n <defaultSortField>PATH</defaultSortField>\n <defaultSortOrder>ASC</defaultSortOrder>\n <FieldDefinitions>\n <FieldDefinition>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>1</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>New Title</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-US\">Title</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-US\">This is the title</value>\n </descriptions>\n </FieldDefinition>\n <FieldDefinition>\n <identifier>summary</identifier>\n <fieldType>ezxmltext</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>2</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>false</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue>\n <value key=\"xml\"><?xml version="1.0" encoding="utf-8"?><section/></value>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-US\">Summary</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-US\">This is the summary</value>\n </descriptions>\n </FieldDefinition>\n </FieldDefinitions>\n</ContentTypeCreate>\n" } }, "required": false }, "deprecated": false } }, "/content/urlaliases": { "get": { "operationId": "api_contenturlaliases_get", "tags": [ "Url Alias" ], "responses": { "200": { "description": "OK - returns the list of URL aliases.", "content": { "application/vnd.ibexa.api.UrlAliasRefList+json": { "schema": { "$ref": "#/components/schemas/UrlAliasRefListWrapper" }, "example": { "UrlAliasRefList": { "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", "_href": "/api/ibexa/v2/content/urlaliases", "UrlAlias": [ { "_media-type": "application/vnd.ibexa.api.UrlAlias+json", "_href": "/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36" } ] } } }, "application/vnd.ibexa.api.UrlAliasRefList+xml": { "schema": { "$ref": "#/components/schemas/UrlAliasRefList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UrlAliasRefList media-type=\"application/vnd.ibexa.api.UrlAliasRefList+xml\" href=\"/api/ibexa/v2/content/urlaliases\">\n <UrlAlias media-type=\"application/vnd.ibexa.api.UrlAlias+xml\" href=\"/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36\" />\n</UrlAliasRefList>\n" } } }, "401": { "description": "Error - The user has no permission to read URL aliases." } }, "summary": "List global URL aliases", "description": "Returns the list of global URL aliases.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the URL alias list contains only references and is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contenturlaliases_post", "tags": [ "Url Alias" ], "responses": { "201": { "description": "URL alias created.", "content": { "application/vnd.ibexa.api.UrlAlias+json": { "schema": { "$ref": "#/components/schemas/UrlAliasWrapper" }, "example": { "UrlAlias": { "_media-type": "application/vnd.ibexa.api.UrlAlias+json", "_href": "/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36", "_id": "0-2cecdff5f90b8595d76b68c417b09f36", "_type": "RESOURCE", "resource": "content/view/full", "path": "/example-global", "languageCodes": "eng-GB", "alwaysAvailable": true, "isHistory": false, "forward": true, "custom": true } } }, "application/vnd.ibexa.api.UrlAlias+xml": { "schema": { "$ref": "#/components/schemas/UrlAlias" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UrlAlias media-type=\"application/vnd.ibexa.api.UrlAlias+xml\" href=\"/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36\" id=\"0-2cecdff5f90b8595d76b68c417b09f36\" type=\"RESOURCE\">\n <resource>content/view/full</resource>\n <path>/example-global</path>\n <languageCodes>eng-GB</languageCodes>\n <alwaysAvailable>true</alwaysAvailable>\n <isHistory>false</isHistory>\n <forward>true</forward>\n <custom>true</custom>\n</UrlAlias>\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to create a URL alias." }, "403": { "description": "Error - A URL alias with the same identifier already exists." } }, "summary": "Create URL alias", "description": "Creates a URL alias.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the created URL alias is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The URL alias input schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new URLAliasCreateController resource", "content": { "application/vnd.ibexa.api.UrlAliasCreate+json": { "schema": { "$ref": "#/components/schemas/UrlAliasCreateWrapper" }, "example": { "UrlAliasCreate": { "_type": "GLOBAL", "resource": "module:content/view/full", "path": "example-global", "languageCode": "eng-GB", "alwaysAvailable": "true", "forward": "true" } } }, "application/vnd.ibexa.api.UrlAliasCreate+xml": { "schema": { "$ref": "#/components/schemas/UrlAliasCreate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UrlAliasCreate type=\"LOCATION\">\n <location href='/api/ibexa/v2/content/locations/1/2/59' />\n <path>example-global</path>\n <languageCode>eng-GB</languageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <forward>true</forward>\n</UrlAliasCreate>\n" } }, "required": false }, "deprecated": false } }, "/content/urlaliases/{urlAliasId}": { "get": { "operationId": "api_contenturlaliases_urlAliasId_get", "tags": [ "Url Alias" ], "responses": { "200": { "description": "OK - returns the URL alias.", "content": { "application/vnd.ibexa.api.UrlAlias+json": { "schema": { "$ref": "#/components/schemas/UrlAliasWrapper" }, "example": { "UrlAlias": { "_media-type": "application/vnd.ibexa.api.UrlAlias+json", "_href": "/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36", "_id": "0-2cecdff5f90b8595d76b68c417b09f36", "_type": "RESOURCE", "resource": "content/view/full", "path": "/example-global", "languageCodes": "eng-GB", "alwaysAvailable": true, "isHistory": false, "forward": true, "custom": true } } }, "application/vnd.ibexa.api.UrlAlias+xml": { "schema": { "$ref": "#/components/schemas/UrlAlias" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UrlAlias media-type=\"application/vnd.ibexa.api.UrlAlias+xml\" href=\"/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36\" id=\"0-2cecdff5f90b8595d76b68c417b09f36\" type=\"RESOURCE\">\n <resource>content/view/full</resource>\n <path>/example-global</path>\n <languageCodes>eng-GB</languageCodes>\n <alwaysAvailable>true</alwaysAvailable>\n <isHistory>false</isHistory>\n <forward>true</forward>\n <custom>true</custom>\n</UrlAlias>\n" } } }, "401": { "description": "Error - The user is not authorized to read URL aliases." }, "404": { "description": "Error - The URL alias does not exist." } }, "summary": "Get URL alias", "description": "Returns the URL alias with the given ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the URL alias is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "urlAliasId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contenturlaliases_urlAliasId_delete", "tags": [ "Url Alias" ], "responses": { "204": { "description": "No Content - URL alias deleted." }, "401": { "description": "Error - The user is not authorized to delete a URL alias." }, "404": { "description": "Error - The URL alias does not exist." } }, "summary": "Delete URL alias", "description": "Deletes the provided URL alias.", "parameters": [ { "name": "urlAliasId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/content/urlwildcards": { "get": { "operationId": "api_contenturlwildcards_get", "tags": [ "Url Wildcard" ], "responses": { "200": { "description": "OK - returns a list of URL wildcards.", "content": { "application/vnd.ibexa.api.UrlWildcardList+json": { "schema": { "$ref": "#/components/schemas/UrlWildcardListWrapper" }, "example": { "UrlWildcardList": { "_media-type": "application/vnd.ibexa.api.UrlWildcardList+json", "_href": "/api/ibexa/v2/content/urlwildcards", "UrlWildcard": [ { "_media-type": "application/vnd.ibexa.api.UrlWildcard+json", "_href": "/api/ibexa/v2/content/urlwildcards/1", "_id": 1, "sourceUrl": "/api/ibexa/v2/content/location/2", "destinationUrl": "/api/ibexa/v2/content/location/59", "forward": true } ] } } }, "application/vnd.ibexa.api.UrlWildcardList+xml": { "schema": { "$ref": "#/components/schemas/UrlWildcardList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UrlWildcardList media-type=\"application/vnd.ibexa.api.UrlWildcardList+xml\" href=\"/api/ibexa/v2/content/urlwildcards\">\n <UrlWildcard media-type=\"application/vnd.ibexa.api.UrlWildcard+xml\" href=\"/api/ibexa/v2/content/urlwildcards/1\" id=\"1\">\n <sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl>\n <destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl>\n <forward>true</forward>\n </UrlWildcard>\n</UrlWildcardList>\n" } } }, "401": { "description": "Error - The user has no permission to read URL wildcards." } }, "summary": "List URL wildcards", "description": "Returns a list of URL wildcards.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the URL wildcard is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_contenturlwildcards_post", "tags": [ "Url Wildcard" ], "responses": { "201": { "description": "URL wildcard created.", "content": { "application/vnd.ibexa.api.UrlWildcard+json": { "schema": { "$ref": "#/components/schemas/UrlWildcardWrapper" }, "example": { "UrlWildcard": { "_media-type": "application/vnd.ibexa.api.UrlWildcard+json", "_href": "/api/ibexa/v2/content/urlwildcards/4", "_id": 4, "sourceUrl": "/api/ibexa/v2/content/location/2", "destinationUrl": "/api/ibexa/v2/content/location/59", "forward": true } } }, "application/vnd.ibexa.api.UrlWildcard+xml": { "schema": { "$ref": "#/components/schemas/UrlWildcard" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UrlWildcard media-type=\"application/vnd.ibexa.api.UrlWildcard+xml\" href=\"/api/ibexa/v2/content/urlwildcards/4\" id=\"4\">\n <sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl>\n <destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl>\n <forward>true</forward>\n</UrlWildcard>\n" } } }, "400": { "description": "Error - The input does not match the input schema definition." }, "401": { "description": "Error - The user is not authorized to create a URL wildcard." }, "403": { "description": "Error - A URL wildcard with the same identifier already exists." } }, "summary": "Create URL wildcard", "description": "Creates a new URL wildcard.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new URL wildcard is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The URL Wildcard input schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new URLWildcardCreateController resource", "content": { "application/vnd.ibexa.api.UrlWildcardCreate+json": { "schema": { "$ref": "#/components/schemas/UrlWildcardCreateWrapper" }, "example": { "URLWildcardCreate": { "sourceUrl": "/api/ibexa/v2/content/location/2", "destinationUrl": "/api/ibexa/v2/content/location/59", "forward": true } } }, "application/vnd.ibexa.api.UrlWildcardCreate+xml": { "schema": { "$ref": "#/components/schemas/UrlWildcardCreate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <UrlWildcardCreate>\n \t<sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl>\n \t<destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl>\n \t<forward>true</forward>\n</UrlWildcardCreate>\n" } }, "required": false }, "deprecated": false } }, "/content/urlwildcards/{wildcardId}": { "get": { "operationId": "api_contenturlwildcards_wildcardId_get", "tags": [ "Url Wildcard" ], "responses": { "200": { "description": "OK - returns the URL wildcard.", "content": { "application/vnd.ibexa.api.UrlWildcard+json": { "schema": { "$ref": "#/components/schemas/UrlWildcardWrapper" }, "example": { "UrlWildcard": { "_media-type": "application/vnd.ibexa.api.UrlWildcard+json", "_href": "/api/ibexa/v2/content/urlwildcards/4", "_id": 4, "sourceUrl": "/api/ibexa/v2/content/location/2", "destinationUrl": "/api/ibexa/v2/content/location/59", "forward": true } } }, "application/vnd.ibexa.api.UrlWildcard+xml": { "schema": { "$ref": "#/components/schemas/UrlWildcard" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UrlWildcard media-type=\"application/vnd.ibexa.api.UrlWildcard+xml\" href=\"/api/ibexa/v2/content/urlwildcards/4\" id=\"4\">\n <sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl>\n <destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl>\n <forward>true</forward>\n</UrlWildcard>\n" } } }, "401": { "description": "Error - The user is not authorized to read URL wildcards." }, "404": { "description": "Error - The URL wildcard does not exist." } }, "summary": "Get URL wildcard", "description": "Returns the URL wildcard with the given ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the URL wildcard is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "wildcardId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_contenturlwildcards_wildcardId_delete", "tags": [ "Url Wildcard" ], "responses": { "204": { "description": "No Content - URL wildcard deleted." }, "401": { "description": "Error - The user is not authorized to delete a URL wildcard." }, "404": { "description": "Error - The URL wildcard does not exist." } }, "summary": "Delete URL wildcard", "description": "Deletes the given URL wildcard.", "parameters": [ { "name": "wildcardId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/current": { "get": { "operationId": "api_usercurrent_get", "tags": [ "User" ], "responses": { "200": { "description": "OK - the User with the given ID.", "content": { "application/vnd.ibexa.api.User+json": { "schema": { "$ref": "#/components/schemas/UserListWrapper" }, "example": { "UserList": { "_media-type": "application/vnd.ibexa.api.UserList+json", "_href": "/api/ibexa/v2/user/users", "User": [ { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/79", "_id": 79, "_remoteId": "bcf0764b417f05af21852a1f03fb1f13", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/4" }, "name": "Jose Vargas", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/79/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/12/79" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/79/locations" }, "Groups": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/79/groups" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/10" }, "publishDate": "2021-06-29T08:23:42+00:00", "lastModificationDate": "2021-06-29T08:23:42+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/79/versions/1", "VersionInfo": { "id": 547, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2021-06-29T08:23:42+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/10" }, "creationDate": "2021-06-29T08:23:42+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Jose Vargas" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/79" } }, "Fields": { "field": [ { "id": 342, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Jose" }, { "id": 343, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Vargas" }, { "id": 344, "fieldDefinitionIdentifier": "user_account", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 79, "login": "josevargas", "email": "aa@bb.cc", "passwordUpdatedAt": 1624955022, "enabled": true, "maxLogin": 0, "plainPassword": null } }, { "id": 345, "fieldDefinitionIdentifier": "signature", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_text", "fieldValue": null }, { "id": 346, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image", "fieldValue": null } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/79/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#user", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "login": "josevargas", "email": "aa@bb.cc", "enabled": true, "UserGroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/users/79/groups" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/79/roles" } } ] } } }, "application/vnd.ibexa.api.User+xml": { "schema": { "$ref": "#/components/schemas/UserList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserList media-type=\"application/vnd.ibexa.api.UserList+xml\" href=\"/api/ibexa/v2/user/users\">\n <User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/79\" id=\"79\" remoteId=\"bcf0764b417f05af21852a1f03fb1f13\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/4\"/>\n <name>Jose Vargas</name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/79/versions\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\"/>\n <MainLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/5/12/79\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/79/locations\"/>\n <Groups media-type=\"application/vnd.ibexa.api.UserGroupRefList+xml\" href=\"/api/ibexa/v2/user/users/79/groups\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/10\"/>\n <publishDate>2021-06-29T08:23:42+00:00</publishDate>\n <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <Version media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/79/versions/1\">\n <VersionInfo>\n <id>547</id>\n <versionNo>1</versionNo>\n <status>PUBLISHED</status>\n <modificationDate>2021-06-29T08:23:42+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/10\"/>\n <creationDate>2021-06-29T08:23:42+00:00</creationDate>\n <initialLanguageCode>eng-GB</initialLanguageCode>\n <languageCodes>eng-GB</languageCodes>\n <VersionTranslationInfo media-type=\"application/vnd.ibexa.api.VersionTranslationInfo+xml\">\n <Language>\n <languageCode>eng-GB</languageCode>\n </Language>\n </VersionTranslationInfo>\n <names>\n <value languageCode=\"eng-GB\">Jose Vargas</value>\n </names>\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/79\"/>\n </VersionInfo>\n <Fields>\n <field>\n <id>342</id>\n <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Jose</fieldValue>\n </field>\n <field>\n <id>343</id>\n <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Vargas</fieldValue>\n </field>\n <field>\n <id>344</id>\n <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier>\n <fieldValue>\n <value key=\"hasStoredLogin\">true</value>\n <value key=\"contentId\">79</value>\n <value key=\"login\">josevargas</value>\n <value key=\"email\">aa@bb.cc</value>\n <value key=\"passwordUpdatedAt\">1624955022</value>\n <value key=\"enabled\">true</value>\n <value key=\"maxLogin\">0</value>\n <value key=\"plainPassword\"/>\n </fieldValue>\n </field>\n <field>\n <id>345</id>\n <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n <field>\n <id>346</id>\n <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n </Fields>\n <Relations media-type=\"application/vnd.ibexa.api.RelationList+xml\" href=\"/api/ibexa/v2/content/objects/79/versions/1/relations\"/>\n <Thumbnail media-type=\"application/vnd.ibexa.api.Thumbnail+xml\">\n <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource>\n <width></width>\n <height></height>\n <mimeType>image/svg+xml</mimeType>\n </Thumbnail>\n </Version>\n <login>josevargas</login>\n <email>aa@bb.cc</email>\n <enabled>true</enabled>\n <UserGroups media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/users/79/groups\"/>\n <Roles media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/users/79/roles\"/>\n </User>\n</UserList>\n" } } }, "401": { "description": "Error - the user has no permission to read Users. For example, Anonymous user can't load oneself." } }, "summary": "Load current User", "description": "Loads the current user.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the User is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/users": { "get": { "operationId": "api_userusers_get", "tags": [ "User" ], "responses": { "200": { "description": "OK - Loads Users either for a given remote ID or Role.", "content": { "application/vnd.ibexa.api.UserList+json": { "schema": { "$ref": "#/components/schemas/UserListWrapper" }, "example": { "UserList": { "_media-type": "application/vnd.ibexa.api.UserList+json", "_href": "/api/ibexa/v2/user/users", "User": [ { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/79", "_id": 79, "_remoteId": "bcf0764b417f05af21852a1f03fb1f13", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/4" }, "name": "Jose Vargas", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/79/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/12/79" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/79/locations" }, "Groups": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/79/groups" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/10" }, "publishDate": "2021-06-29T08:23:42+00:00", "lastModificationDate": "2021-06-29T08:23:42+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/79/versions/1", "VersionInfo": { "id": 547, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2021-06-29T08:23:42+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/10" }, "creationDate": "2021-06-29T08:23:42+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Jose Vargas" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/79" } }, "Fields": { "field": [ { "id": 342, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Jose" }, { "id": 343, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Vargas" }, { "id": 344, "fieldDefinitionIdentifier": "user_account", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 79, "login": "josevargas", "email": "aa@bb.cc", "passwordUpdatedAt": 1624955022, "enabled": true, "maxLogin": 0, "plainPassword": null } }, { "id": 345, "fieldDefinitionIdentifier": "signature", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_text", "fieldValue": null }, { "id": 346, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image", "fieldValue": null } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/79/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#user", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "login": "josevargas", "email": "aa@bb.cc", "enabled": true, "UserGroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/users/79/groups" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/79/roles" } } ] } } }, "application/vnd.ibexa.api.UserList+xml": { "schema": { "$ref": "#/components/schemas/UserList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserList media-type=\"application/vnd.ibexa.api.UserList+xml\" href=\"/api/ibexa/v2/user/users\">\n <User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/79\" id=\"79\" remoteId=\"bcf0764b417f05af21852a1f03fb1f13\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/4\"/>\n <name>Jose Vargas</name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/79/versions\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\"/>\n <MainLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/5/12/79\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/79/locations\"/>\n <Groups media-type=\"application/vnd.ibexa.api.UserGroupRefList+xml\" href=\"/api/ibexa/v2/user/users/79/groups\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/10\"/>\n <publishDate>2021-06-29T08:23:42+00:00</publishDate>\n <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <Version media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/79/versions/1\">\n <VersionInfo>\n <id>547</id>\n <versionNo>1</versionNo>\n <status>PUBLISHED</status>\n <modificationDate>2021-06-29T08:23:42+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/10\"/>\n <creationDate>2021-06-29T08:23:42+00:00</creationDate>\n <initialLanguageCode>eng-GB</initialLanguageCode>\n <languageCodes>eng-GB</languageCodes>\n <VersionTranslationInfo media-type=\"application/vnd.ibexa.api.VersionTranslationInfo+xml\">\n <Language>\n <languageCode>eng-GB</languageCode>\n </Language>\n </VersionTranslationInfo>\n <names>\n <value languageCode=\"eng-GB\">Jose Vargas</value>\n </names>\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/79\"/>\n </VersionInfo>\n <Fields>\n <field>\n <id>342</id>\n <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Jose</fieldValue>\n </field>\n <field>\n <id>343</id>\n <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Vargas</fieldValue>\n </field>\n <field>\n <id>344</id>\n <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier>\n <fieldValue>\n <value key=\"hasStoredLogin\">true</value>\n <value key=\"contentId\">79</value>\n <value key=\"login\">josevargas</value>\n <value key=\"email\">aa@bb.cc</value>\n <value key=\"passwordUpdatedAt\">1624955022</value>\n <value key=\"enabled\">true</value>\n <value key=\"maxLogin\">0</value>\n <value key=\"plainPassword\"/>\n </fieldValue>\n </field>\n <field>\n <id>345</id>\n <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n <field>\n <id>346</id>\n <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n </Fields>\n <Relations media-type=\"application/vnd.ibexa.api.RelationList+xml\" href=\"/api/ibexa/v2/content/objects/79/versions/1/relations\"/>\n <Thumbnail media-type=\"application/vnd.ibexa.api.Thumbnail+xml\">\n <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource>\n <width></width>\n <height></height>\n <mimeType>image/svg+xml</mimeType>\n </Thumbnail>\n </Version>\n <login>josevargas</login>\n <email>aa@bb.cc</email>\n <enabled>true</enabled>\n <UserGroups media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/users/79/groups\"/>\n <Roles media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/users/79/roles\"/>\n </User>\n</UserList>\n" }, "application/vnd.ibexa.api.UserRefList+json": { "schema": { "$ref": "#/components/schemas/UserRefListWrapper" } }, "application/vnd.ibexa.api.UserRefList+xml": { "schema": { "$ref": "#/components/schemas/UserRefList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserRefList media-type=\"application/vnd.ibexa.api.UserRefList+xml\" href=\"/api/ibexa/v2/user/users\">\n <User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n</UserRefList>\n" } } }, "404": { "description": "If there are no visible Users matching the filter." } }, "summary": "List Users", "description": "Load Users either for a given remote ID or Role.", "parameters": [ { "name": "Accept", "in": "header", "description": "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.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "head": { "operationId": "api_userusers_head", "tags": [ "User" ], "responses": { "200": { "description": "OK - verifies if there are Users matching the given filter." }, "404": { "description": "Error - there are no visible Users matching the filter." } }, "summary": "Verify Users", "description": "Verifies if there are Users matching given filter.", "parameters": [], "deprecated": false } }, "/user/users/{userId}": { "get": { "operationId": "api_userusers_userId_get", "tags": [ "User" ], "responses": { "200": { "description": "OK - the User with the given ID.", "content": { "application/vnd.ibexa.api.User+json": { "schema": { "$ref": "#/components/schemas/UserListWrapper" }, "example": { "UserList": { "_media-type": "application/vnd.ibexa.api.UserList+json", "_href": "/api/ibexa/v2/user/users", "User": [ { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/79", "_id": 79, "_remoteId": "bcf0764b417f05af21852a1f03fb1f13", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/4" }, "name": "Jose Vargas", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/79/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/12/79" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/79/locations" }, "Groups": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/79/groups" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/10" }, "publishDate": "2021-06-29T08:23:42+00:00", "lastModificationDate": "2021-06-29T08:23:42+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/79/versions/1", "VersionInfo": { "id": 547, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2021-06-29T08:23:42+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/10" }, "creationDate": "2021-06-29T08:23:42+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Jose Vargas" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/79" } }, "Fields": { "field": [ { "id": 342, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Jose" }, { "id": 343, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Vargas" }, { "id": 344, "fieldDefinitionIdentifier": "user_account", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 79, "login": "josevargas", "email": "aa@bb.cc", "passwordUpdatedAt": 1624955022, "enabled": true, "maxLogin": 0, "plainPassword": null } }, { "id": 345, "fieldDefinitionIdentifier": "signature", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_text", "fieldValue": null }, { "id": 346, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image", "fieldValue": null } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/79/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#user", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "login": "josevargas", "email": "aa@bb.cc", "enabled": true, "UserGroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/users/79/groups" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/79/roles" } } ] } } }, "application/vnd.ibexa.api.User+xml": { "schema": { "$ref": "#/components/schemas/UserList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserList media-type=\"application/vnd.ibexa.api.UserList+xml\" href=\"/api/ibexa/v2/user/users\">\n <User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/79\" id=\"79\" remoteId=\"bcf0764b417f05af21852a1f03fb1f13\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/4\"/>\n <name>Jose Vargas</name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/79/versions\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\"/>\n <MainLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/5/12/79\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/79/locations\"/>\n <Groups media-type=\"application/vnd.ibexa.api.UserGroupRefList+xml\" href=\"/api/ibexa/v2/user/users/79/groups\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/10\"/>\n <publishDate>2021-06-29T08:23:42+00:00</publishDate>\n <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <Version media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/79/versions/1\">\n <VersionInfo>\n <id>547</id>\n <versionNo>1</versionNo>\n <status>PUBLISHED</status>\n <modificationDate>2021-06-29T08:23:42+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/10\"/>\n <creationDate>2021-06-29T08:23:42+00:00</creationDate>\n <initialLanguageCode>eng-GB</initialLanguageCode>\n <languageCodes>eng-GB</languageCodes>\n <VersionTranslationInfo media-type=\"application/vnd.ibexa.api.VersionTranslationInfo+xml\">\n <Language>\n <languageCode>eng-GB</languageCode>\n </Language>\n </VersionTranslationInfo>\n <names>\n <value languageCode=\"eng-GB\">Jose Vargas</value>\n </names>\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/79\"/>\n </VersionInfo>\n <Fields>\n <field>\n <id>342</id>\n <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Jose</fieldValue>\n </field>\n <field>\n <id>343</id>\n <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Vargas</fieldValue>\n </field>\n <field>\n <id>344</id>\n <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier>\n <fieldValue>\n <value key=\"hasStoredLogin\">true</value>\n <value key=\"contentId\">79</value>\n <value key=\"login\">josevargas</value>\n <value key=\"email\">aa@bb.cc</value>\n <value key=\"passwordUpdatedAt\">1624955022</value>\n <value key=\"enabled\">true</value>\n <value key=\"maxLogin\">0</value>\n <value key=\"plainPassword\"/>\n </fieldValue>\n </field>\n <field>\n <id>345</id>\n <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n <field>\n <id>346</id>\n <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n </Fields>\n <Relations media-type=\"application/vnd.ibexa.api.RelationList+xml\" href=\"/api/ibexa/v2/content/objects/79/versions/1/relations\"/>\n <Thumbnail media-type=\"application/vnd.ibexa.api.Thumbnail+xml\">\n <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource>\n <width></width>\n <height></height>\n <mimeType>image/svg+xml</mimeType>\n </Thumbnail>\n </Version>\n <login>josevargas</login>\n <email>aa@bb.cc</email>\n <enabled>true</enabled>\n <UserGroups media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/users/79/groups\"/>\n <Roles media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/users/79/roles\"/>\n </User>\n</UserList>\n" } } }, "401": { "description": "Error - the user has no permission to read Users." }, "404": { "description": "Error - the User does not exist." } }, "summary": "Load User", "description": "Loads User with the given ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the User is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_userusers_userId_delete", "tags": [ "User" ], "responses": { "204": { "description": "No Content." }, "401": { "description": "Error - the user is not authorized to delete this User." }, "403": { "description": "Error - the user is the same as the authenticated User." }, "404": { "description": "Error - the User does not exist." } }, "summary": "Delete User", "description": "Deletes the given User.", "parameters": [ { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_userusers_userId_patch", "tags": [ "User" ], "responses": { "200": { "description": "OK - User updated.", "content": { "application/vnd.ibexa.api.User+json": { "schema": { "$ref": "#/components/schemas/UserWrapper" }, "example": { "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/79", "_id": 79, "_remoteId": "bcf0764b417f05af21852a1f03fb1f13", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/4" }, "name": "Jose Vargas", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/79/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/12/79" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/79/locations" }, "Groups": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/79/groups" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/10" }, "publishDate": "2021-06-29T08:23:42+00:00", "lastModificationDate": "2021-07-29T12:00:24+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/79/versions/11", "VersionInfo": { "id": 614, "versionNo": 11, "status": "PUBLISHED", "modificationDate": "2021-07-29T12:00:24+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2021-07-29T12:00:24+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Jose Vargas" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/79" } }, "Fields": { "field": [ { "id": 342, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Jose" }, { "id": 343, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Vargas" }, { "id": 344, "fieldDefinitionIdentifier": "user_account", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 79, "login": "josevargas", "email": "aa@bb.cc", "passwordUpdatedAt": null, "enabled": false, "maxLogin": 0, "plainPassword": null } }, { "id": 345, "fieldDefinitionIdentifier": "signature", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_text", "fieldValue": null }, { "id": 346, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image", "fieldValue": null } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/79/versions/11/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#user", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "login": "josevargas", "email": "aa@bb.cc", "enabled": false, "UserGroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/users/79/groups" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/79/roles" } } } }, "application/vnd.ibexa.api.User+xml": { "schema": { "$ref": "#/components/schemas/User" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/79\" id=\"79\" remoteId=\"bcf0764b417f05af21852a1f03fb1f13\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/4\"/>\n <name>Jose Vargas</name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/79/versions\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\"/>\n <MainLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/5/12/79\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/79/locations\"/>\n <Groups media-type=\"application/vnd.ibexa.api.UserGroupRefList+xml\" href=\"/api/ibexa/v2/user/users/79/groups\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/10\"/>\n <publishDate>2021-06-29T08:23:42+00:00</publishDate>\n <lastModificationDate>2021-07-29T11:45:07+00:00</lastModificationDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <Version media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/79/versions/6\">\n <VersionInfo>\n <id>609</id>\n <versionNo>6</versionNo>\n <status>PUBLISHED</status>\n <modificationDate>2021-07-29T11:45:07+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <creationDate>2021-07-29T11:45:07+00:00</creationDate>\n <initialLanguageCode>eng-GB</initialLanguageCode>\n <languageCodes>eng-GB</languageCodes>\n <VersionTranslationInfo media-type=\"application/vnd.ibexa.api.VersionTranslationInfo+xml\">\n <Language>\n <languageCode>eng-GB</languageCode>\n </Language>\n </VersionTranslationInfo>\n <names>\n <value languageCode=\"eng-GB\">Jose Vargas</value>\n </names>\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/79\"/>\n </VersionInfo>\n <Fields>\n <field>\n <id>342</id>\n <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Jose</fieldValue>\n </field>\n <field>\n <id>343</id>\n <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Vargas</fieldValue>\n </field>\n <field>\n <id>344</id>\n <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier>\n <fieldValue>\n <value key=\"hasStoredLogin\">true</value>\n <value key=\"contentId\">79</value>\n <value key=\"login\">josevargas</value>\n <value key=\"email\">aa@bb.cc</value>\n <value key=\"passwordUpdatedAt\"/>\n <value key=\"enabled\">false</value>\n <value key=\"maxLogin\">0</value>\n <value key=\"plainPassword\"/>\n </fieldValue>\n </field>\n <field>\n <id>345</id>\n <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n <field>\n <id>346</id>\n <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n </Fields>\n <Relations media-type=\"application/vnd.ibexa.api.RelationList+xml\" href=\"/api/ibexa/v2/content/objects/79/versions/6/relations\"/>\n <Thumbnail media-type=\"application/vnd.ibexa.api.Thumbnail+xml\">\n <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource>\n <width></width>\n <height></height>\n <mimeType>image/svg+xml</mimeType>\n </Thumbnail>\n </Version>\n <login>josevargas</login>\n <email>aa@bb.cc</email>\n <enabled>false</enabled>\n <UserGroups media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/users/79/groups\"/>\n <Roles media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/users/79/roles\"/>\n</User>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update the User." }, "404": { "description": "Error - the User does not exist." }, "412": { "description": "Error - the current ETag does not match with the provided one in the If-Match header." } }, "summary": "Update User", "description": "Updates a User.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated User is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The UserUpdate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "Performs a PATCH only if the specified ETag is the current one.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated UserUpdateController resource", "content": { "application/vnd.ibexa.api.UserUpdate+json": { "schema": { "$ref": "#/components/schemas/UserUpdateWrapper" }, "example": { "UserUpdate": { "login": "josevargas", "enabled": false } } }, "application/vnd.ibexa.api.UserUpdate+xml": { "schema": { "$ref": "#/components/schemas/UserUpdate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserUpdate>\n <login>josevargas</login>\n <enabled>false</enabled>\n</UserUpdate>\n" } }, "required": false }, "deprecated": false } }, "/user/users/{userId}/drafts": { "get": { "operationId": "api_userusers_userIddrafts_get", "tags": [ "User" ], "responses": { "200": { "description": "OK - List the draft versions", "content": { "application/vnd.ibexa.api.VersionList+json": { "schema": { "$ref": "#/components/schemas/VersionListWrapper" } }, "application/vnd.ibexa.api.VersionList+xml": { "schema": { "$ref": "#/components/schemas/VersionList" } } } }, "401": { "description": "Error - the current user is not authorized to list the drafts of the given user." } }, "summary": "Load user drafts", "description": "Loads user's drafts", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the version list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/users/{userId}/groups": { "get": { "operationId": "api_userusers_userIdgroups_get", "tags": [ "User" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.UserGroupRefList+json": { "schema": { "$ref": "#/components/schemas/UserGroupRefListWrapper" }, "example": { "UserGroupRefList": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/57/groups", "UserGroup": [ { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/13" } ] } } }, "application/vnd.ibexa.api.UserGroupRefList+xml": { "schema": { "$ref": "#/components/schemas/UserGroupRefList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroupRefList media-type=\"application/vnd.ibexa.api.UserGroupRefList+xml\" href=\"/api/ibexa/v2/user/users/115/groups\">\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/12\">\n <unassign href=\"/api/ibexa/v2/user/users/79/groups/12\" method=\"DELETE\"/>\n </UserGroup>\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13\">\n <unassign href=\"/api/ibexa/v2/user/users/115/groups/13\" method=\"DELETE\"/>\n </UserGroup>\n</UserGroupRefList>\n" } } }, "401": { "description": "Error - the user has no permission to read User Groups." }, "404": { "description": "Error - the user does not exist." } }, "summary": "Load Groups of User", "description": "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.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the link list of User Groups is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_userusers_userIdgroups_post", "tags": [ "User" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.UserGroupRefList+json": { "schema": { "$ref": "#/components/schemas/UserGroupRefListWrapper" }, "example": { "UserGroupRefList": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/57/groups", "UserGroup": [ { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/13" } ] } } }, "application/vnd.ibexa.api.UserGroupRefList+xml": { "schema": { "$ref": "#/components/schemas/UserGroupRefList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroupRefList media-type=\"application/vnd.ibexa.api.UserGroupRefList+xml\" href=\"/api/ibexa/v2/user/users/115/groups\">\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/12\">\n <unassign href=\"/api/ibexa/v2/user/users/79/groups/12\" method=\"DELETE\"/>\n </UserGroup>\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13\">\n <unassign href=\"/api/ibexa/v2/user/users/115/groups/13\" method=\"DELETE\"/>\n </UserGroup>\n</UserGroupRefList>\n" } } }, "401": { "description": "Error - the user is not authorized to assign User Groups." }, "403": { "description": "Error - the new User Group does not exist or the User is already in this group." }, "404": { "description": "Error - the User does not exist." } }, "summary": "Assign User Group", "description": "Assigns the User to a User Group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the link list of User Groups is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new UserAssignToUserGroupController resource", "content": [], "required": false }, "deprecated": false } }, "/user/users/{userId}/groups/{groupId}": { "delete": { "operationId": "api_userusers_userIdgroups_groupId_delete", "tags": [ "User" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.UserGroupRefList+json": { "schema": { "$ref": "#/components/schemas/UserGroupRefListWrapper" }, "example": { "UserGroupRefList": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/57/groups", "UserGroup": [ { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/13" } ] } } }, "application/vnd.ibexa.api.UserGroupRefList+xml": { "schema": { "$ref": "#/components/schemas/UserGroupRefList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroupRefList media-type=\"application/vnd.ibexa.api.UserGroupRefList+xml\" href=\"/api/ibexa/v2/user/users/115/groups\">\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/12\">\n <unassign href=\"/api/ibexa/v2/user/users/79/groups/12\" method=\"DELETE\"/>\n </UserGroup>\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13\">\n <unassign href=\"/api/ibexa/v2/user/users/115/groups/13\" method=\"DELETE\"/>\n </UserGroup>\n</UserGroupRefList>\n" } } }, "401": { "description": "Error - the user is not authorized to unassign User Groups." }, "403": { "description": "Error - the User is not in the given group." }, "404": { "description": "Error - the User does not exist." }, "204": { "description": "UserUnassignFromUserGroupController resource deleted" } }, "summary": "Unassign User Group", "description": "Unassigns the User from a User Group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the link list of User Groups is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "groupId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/users/{userId}/roles": { "get": { "operationId": "api_userusers_userIdroles_get", "tags": [ "User" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.RoleAssignmentList+json": { "schema": { "$ref": "#/components/schemas/RoleAssignmentListWrapper" }, "example": { "RoleAssignmentList": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/57/roles", "RoleAssignment": [ { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/1", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/1" } }, { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/2", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/2" } } ] } } }, "application/vnd.ibexa.api.RoleAssignmentList+xml": { "schema": { "$ref": "#/components/schemas/RoleAssignmentList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignmentList media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/users/115/roles\">\n <RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/users/115/roles/2\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"1\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/2\"/>\n </RoleAssignment>\n <RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/users/115/roles/2\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"2\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/2\"/>\n </RoleAssignment>\n</RoleAssignmentList>\n" } } }, "400": { "description": "Error - the user has no permission to read Roles." } }, "summary": "Load Roles for User", "description": "Returns a list of all Roles assigned to the given User.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Role assignment list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_userusers_userIdroles_post", "tags": [ "User" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.RoleAssignmentList+json": { "schema": { "$ref": "#/components/schemas/RoleAssignmentListWrapper" }, "example": { "RoleAssignmentList": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/57/roles", "RoleAssignment": [ { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/1", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/1" } }, { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/2", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/2" } } ] } } }, "application/vnd.ibexa.api.RoleAssignmentList+xml": { "schema": { "$ref": "#/components/schemas/RoleAssignmentList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignmentList media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/users/115/roles\">\n <RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/users/115/roles/2\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"1\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/2\"/>\n </RoleAssignment>\n <RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/users/115/roles/2\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"2\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/2\"/>\n </RoleAssignment>\n</RoleAssignmentList>\n" } } }, "400": { "description": "Error - validation of limitation in RoleAssignInput fails." }, "401": { "description": "Error - the user is not authorized to assign this Role." } }, "summary": "Assign Role to User", "description": "Assigns a Role to a user.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Role assignment list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The RoleAssignInput schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new RoleAssignToUserController resource", "content": { "application/vnd.ibexa.api.RoleAssignInput+json": { "schema": { "$ref": "#/components/schemas/RoleAssignInputWrapper" }, "example": { "RoleAssignInput": { "Role": { "_href": "/api/ibexa/v2/user/roles/2", "_media-type": "application/vnd.ibexa.api.RoleAssignInput+xml" }, "limitation": { "_identifier": "Section", "values": { "ref": [ { "_href": "/api/ibexa/v2/content/sections/1", "_media-type": "application/vnd.ibexa.api.Section+xml" }, { "_href": "/api/ibexa/v2/content/sections/2", "_media-type": "application/vnd.ibexa.api.Section+xml" } ] } } } } }, "application/vnd.ibexa.api.RoleAssignInput+xml": { "schema": { "$ref": "#/components/schemas/RoleAssignInput" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignInput>\n <Role href=\"/api/ibexa/v2/user/roles/2\" media-type=\"application/vnd.ibexa.api.RoleAssignInput+xml\"/>\n <limitation identifier=\"Section\">\n <values>\n <ref href=\"/api/ibexa/v2/content/sections/1\" media-type=\"application/vnd.ibexa.api.Section+xml\" />\n <ref href=\"/api/ibexa/v2/content/sections/2\" media-type=\"application/vnd.ibexa.api.Section+xml\" />\n </values>\n </limitation>\n</RoleAssignInput>\n" } }, "required": false }, "deprecated": false } }, "/user/users/{userId}/roles/{roleId}": { "get": { "operationId": "api_userusers_userIdroles_roleId_get", "tags": [ "User" ], "responses": { "200": { "description": "OK - Role assignment to the given User Group.", "content": { "application/vnd.ibexa.api.RoleAssignment+json": { "schema": { "$ref": "#/components/schemas/RoleAssignmentWrapper" }, "example": { "RoleAssignment": { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/113/roles/3", "limitation": { "_identifier": "Section", "values": { "ref": [ { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "6" } ] } }, "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/3" } } } }, "application/vnd.ibexa.api.RoleAssignment+xml": { "schema": { "$ref": "#/components/schemas/RoleAssignment" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/users/113/roles/3\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"6\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/3\"/>\n</RoleAssignment>\n" } } }, "401": { "description": "Error - the user has no permission to read Roles." } }, "summary": "Load User Role Assignment", "description": "Returns a Role assignment to the given User.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Role assignment list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "roleId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_userusers_userIdroles_roleId_delete", "tags": [ "User" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.RoleAssignmentList+json": { "schema": { "$ref": "#/components/schemas/RoleAssignmentListWrapper" }, "example": { "RoleAssignmentList": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/57/roles", "RoleAssignment": [ { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/1", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/1" } }, { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/2", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/2" } } ] } } }, "application/vnd.ibexa.api.RoleAssignmentList+xml": { "schema": { "$ref": "#/components/schemas/RoleAssignmentList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignmentList media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/users/115/roles\">\n <RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/users/115/roles/2\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"1\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/2\"/>\n </RoleAssignment>\n <RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/users/115/roles/2\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"2\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/2\"/>\n </RoleAssignment>\n</RoleAssignmentList>\n" } } }, "401": { "description": "Error - the user is not authorized to delete this content type." } }, "summary": "Unassign Role from User", "description": "The given Role is removed from the user.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Role assignment list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "roleId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/users/{userId}/segments": { "get": { "operationId": "api_userusers_userIdsegments_get", "tags": [ "User" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.UserSegmentList+json": { "schema": { "$ref": "#/components/schemas/UserSegmentListWrapper" }, "example": { "UserSegmentList": { "_media-type": "application/vnd.ibexa.api.UserSegmentList+json", "_href": "/api/ibexa/v2/user/users/14/segments", "UserSegment": [ { "_media-type": "application/vnd.ibexa.api.UserSegment+json", "id": 1, "identifier": "corporate_account", "name": "Corporate Account", "SegmentGroup": { "_media-type": "application/vnd.ibexa.api.SegmentGroup+json", "_href": "/api/ibexa/v2/segment_groups/corporate_accounts" }, "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" } } ] } } }, "application/vnd.ibexa.api.UserSegmentList+xml": { "schema": { "$ref": "#/components/schemas/UserSegmentList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserSegmentList media-type=\"application/vnd.ibexa.api.UserSegmentList+xml\" href=\"/api/ibexa/v2/user/users/14/segments\">\n <UserSegment media-type=\"application/vnd.ibexa.api.UserSegment+xml\">\n <id>1</id>\n <identifier>corporate_account</identifier>\n <name>Corporate Account</name>\n <SegmentGroup media-type=\"application/vnd.ibexa.api.SegmentGroup+xml\" href=\"/api/ibexa/v2/segment_groups/corporate_accounts\"/>\n <User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/1234\"/>\n </UserSegment>\n</UserSegmentList>\n" } } }, "404": { "description": "Error - the user doesn't exist." } }, "summary": "View user segments", "description": "Return user's segment list.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the user's segment list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_userusers_userIdsegments_post", "tags": [ "User" ], "responses": { "204": { "description": "No Content - segments assigned to user" }, "401": { "description": "Error - the requesting user is not authorized to assign this segment to the given user." }, "404": { "description": "Error - the user doesn't exist." } }, "summary": "Assign Segments to User", "description": "Assigns Segments from payload to User given by ID.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The UserSegmentAssignInput schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new UserSegmentAssignController resource", "content": { "application/vnd.ibexa.api.UserSegmentAssignInput+json": { "schema": { "$ref": "#/components/schemas/UserSegmentAssignInputWrapper" }, "example": { "UserSegmentAssignInput": { "segments": [ "corporate_account" ] } } }, "application/vnd.ibexa.api.UserSegmentAssignInput+xml": { "schema": { "$ref": "#/components/schemas/UserSegmentAssignInput" }, "example": "<UserSegmentAssignInput>\n <segments>corporate_account</segments>\n</UserSegmentAssignInput>\n" } }, "required": false }, "deprecated": false } }, "/user/users/{userId}/segments/{segmentIdentifier}": { "delete": { "operationId": "api_userusers_userIdsegments_segmentIdentifier_delete", "tags": [ "User" ], "responses": { "204": { "description": "No Content - segments unassigned from user" }, "401": { "description": "Error - the requesting user is not authorized to unassign this segment from the given user." }, "404": { "description": "Error - the segment or the user doesn't exist." } }, "summary": "Unassign Segment from User", "description": "The Segment designated by its identifier is unassigned from the User given by ID.", "parameters": [ { "name": "userId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "segmentIdentifier", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/groups": { "get": { "operationId": "api_usergroups_get", "tags": [ "User Group" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.UserGroupList+json": { "schema": { "$ref": "#/components/schemas/UserGroupListWrapper" }, "example": { "UserGroupList": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/groups", "UserGroup": [ { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/13/15", "_id": 14, "_remoteId": "1bb4fe25487f05527efa8bfd394cecc7", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/4" }, "name": "Administrator User", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/14/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/13/15" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/14/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "publishDate": "2002-10-06T16:13:50+00:00", "lastModificationDate": "2011-03-25T14:07:04+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/14/versions/3", "VersionInfo": { "id": 499, "versionNo": 3, "status": "PUBLISHED", "modificationDate": "2011-03-25T14:07:04+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2011-03-25T14:03:03+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Administrator User" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/14" } }, "Fields": { "field": [ { "id": 28, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Administrator" }, { "id": 29, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "User" }, { "id": 30, "fieldDefinitionIdentifier": "user_account", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 14, "login": "admin", "email": "admin@link.invalid", "passwordUpdatedAt": null, "enabled": true, "maxLogin": 10, "plainPassword": null } }, { "id": 178, "fieldDefinitionIdentifier": "signature", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_text", "fieldValue": null }, { "id": 180, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image", "fieldValue": null } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/14/versions/3/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#user", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "ParentUserGroup": { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/13" }, "Subgroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/groups/1/5/13/15/subgroups" }, "Users": { "_media-type": "application/vnd.ibexa.api.UserList+json", "_href": "/api/ibexa/v2/user/groups/1/5/13/15/users" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/groups/1/5/13/15/roles" } } ] } } }, "application/vnd.ibexa.api.UserGroupList+xml": { "schema": { "$ref": "#/components/schemas/UserGroupList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroupList media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/groups\">\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13/15\" id=\"14\" remoteId=\"1bb4fe25487f05527efa8bfd394cecc7\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/4\"/>\n <name>Administrator User</name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/14/versions\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\"/>\n <MainLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/5/13/15\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/14/locations\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <publishDate>2002-10-06T16:13:50+00:00</publishDate>\n <lastModificationDate>2011-03-25T14:07:04+00:00</lastModificationDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <Version media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/14/versions/3\">\n <VersionInfo>\n <id>499</id>\n <versionNo>3</versionNo>\n <status>PUBLISHED</status>\n <modificationDate>2011-03-25T14:07:04+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <creationDate>2011-03-25T14:03:03+00:00</creationDate>\n <initialLanguageCode>eng-GB</initialLanguageCode>\n <languageCodes>eng-GB</languageCodes>\n <VersionTranslationInfo media-type=\"application/vnd.ibexa.api.VersionTranslationInfo+xml\">\n <Language>\n <languageCode>eng-GB</languageCode>\n </Language>\n </VersionTranslationInfo>\n <names>\n <value languageCode=\"eng-GB\">Administrator User</value>\n </names>\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/14\"/>\n </VersionInfo>\n <Fields>\n <field>\n <id>28</id>\n <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Administrator</fieldValue>\n </field>\n <field>\n <id>29</id>\n <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>User</fieldValue>\n </field>\n <field>\n <id>30</id>\n <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier>\n <fieldValue>\n <value key=\"hasStoredLogin\">true</value>\n <value key=\"contentId\">14</value>\n <value key=\"login\">admin</value>\n <value key=\"email\">admin@link.invalid</value>\n <value key=\"passwordUpdatedAt\"/>\n <value key=\"enabled\">true</value>\n <value key=\"maxLogin\">10</value>\n <value key=\"plainPassword\"/>\n </fieldValue>\n </field>\n <field>\n <id>178</id>\n <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n <field>\n <id>180</id>\n <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n </Fields>\n <Relations media-type=\"application/vnd.ibexa.api.RelationList+xml\" href=\"/api/ibexa/v2/content/objects/14/versions/3/relations\"/>\n <Thumbnail media-type=\"application/vnd.ibexa.api.Thumbnail+xml\">\n <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource>\n <width></width>\n <height></height>\n <mimeType>image/svg+xml</mimeType>\n </Thumbnail>\n </Version>\n <ParentUserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13\"/>\n <Subgroups media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13/15/subgroups\"/>\n <Users media-type=\"application/vnd.ibexa.api.UserList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13/15/users\"/>\n <Roles media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13/15/roles\"/>\n </UserGroup>\n</UserGroupList>\n" }, "application/vnd.ibexa.api.UserGroupRefList+json": { "schema": { "$ref": "#/components/schemas/UserGroupRefListWrapper" }, "example": { "UserGroupRefList": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/57/groups", "UserGroup": [ { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/13" } ] } } }, "application/vnd.ibexa.api.UserGroupRefList+xml": { "schema": { "$ref": "#/components/schemas/UserGroupRefList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroupRefList media-type=\"application/vnd.ibexa.api.UserGroupRefList+xml\" href=\"/api/ibexa/v2/user/users/115/groups\">\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/12\">\n <unassign href=\"/api/ibexa/v2/user/users/79/groups/12\" method=\"DELETE\"/>\n </UserGroup>\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13\">\n <unassign href=\"/api/ibexa/v2/user/users/115/groups/13\" method=\"DELETE\"/>\n </UserGroup>\n</UserGroupRefList>\n" } } }, "401": { "description": "Error - the user has no permission to read User Groups." } }, "summary": "Load User Groups", "description": "Loads User Groups for either an an ID or a remote ID or a Role.", "parameters": [ { "name": "Accept", "in": "header", "description": "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.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/groups/root": { "get": { "operationId": "api_usergroupsroot_get", "tags": [ "User Group" ], "responses": { "301": { "description": "Moved permanently." } }, "summary": "Get root User Group", "description": "Redirects to the root User Group.", "parameters": [], "deprecated": false } }, "/user/groups/subgroups": { "post": { "operationId": "api_usergroupssubgroups_post", "tags": [ "User Group" ], "responses": { "201": { "description": "Created - the User Group has been created", "content": { "application/vnd.ibexa.api.UserGroup+json": { "schema": { "$ref": "#/components/schemas/UserGroupWrapper" }, "example": { "UserGroup": { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/81", "_id": 87, "_remoteId": "remoteId-qwert098", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/3" }, "name": "UserGroup2", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/87/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/81" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/87/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "publishDate": "2021-08-09T09:06:49+00:00", "lastModificationDate": "2021-08-09T09:06:49+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/87/versions/1", "VersionInfo": { "id": 578, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2021-08-09T09:06:49+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2021-08-09T09:06:49+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "UserGroup2" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/87" } }, "Fields": { "field": [ { "id": 384, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "UserGroup2" }, { "id": 385, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "This is the description of the user group" } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/87/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#user_group", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "ParentUserGroup": { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5" }, "Subgroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/subgroups" }, "Users": { "_media-type": "application/vnd.ibexa.api.UserList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/users" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/roles" } } } }, "application/vnd.ibexa.api.UserGroup+xml": { "schema": { "$ref": "#/components/schemas/UserGroup" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79\" id=\"85\" remoteId=\"remoteId-qwert098\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/3\"/>\n <name>UserGroup2</name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/85/versions\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\"/>\n <MainLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/5/79\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/85/locations\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <publishDate>2021-08-09T09:03:35+00:00</publishDate>\n <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <Version media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/85/versions/1\">\n <VersionInfo>\n <id>576</id>\n <versionNo>1</versionNo>\n <status>PUBLISHED</status>\n <modificationDate>2021-08-09T09:03:35+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <creationDate>2021-08-09T09:03:35+00:00</creationDate>\n <initialLanguageCode>eng-GB</initialLanguageCode>\n <languageCodes>eng-GB</languageCodes>\n <VersionTranslationInfo media-type=\"application/vnd.ibexa.api.VersionTranslationInfo+xml\">\n <Language>\n <languageCode>eng-GB</languageCode>\n </Language>\n </VersionTranslationInfo>\n <names>\n <value languageCode=\"eng-GB\">UserGroup2</value>\n </names>\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/85\"/>\n </VersionInfo>\n <Fields>\n <field>\n <id>380</id>\n <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>UserGroup2</fieldValue>\n </field>\n <field>\n <id>381</id>\n <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>This is the description of the user group</fieldValue>\n </field>\n </Fields>\n <Relations media-type=\"application/vnd.ibexa.api.RelationList+xml\" href=\"/api/ibexa/v2/content/objects/85/versions/1/relations\"/>\n <Thumbnail media-type=\"application/vnd.ibexa.api.Thumbnail+xml\">\n <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource>\n <width></width>\n <height></height>\n <mimeType>image/svg+xml</mimeType>\n </Thumbnail>\n </Version>\n <ParentUserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5\"/>\n <Subgroups media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/subgroups\"/>\n <Users media-type=\"application/vnd.ibexa.api.UserList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/users\"/>\n <Roles media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/roles\"/>\n</UserGroup>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this User Group." } }, "summary": "Create a top level User Group", "description": "Creates a top level User Group under the root. To create a child group under a parent group use '/user/groups/{path}/subgroups'.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new User Group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The UserGroupCreate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new UserGroupCreateController resource", "content": { "application/vnd.ibexa.api.UserGroupCreate+json": { "schema": { "$ref": "#/components/schemas/UserGroupCreateWrapper" }, "example": { "UserGroupCreate": { "mainLanguageCode": "eng-GB", "remoteId": "remoteId-qwert098", "fields": { "field": [ { "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldValue": "UserGroup2" }, { "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldValue": "This is the description of the user group" } ] } } } }, "application/vnd.ibexa.api.UserGroupCreate+xml": { "schema": { "$ref": "#/components/schemas/UserGroupCreate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroupCreate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <remoteId>remoteId-qwert098</remoteId>\n <fields>\n <field>\n <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldValue>UserGroup</fieldValue>\n </field>\n <field>\n <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldValue>This is the description of the user group</fieldValue>\n </field>\n </fields>\n</UserGroupCreate>" } }, "required": false }, "deprecated": false } }, "/user/groups/{path}": { "get": { "operationId": "api_usergroups_path_get", "tags": [ "User Group" ], "responses": { "200": { "description": "OK - loads User Groups.", "content": { "application/vnd.ibexa.api.UserGroup+json": { "schema": { "$ref": "#/components/schemas/UserGroupWrapper" }, "example": { "UserGroup": { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/81", "_id": 87, "_remoteId": "remoteId-qwert098", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/3" }, "name": "UserGroup2", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/87/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/81" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/87/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "publishDate": "2021-08-09T09:06:49+00:00", "lastModificationDate": "2021-08-09T09:06:49+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/87/versions/1", "VersionInfo": { "id": 578, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2021-08-09T09:06:49+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2021-08-09T09:06:49+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "UserGroup2" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/87" } }, "Fields": { "field": [ { "id": 384, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "UserGroup2" }, { "id": 385, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "This is the description of the user group" } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/87/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#user_group", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "ParentUserGroup": { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5" }, "Subgroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/subgroups" }, "Users": { "_media-type": "application/vnd.ibexa.api.UserList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/users" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/roles" } } } }, "application/vnd.ibexa.api.UserGroup+xml": { "schema": { "$ref": "#/components/schemas/UserGroup" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79\" id=\"85\" remoteId=\"remoteId-qwert098\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/3\"/>\n <name>UserGroup2</name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/85/versions\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\"/>\n <MainLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/5/79\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/85/locations\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <publishDate>2021-08-09T09:03:35+00:00</publishDate>\n <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <Version media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/85/versions/1\">\n <VersionInfo>\n <id>576</id>\n <versionNo>1</versionNo>\n <status>PUBLISHED</status>\n <modificationDate>2021-08-09T09:03:35+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <creationDate>2021-08-09T09:03:35+00:00</creationDate>\n <initialLanguageCode>eng-GB</initialLanguageCode>\n <languageCodes>eng-GB</languageCodes>\n <VersionTranslationInfo media-type=\"application/vnd.ibexa.api.VersionTranslationInfo+xml\">\n <Language>\n <languageCode>eng-GB</languageCode>\n </Language>\n </VersionTranslationInfo>\n <names>\n <value languageCode=\"eng-GB\">UserGroup2</value>\n </names>\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/85\"/>\n </VersionInfo>\n <Fields>\n <field>\n <id>380</id>\n <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>UserGroup2</fieldValue>\n </field>\n <field>\n <id>381</id>\n <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>This is the description of the user group</fieldValue>\n </field>\n </Fields>\n <Relations media-type=\"application/vnd.ibexa.api.RelationList+xml\" href=\"/api/ibexa/v2/content/objects/85/versions/1/relations\"/>\n <Thumbnail media-type=\"application/vnd.ibexa.api.Thumbnail+xml\">\n <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource>\n <width></width>\n <height></height>\n <mimeType>image/svg+xml</mimeType>\n </Thumbnail>\n </Version>\n <ParentUserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5\"/>\n <Subgroups media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/subgroups\"/>\n <Users media-type=\"application/vnd.ibexa.api.UserList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/users\"/>\n <Roles media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/roles\"/>\n</UserGroup>\n" } } }, "401": { "description": "Error - the user has no permission to read User Groups." }, "404": { "description": "Error - the User Group does not exist." } }, "summary": "Load User Group", "description": "Loads User Groups for the given {path}.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new User Group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_usergroups_path_delete", "tags": [ "User Group" ], "responses": { "204": { "description": "No content - the given User Group is deleted." }, "401": { "description": "Error - the user is not authorized to delete this content type." }, "403": { "description": "Error - the User Group is not empty." } }, "summary": "Delete User Group", "description": "The given User Group is deleted.", "parameters": [ { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_usergroups_path_patch", "tags": [ "User Group" ], "responses": { "200": { "description": "OK - updated User Group.", "content": { "application/vnd.ibexa.api.UserGroup+json": { "schema": { "$ref": "#/components/schemas/UserGroupWrapper" }, "example": { "UserGroup": { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/81", "_id": 87, "_remoteId": "remoteId-qwert098", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/3" }, "name": "UserGroup2", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/87/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/81" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/87/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "publishDate": "2021-08-09T09:06:49+00:00", "lastModificationDate": "2021-08-09T09:06:49+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/87/versions/1", "VersionInfo": { "id": 578, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2021-08-09T09:06:49+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2021-08-09T09:06:49+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "UserGroup2" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/87" } }, "Fields": { "field": [ { "id": 384, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "UserGroup2" }, { "id": 385, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "This is the description of the user group" } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/87/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#user_group", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "ParentUserGroup": { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5" }, "Subgroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/subgroups" }, "Users": { "_media-type": "application/vnd.ibexa.api.UserList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/users" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/roles" } } } }, "application/vnd.ibexa.api.UserGroup+xml": { "schema": { "$ref": "#/components/schemas/UserGroup" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79\" id=\"85\" remoteId=\"remoteId-qwert098\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/3\"/>\n <name>UserGroup2</name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/85/versions\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\"/>\n <MainLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/5/79\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/85/locations\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <publishDate>2021-08-09T09:03:35+00:00</publishDate>\n <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <Version media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/85/versions/1\">\n <VersionInfo>\n <id>576</id>\n <versionNo>1</versionNo>\n <status>PUBLISHED</status>\n <modificationDate>2021-08-09T09:03:35+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <creationDate>2021-08-09T09:03:35+00:00</creationDate>\n <initialLanguageCode>eng-GB</initialLanguageCode>\n <languageCodes>eng-GB</languageCodes>\n <VersionTranslationInfo media-type=\"application/vnd.ibexa.api.VersionTranslationInfo+xml\">\n <Language>\n <languageCode>eng-GB</languageCode>\n </Language>\n </VersionTranslationInfo>\n <names>\n <value languageCode=\"eng-GB\">UserGroup2</value>\n </names>\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/85\"/>\n </VersionInfo>\n <Fields>\n <field>\n <id>380</id>\n <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>UserGroup2</fieldValue>\n </field>\n <field>\n <id>381</id>\n <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>This is the description of the user group</fieldValue>\n </field>\n </Fields>\n <Relations media-type=\"application/vnd.ibexa.api.RelationList+xml\" href=\"/api/ibexa/v2/content/objects/85/versions/1/relations\"/>\n <Thumbnail media-type=\"application/vnd.ibexa.api.Thumbnail+xml\">\n <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource>\n <width></width>\n <height></height>\n <mimeType>image/svg+xml</mimeType>\n </Thumbnail>\n </Version>\n <ParentUserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5\"/>\n <Subgroups media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/subgroups\"/>\n <Users media-type=\"application/vnd.ibexa.api.UserList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/users\"/>\n <Roles media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/roles\"/>\n</UserGroup>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update the User Group." }, "412": { "description": "Error -\tif the current ETag does not match with the one provided in the If-Match header." } }, "summary": "Update User Group", "description": "Updates a User Group. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new User Group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The UserGroupUpdate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "Performs the PATCH only if the specified ETag is the current one. Otherwise a 412 is returned.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated UserGroupUpdateController resource", "content": { "application/vnd.ibexa.api.UserGroupUpdate+json": { "schema": { "$ref": "#/components/schemas/UserGroupUpdateWrapper" }, "example": { "UserGroupUpdate": { "Section": { "_href": "/api/ibexa/v2/content/sections/2" } } } }, "application/vnd.ibexa.api.UserGroupUpdate+xml": { "schema": { "$ref": "#/components/schemas/UserGroupUpdate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroupUpdate>\n\t<Section href=\"/api/ibexa/v2/content/sections/2\" />\n</UserGroupUpdate>\n" } }, "required": false }, "deprecated": false } }, "/user/groups/{path}/roles": { "get": { "operationId": "api_usergroups_pathroles_get", "tags": [ "User Group" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.RoleAssignmentList+json": { "schema": { "$ref": "#/components/schemas/RoleAssignmentListWrapper" }, "example": { "RoleAssignmentList": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/57/roles", "RoleAssignment": [ { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/1", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/1" } }, { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/2", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/2" } } ] } } }, "application/vnd.ibexa.api.RoleAssignmentList+xml": { "schema": { "$ref": "#/components/schemas/RoleAssignmentList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/users/113/roles/3\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"6\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/3\"/>\n</RoleAssignment>\n" } } }, "400": { "description": "Error - the user has no permission to read Roles." } }, "summary": "Load Roles for User Group", "description": "Returns a list of all Roles assigned to the given User Group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Role assignment list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_usergroups_pathroles_post", "tags": [ "User Group" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.RoleAssignmentList+json": { "schema": { "$ref": "#/components/schemas/RoleAssignmentListWrapper" }, "example": { "RoleAssignmentList": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/57/roles", "RoleAssignment": [ { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/1", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/1" } }, { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/2", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/2" } } ] } } }, "application/vnd.ibexa.api.RoleAssignmentList+xml": { "schema": { "$ref": "#/components/schemas/RoleAssignmentList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/users/113/roles/3\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"6\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/3\"/>\n</RoleAssignment>\n" } } }, "400": { "description": "Error - validation of limitation in RoleAssignInput fails." }, "401": { "description": "Error - the user is not authorized to assign this Role." } }, "summary": "Assign Role to User Group", "description": "Assigns a Role to a User Group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Role assignment list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The RoleAssignInput schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new RoleAssignToUserGroupController resource", "content": { "application/vnd.ibexa.api.RoleAssignInput+json": { "schema": { "$ref": "#/components/schemas/RoleAssignInputWrapper" }, "example": { "RoleAssignInput": { "Role": { "_href": "/api/ibexa/v2/user/roles/2", "_media-type": "application/vnd.ibexa.api.RoleAssignInput+xml" }, "limitation": { "_identifier": "Section", "values": { "ref": [ { "_href": "/api/ibexa/v2/content/sections/1", "_media-type": "application/vnd.ibexa.api.Section+xml" }, { "_href": "/api/ibexa/v2/content/sections/2", "_media-type": "application/vnd.ibexa.api.Section+xml" } ] } } } } }, "application/vnd.ibexa.api.RoleAssignInput+xml": { "schema": { "$ref": "#/components/schemas/RoleAssignInput" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignInput>\n <Role href=\"/api/ibexa/v2/user/roles/10\" media-type=\"application/vnd.ibexa.api.RoleAssignInput+xml\"/>\n <limitation identifier=\"Section\">\n <values>\n <ref href=\"/api/ibexa/v2/content/sections/1\" media-type=\"application/vnd.ibexa.api.Section+xml\" />\n <ref href=\"/api/ibexa/v2/content/sections/4\" media-type=\"application/vnd.ibexa.api.Section+xml\" />\n </values>\n </limitation>\n</RoleAssignInput>\n" } }, "required": false }, "deprecated": false } }, "/user/groups/{path}/roles/{roleId}": { "get": { "operationId": "api_usergroups_pathroles_roleId_get", "tags": [ "User Group" ], "responses": { "200": { "description": "OK - returns a Role assignment of the given User Group.", "content": { "application/vnd.ibexa.api.RoleAssignment+json": { "schema": { "$ref": "#/components/schemas/RoleAssignmentWrapper" }, "example": { "RoleAssignment": { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/113/roles/3", "limitation": { "_identifier": "Section", "values": { "ref": [ { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "6" } ] } }, "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/3" } } } }, "application/vnd.ibexa.api.RoleAssignment+xml": { "schema": { "$ref": "#/components/schemas/RoleAssignment" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/users/113/roles/3\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"6\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/3\"/>\n</RoleAssignment>\n" } } }, "401": { "description": "Error - the user has no permission to read Roles." } }, "summary": "Load User Group Role Assignment", "description": "Returns a Role assignment of the given User Group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Role assignment list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "roleId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_usergroups_pathroles_roleId_delete", "tags": [ "User Group" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.RoleAssignmentList+json": { "schema": { "$ref": "#/components/schemas/RoleAssignmentListWrapper" }, "example": { "RoleAssignmentList": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/57/roles", "RoleAssignment": [ { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/1", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/1" } }, { "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", "_href": "/api/ibexa/v2/user/users/57/roles/2", "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/2" } } ] } } }, "application/vnd.ibexa.api.RoleAssignmentList+xml": { "schema": { "$ref": "#/components/schemas/RoleAssignmentList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/users/113/roles/3\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"6\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/3\"/>\n</RoleAssignment>\n" } } }, "401": { "description": "Error - the user is not authorized to delete this Role assignment." } }, "summary": "Unassign Role from User Group", "description": "The given Role is removed from the User or User Group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Role assignment list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "roleId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/groups/{path}/subgroups": { "get": { "operationId": "api_usergroups_pathsubgroups_get", "tags": [ "User Group" ], "responses": { "200": { "description": "OK - list of the subgroups.", "content": { "application/vnd.ibexa.api.UserGroupList+json": { "schema": { "$ref": "#/components/schemas/UserGroupListWrapper" }, "example": { "UserGroupList": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/groups", "UserGroup": [ { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/13/15", "_id": 14, "_remoteId": "1bb4fe25487f05527efa8bfd394cecc7", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/4" }, "name": "Administrator User", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/14/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/13/15" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/14/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "publishDate": "2002-10-06T16:13:50+00:00", "lastModificationDate": "2011-03-25T14:07:04+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/14/versions/3", "VersionInfo": { "id": 499, "versionNo": 3, "status": "PUBLISHED", "modificationDate": "2011-03-25T14:07:04+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2011-03-25T14:03:03+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Administrator User" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/14" } }, "Fields": { "field": [ { "id": 28, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Administrator" }, { "id": 29, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "User" }, { "id": 30, "fieldDefinitionIdentifier": "user_account", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 14, "login": "admin", "email": "admin@link.invalid", "passwordUpdatedAt": null, "enabled": true, "maxLogin": 10, "plainPassword": null } }, { "id": 178, "fieldDefinitionIdentifier": "signature", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_text", "fieldValue": null }, { "id": 180, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image", "fieldValue": null } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/14/versions/3/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#user", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "ParentUserGroup": { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/13" }, "Subgroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/groups/1/5/13/15/subgroups" }, "Users": { "_media-type": "application/vnd.ibexa.api.UserList+json", "_href": "/api/ibexa/v2/user/groups/1/5/13/15/users" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/groups/1/5/13/15/roles" } } ] } } }, "application/vnd.ibexa.api.UserGroupList+xml": { "schema": { "$ref": "#/components/schemas/UserGroupList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroupList media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/groups\">\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13/15\" id=\"14\" remoteId=\"1bb4fe25487f05527efa8bfd394cecc7\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/4\"/>\n <name>Administrator User</name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/14/versions\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\"/>\n <MainLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/5/13/15\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/14/locations\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <publishDate>2002-10-06T16:13:50+00:00</publishDate>\n <lastModificationDate>2011-03-25T14:07:04+00:00</lastModificationDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <Version media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/14/versions/3\">\n <VersionInfo>\n <id>499</id>\n <versionNo>3</versionNo>\n <status>PUBLISHED</status>\n <modificationDate>2011-03-25T14:07:04+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <creationDate>2011-03-25T14:03:03+00:00</creationDate>\n <initialLanguageCode>eng-GB</initialLanguageCode>\n <languageCodes>eng-GB</languageCodes>\n <VersionTranslationInfo media-type=\"application/vnd.ibexa.api.VersionTranslationInfo+xml\">\n <Language>\n <languageCode>eng-GB</languageCode>\n </Language>\n </VersionTranslationInfo>\n <names>\n <value languageCode=\"eng-GB\">Administrator User</value>\n </names>\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/14\"/>\n </VersionInfo>\n <Fields>\n <field>\n <id>28</id>\n <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Administrator</fieldValue>\n </field>\n <field>\n <id>29</id>\n <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>User</fieldValue>\n </field>\n <field>\n <id>30</id>\n <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier>\n <fieldValue>\n <value key=\"hasStoredLogin\">true</value>\n <value key=\"contentId\">14</value>\n <value key=\"login\">admin</value>\n <value key=\"email\">admin@link.invalid</value>\n <value key=\"passwordUpdatedAt\"/>\n <value key=\"enabled\">true</value>\n <value key=\"maxLogin\">10</value>\n <value key=\"plainPassword\"/>\n </fieldValue>\n </field>\n <field>\n <id>178</id>\n <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n <field>\n <id>180</id>\n <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n </Fields>\n <Relations media-type=\"application/vnd.ibexa.api.RelationList+xml\" href=\"/api/ibexa/v2/content/objects/14/versions/3/relations\"/>\n <Thumbnail media-type=\"application/vnd.ibexa.api.Thumbnail+xml\">\n <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource>\n <width></width>\n <height></height>\n <mimeType>image/svg+xml</mimeType>\n </Thumbnail>\n </Version>\n <ParentUserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13\"/>\n <Subgroups media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13/15/subgroups\"/>\n <Users media-type=\"application/vnd.ibexa.api.UserList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13/15/users\"/>\n <Roles media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13/15/roles\"/>\n </UserGroup>\n</UserGroupList>\n" }, "application/vnd.ibexa.api.UserGroupRefList+json": { "schema": { "$ref": "#/components/schemas/UserGroupRefListWrapper" }, "example": { "UserGroupRefList": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/57/groups", "UserGroup": [ { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/13" } ] } } }, "application/vnd.ibexa.api.UserGroupRefList+xml": { "schema": { "$ref": "#/components/schemas/UserGroupRefList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroupRefList media-type=\"application/vnd.ibexa.api.UserGroupRefList+xml\" href=\"/api/ibexa/v2/user/users/115/groups\">\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/12\">\n <unassign href=\"/api/ibexa/v2/user/users/79/groups/12\" method=\"DELETE\"/>\n </UserGroup>\n <UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/13\">\n <unassign href=\"/api/ibexa/v2/user/users/115/groups/13\" method=\"DELETE\"/>\n </UserGroup>\n</UserGroupRefList>\n" } } }, "401": { "description": "Error - the user has no permission to read User Groups." }, "404": { "description": "Error - the User Group does not exist." } }, "summary": "Load subgroups", "description": "Returns a list of the subgroups.", "parameters": [ { "name": "Accept", "in": "header", "description": "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.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_usergroups_pathsubgroups_post", "tags": [ "User Group" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.UserGroup+json": { "schema": { "$ref": "#/components/schemas/UserGroupWrapper" }, "example": { "UserGroup": { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5/81", "_id": 87, "_remoteId": "remoteId-qwert098", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/3" }, "name": "UserGroup2", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/87/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/81" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/87/locations" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "publishDate": "2021-08-09T09:06:49+00:00", "lastModificationDate": "2021-08-09T09:06:49+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/87/versions/1", "VersionInfo": { "id": 578, "versionNo": 1, "status": "PUBLISHED", "modificationDate": "2021-08-09T09:06:49+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2021-08-09T09:06:49+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "UserGroup2" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/87" } }, "Fields": { "field": [ { "id": 384, "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "UserGroup2" }, { "id": 385, "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "This is the description of the user group" } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/87/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#user_group", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "ParentUserGroup": { "_media-type": "application/vnd.ibexa.api.UserGroup+json", "_href": "/api/ibexa/v2/user/groups/1/5" }, "Subgroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/subgroups" }, "Users": { "_media-type": "application/vnd.ibexa.api.UserList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/users" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/groups/1/5/81/roles" } } } }, "application/vnd.ibexa.api.UserGroup+xml": { "schema": { "$ref": "#/components/schemas/UserGroup" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79\" id=\"85\" remoteId=\"remoteId-qwert098\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/3\"/>\n <name>UserGroup2</name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/85/versions\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\"/>\n <MainLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/5/79\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/85/locations\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <publishDate>2021-08-09T09:03:35+00:00</publishDate>\n <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <Version media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/85/versions/1\">\n <VersionInfo>\n <id>576</id>\n <versionNo>1</versionNo>\n <status>PUBLISHED</status>\n <modificationDate>2021-08-09T09:03:35+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <creationDate>2021-08-09T09:03:35+00:00</creationDate>\n <initialLanguageCode>eng-GB</initialLanguageCode>\n <languageCodes>eng-GB</languageCodes>\n <VersionTranslationInfo media-type=\"application/vnd.ibexa.api.VersionTranslationInfo+xml\">\n <Language>\n <languageCode>eng-GB</languageCode>\n </Language>\n </VersionTranslationInfo>\n <names>\n <value languageCode=\"eng-GB\">UserGroup2</value>\n </names>\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/85\"/>\n </VersionInfo>\n <Fields>\n <field>\n <id>380</id>\n <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>UserGroup2</fieldValue>\n </field>\n <field>\n <id>381</id>\n <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>This is the description of the user group</fieldValue>\n </field>\n </Fields>\n <Relations media-type=\"application/vnd.ibexa.api.RelationList+xml\" href=\"/api/ibexa/v2/content/objects/85/versions/1/relations\"/>\n <Thumbnail media-type=\"application/vnd.ibexa.api.Thumbnail+xml\">\n <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource>\n <width></width>\n <height></height>\n <mimeType>image/svg+xml</mimeType>\n </Thumbnail>\n </Version>\n <ParentUserGroup media-type=\"application/vnd.ibexa.api.UserGroup+xml\" href=\"/api/ibexa/v2/user/groups/1/5\"/>\n <Subgroups media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/subgroups\"/>\n <Users media-type=\"application/vnd.ibexa.api.UserList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/users\"/>\n <Roles media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/79/roles\"/>\n</UserGroup>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this User Group." } }, "summary": "Create User Group", "description": "Creates a new User Group under the given parent. To create a top level group use '/user/groups/subgroups'.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new User Group is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The UserGroupCreate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new UserGroupCreateController resource", "content": { "application/vnd.ibexa.api.UserGroupCreate+json": { "schema": { "$ref": "#/components/schemas/UserGroupCreateWrapper" }, "example": { "UserGroupCreate": { "mainLanguageCode": "eng-GB", "remoteId": "remoteId-qwert098", "fields": { "field": [ { "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldValue": "UserGroup2" }, { "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", "fieldValue": "This is the description of the user group" } ] } } } }, "application/vnd.ibexa.api.UserGroupCreate+xml": { "schema": { "$ref": "#/components/schemas/UserGroupCreate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroupCreate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <remoteId>remoteId-qwert098</remoteId>\n <fields>\n <field>\n <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldValue>UserGroup</fieldValue>\n </field>\n <field>\n <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldValue>This is the description of the user group</fieldValue>\n </field>\n </fields>\n</UserGroupCreate>" } }, "required": false }, "deprecated": false } }, "/user/groups/{path}/users": { "get": { "operationId": "api_usergroups_pathusers_get", "tags": [ "User Group" ], "responses": { "200": { "description": "OK - the Users of the Group with the given ID.", "content": { "application/vnd.ibexa.api.UserList+json": { "schema": { "$ref": "#/components/schemas/UserList" } }, "application/vnd.ibexa.api.UserList+xml": { "schema": { "$ref": "#/components/schemas/UserList" } }, "application/vnd.ibexa.api.UserRefList+json": { "schema": { "$ref": "#/components/schemas/UserRefListWrapper" }, "example": { "UserRefList": { "_media-type": "application/vnd.ibexa.api.UserRefList+json", "_href": "/api/ibexa/v2/user/groups/13/users", "User": [ { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/113" }, { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" } ] } } }, "application/vnd.ibexa.api.UserRefList+xml": { "schema": { "$ref": "#/components/schemas/UserRefList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserRefList media-type=\"application/vnd.ibexa.api.UserRefList+xml\" href=\"/api/ibexa/v2/user/users\">\n <User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n</UserRefList>\n" } } }, "401": { "description": "Error - the user has no permission to read User Groups." }, "404": { "description": "Error - the User Group does not exist." } }, "summary": "Load Users of Group", "description": "Loads the Users of the Group with the given ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "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.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_usergroups_pathusers_post", "tags": [ "User Group" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.User+json": { "schema": { "$ref": "#/components/schemas/UserWrapper" }, "example": { "User": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/79", "_id": 79, "_remoteId": "bcf0764b417f05af21852a1f03fb1f13", "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/4" }, "name": "Jose Vargas", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", "_href": "/api/ibexa/v2/content/objects/79/versions" }, "Section": { "_media-type": "application/vnd.ibexa.api.Section+json", "_href": "/api/ibexa/v2/content/sections/2" }, "MainLocation": { "_media-type": "application/vnd.ibexa.api.Location+json", "_href": "/api/ibexa/v2/content/locations/1/5/12/79" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", "_href": "/api/ibexa/v2/content/objects/79/locations" }, "Groups": { "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", "_href": "/api/ibexa/v2/user/users/79/groups" }, "Owner": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/10" }, "publishDate": "2021-06-29T08:23:42+00:00", "lastModificationDate": "2021-07-29T12:00:24+00:00", "mainLanguageCode": "eng-GB", "alwaysAvailable": true, "Version": { "_media-type": "application/vnd.ibexa.api.Version+json", "_href": "/api/ibexa/v2/content/objects/79/versions/11", "VersionInfo": { "id": 614, "versionNo": 11, "status": "PUBLISHED", "modificationDate": "2021-07-29T12:00:24+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" }, "creationDate": "2021-07-29T12:00:24+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", "Language": [ { "languageCode": "eng-GB" } ] }, "names": { "value": [ { "_languageCode": "eng-GB", "#text": "Jose Vargas" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", "_href": "/api/ibexa/v2/content/objects/79" } }, "Fields": { "field": [ { "id": 342, "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Jose" }, { "id": 343, "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", "fieldValue": "Vargas" }, { "id": 344, "fieldDefinitionIdentifier": "user_account", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_user", "fieldValue": { "hasStoredLogin": true, "contentId": 79, "login": "josevargas", "email": "aa@bb.cc", "passwordUpdatedAt": null, "enabled": false, "maxLogin": 0, "plainPassword": null } }, { "id": 345, "fieldDefinitionIdentifier": "signature", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_text", "fieldValue": null }, { "id": 346, "fieldDefinitionIdentifier": "image", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_image", "fieldValue": null } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", "_href": "/api/ibexa/v2/content/objects/79/versions/11/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#user", "width": null, "height": null, "mimeType": "image/svg+xml" } }, "login": "josevargas", "email": "aa@bb.cc", "enabled": false, "UserGroups": { "_media-type": "application/vnd.ibexa.api.UserGroupList+json", "_href": "/api/ibexa/v2/user/users/79/groups" }, "Roles": { "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", "_href": "/api/ibexa/v2/user/users/79/roles" } } } }, "application/vnd.ibexa.api.User+xml": { "schema": { "$ref": "#/components/schemas/User" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/79\" id=\"79\" remoteId=\"bcf0764b417f05af21852a1f03fb1f13\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/4\"/>\n <name>Jose Vargas</name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/79/versions\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\"/>\n <MainLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/5/12/79\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/79/locations\"/>\n <Groups media-type=\"application/vnd.ibexa.api.UserGroupRefList+xml\" href=\"/api/ibexa/v2/user/users/79/groups\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/10\"/>\n <publishDate>2021-06-29T08:23:42+00:00</publishDate>\n <lastModificationDate>2021-07-29T11:45:07+00:00</lastModificationDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <alwaysAvailable>true</alwaysAvailable>\n <Version media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/79/versions/6\">\n <VersionInfo>\n <id>609</id>\n <versionNo>6</versionNo>\n <status>PUBLISHED</status>\n <modificationDate>2021-07-29T11:45:07+00:00</modificationDate>\n <Creator media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <creationDate>2021-07-29T11:45:07+00:00</creationDate>\n <initialLanguageCode>eng-GB</initialLanguageCode>\n <languageCodes>eng-GB</languageCodes>\n <VersionTranslationInfo media-type=\"application/vnd.ibexa.api.VersionTranslationInfo+xml\">\n <Language>\n <languageCode>eng-GB</languageCode>\n </Language>\n </VersionTranslationInfo>\n <names>\n <value languageCode=\"eng-GB\">Jose Vargas</value>\n </names>\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/79\"/>\n </VersionInfo>\n <Fields>\n <field>\n <id>342</id>\n <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Jose</fieldValue>\n </field>\n <field>\n <id>343</id>\n <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier>\n <fieldValue>Vargas</fieldValue>\n </field>\n <field>\n <id>344</id>\n <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier>\n <fieldValue>\n <value key=\"hasStoredLogin\">true</value>\n <value key=\"contentId\">79</value>\n <value key=\"login\">josevargas</value>\n <value key=\"email\">aa@bb.cc</value>\n <value key=\"passwordUpdatedAt\"/>\n <value key=\"enabled\">false</value>\n <value key=\"maxLogin\">0</value>\n <value key=\"plainPassword\"/>\n </fieldValue>\n </field>\n <field>\n <id>345</id>\n <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n <field>\n <id>346</id>\n <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier>\n <fieldValue/>\n </field>\n </Fields>\n <Relations media-type=\"application/vnd.ibexa.api.RelationList+xml\" href=\"/api/ibexa/v2/content/objects/79/versions/6/relations\"/>\n <Thumbnail media-type=\"application/vnd.ibexa.api.Thumbnail+xml\">\n <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource>\n <width></width>\n <height></height>\n <mimeType>image/svg+xml</mimeType>\n </Thumbnail>\n </Version>\n <login>josevargas</login>\n <email>aa@bb.cc</email>\n <enabled>false</enabled>\n <UserGroups media-type=\"application/vnd.ibexa.api.UserGroupList+xml\" href=\"/api/ibexa/v2/user/users/79/groups\"/>\n <Roles media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/users/79/roles\"/>\n</User>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create this User." }, "403": { "description": "Error - a User with the same login already exists." }, "404": { "description": "Error - the Group with the given ID does not exist." } }, "summary": "Create User", "description": "Creates a new User in the given Group.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new User is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The UserCreate schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "path", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new UserCreateController resource", "content": { "application/vnd.ibexa.api.UserCreate+json": { "schema": { "$ref": "#/components/schemas/UserCreateWrapper" }, "example": { "UserCreate": { "mainLanguageCode": "eng-GB", "remoteId": "remoteId-23456789", "login": "johnsmith2", "email": "example@example.com", "password": "Secrepassword5!", "fields": { "field": [ { "fieldDefinitionIdentifier": "first_name", "languageCode": "eng-GB", "fieldValue": "John" }, { "fieldDefinitionIdentifier": "last_name", "languageCode": "eng-GB", "fieldValue": "Smith" }, { "fieldDefinitionIdentifier": "user_account", "languageCode": "eng-GB", "fieldValue": { "hasStoredLogin": true, "contentId": 14, "login": "johnsmith", "email": "example@example.com", "enabled": true, "maxLogin": 10 } } ] } } } }, "application/vnd.ibexa.api.UserCreate+xml": { "schema": { "$ref": "#/components/schemas/UserCreate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserCreate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <remoteId>remoteId-23456789</remoteId>\n <login>johnsmith</login>\n <email>example@example.com</email>\n <password>Secrepassword5!</password>\n <fields>\n <field>\n <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldValue>John</fieldValue>\n </field>\n <field>\n <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldValue>Smith</fieldValue>\n </field>\n <field>\n <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier>\n <languageCode>eng-GB</languageCode>\n <fieldValue>\n <value key=\"hasStoredLogin\">true</value>\n <value key=\"contentId\">14</value>\n <value key=\"login\">johnsmith</value>\n <value key=\"email\">example@example.com</value>\n <value key=\"enabled\">true</value>\n <value key=\"maxLogin\">10</value>\n </fieldValue>\n </field>\n </fields>\n</UserCreate>\n" } }, "required": false }, "deprecated": false } }, "/user/policies": { "get": { "operationId": "api_userpolicies_get", "tags": [ "User Policy" ], "responses": { "200": { "description": "OK - Policies which are applied to a given User.", "content": { "application/vnd.ibexa.api.PolicyList+json": { "schema": { "$ref": "#/components/schemas/PolicyListWrapper" }, "example": { "PolicyList": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/1/policies", "Policy": [ { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/349", "id": 349, "module": "content", "function": "read", "limitations": { "limitation": [ { "_identifier": "Section", "values": { "ref": [ { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "1" }, { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "3" }, { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "6" } ] } } ] } }, { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/350", "id": 350, "module": "user", "function": "login", "limitations": { "limitation": [ { "_identifier": "SiteAccess", "values": { "ref": [ { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "2282622326" }, { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "1766001124" } ] } } ] } }, { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/351", "id": 351, "module": "content", "function": "view_embed", "limitations": { "limitation": [ { "_identifier": "Class", "values": { "ref": [ { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "5" }, { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "12" } ] } } ] } }, { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/352", "id": 352, "module": "user", "function": "register" }, { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/353", "id": 353, "module": "user", "function": "password" } ] } } }, "application/vnd.ibexa.api.PolicyList+xml": { "schema": { "$ref": "#/components/schemas/PolicyList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<PolicyList media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/1/policies\">\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"/api/ibexa/v2/user/roles/1/policies/349\">\n <id>349</id>\n <module>content</module>\n <function>read</function>\n <limitations>\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"1\"/>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"3\"/>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"6\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"/api/ibexa/v2/user/roles/1/policies/350\">\n <id>350</id>\n <module>user</module>\n <function>login</function>\n <limitations>\n <limitation identifier=\"SiteAccess\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"2282622326\"/>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"1766001124\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"/api/ibexa/v2/user/roles/1/policies/351\">\n <id>351</id>\n <module>content</module>\n <function>view_embed</function>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"5\"/>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"12\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"/api/ibexa/v2/user/roles/1/policies/352\">\n <id>352</id>\n <module>user</module>\n <function>register</function>\n </Policy>\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"/api/ibexa/v2/user/roles/1/policies/353\">\n <id>353</id>\n <module>user</module>\n <function>password</function>\n </Policy>\n</PolicyList>\n" } } }, "401": { "description": "Error - the user has no permission to read Roles." } }, "summary": "List Policies for User", "description": "Search all Policies which are applied to a given User.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Policy list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/roles": { "get": { "operationId": "api_userroles_get", "tags": [ "User Role" ], "responses": { "200": { "description": "OK - list of all Roles.", "content": { "application/vnd.ibexa.api.RoleList+json": { "schema": { "$ref": "#/components/schemas/RoleListWrapper" }, "example": { "RoleList": { "_media-type": "application/vnd.ibexa.api.RoleList+json", "_href": "/api/ibexa/v2/user/roles", "Role": [ { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/1", "identifier": "Anonymous", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/1/policies" } }, { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/2", "identifier": "Administrator", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/2/policies" } }, { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/3", "identifier": "Editor", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/3/policies" } }, { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/4", "identifier": "Member", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/4/policies" } }, { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/10", "identifier": "NewRole", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/10/policies" } }, { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/14", "identifier": "NewRole5", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/14/policies" } }, { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/15", "identifier": "NewRole7", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/15/policies" } } ] } } }, "application/vnd.ibexa.api.RoleList+xml": { "schema": { "$ref": "#/components/schemas/RoleList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleList media-type=\"application/vnd.ibexa.api.RoleList+xml\" href=\"/api/ibexa/v2/user/roles\">\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/1\">\n <identifier>Anonymous</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/1/policies\"/>\n </Role>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/2\">\n <identifier>Administrator</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/2/policies\"/>\n </Role>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/3\">\n <identifier>Editor</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/3/policies\"/>\n </Role>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/4\">\n <identifier>Member</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/4/policies\"/>\n </Role>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/10\">\n <identifier>NewRole</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/10/policies\"/>\n </Role>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/14\">\n <identifier>NewRole5</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/14/policies\"/>\n </Role>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/15\">\n <identifier>NewRole7</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/15/policies\"/>\n </Role>\n</RoleList>\n" } } }, "401": { "description": "Error - the user has no permission to read Roles." } }, "summary": "Load Roles", "description": "Returns a list of all Roles.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the user list returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_userroles_post", "tags": [ "User Role" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Role+json": { "schema": { "$ref": "#/components/schemas/RoleWrapper" }, "example": { "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/6", "identifier": "UpdatedIdentifier", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/6/policies" } } } }, "application/vnd.ibexa.api.Role+xml": { "schema": { "$ref": "#/components/schemas/Role" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/9\">\n <identifier>UpdatedIdentifier</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/9/policies\"/>\n</Role>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to create a Role or a Role draft." } }, "summary": "Create Role or Role draft", "description": "Creates a new Role or Role draft.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new user is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The RoleInput schema encoded in XML or JSON.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new RoleCreateController resource", "content": { "application/vnd.ibexa.api.RoleInput+json": { "schema": { "$ref": "#/components/schemas/RoleInputWrapper" }, "example": { "RoleInput": { "identifier": "NewRole" } } }, "application/vnd.ibexa.api.RoleInput+xml": { "schema": { "$ref": "#/components/schemas/RoleInput" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleInput>\n <identifier>NewRole</identifier>\n</RoleInput>" } }, "required": false }, "deprecated": false } }, "/user/roles/{id}": { "get": { "operationId": "api_userroles_id_get", "tags": [ "User Role" ], "responses": { "200": { "description": "OK - Role for the given ID.", "content": { "application/vnd.ibexa.api.Role+json": { "schema": { "$ref": "#/components/schemas/RoleWrapper" }, "example": { "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/6", "identifier": "UpdatedIdentifier", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/6/policies" } } } }, "application/vnd.ibexa.api.Role+xml": { "schema": { "$ref": "#/components/schemas/Role" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/9\">\n <identifier>UpdatedIdentifier</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/9/policies\"/>\n</Role>\n" } } }, "401": { "description": "Error - the user has no permission to read Roles." }, "404": { "description": "Error - the Role does not exist." } }, "summary": "Load Role", "description": "Loads a Role for the given ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the user list returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_userroles_id_post", "tags": [ "User Role" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.RoleDraft+json": { "schema": { "$ref": "#/components/schemas/RoleDraftWrapper" }, "example": { "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/6", "identifier": "UpdatedIdentifier", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/6/policies" } } } }, "application/vnd.ibexa.api.RoleDraft+xml": { "schema": { "$ref": "#/components/schemas/RoleDraft" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Role href=\"/user/roles/11\" media-type=\"application/vnd.ibexa.api.RoleDraft+xml\">\n <identifier>MyRole</identifier>\n <Policies href=\"/user/roles/11/policies\" media-type=\"application/vnd.ibexa.api.PolicyList+xml\"/>\n</Role>\n" } } }, "401": { "description": "Error - the user is not authorized to create a Role or a Role draft" } }, "summary": "Create Role Draft", "description": "Creates a new Role draft from an existing Role.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new user is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The RoleInput schema encoded in XML or JSON.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new RoleDraftCreateController resource", "content": [], "required": false }, "deprecated": false }, "delete": { "operationId": "api_userroles_id_delete", "tags": [ "User Role" ], "responses": { "204": { "description": "No Content." }, "401": { "description": "Error - the User is not authorized to delete this Role." } }, "summary": "Delete Role", "description": "The given Role and all assignments to Users or User Groups are deleted.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_userroles_id_patch", "tags": [ "User Role" ], "responses": { "200": { "description": "OK - Role updated", "content": { "application/vnd.ibexa.api.Role+json": { "schema": { "$ref": "#/components/schemas/RoleWrapper" }, "example": { "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/6", "identifier": "UpdatedIdentifier", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/6/policies" } } } }, "application/vnd.ibexa.api.Role+xml": { "schema": { "$ref": "#/components/schemas/Role" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/9\">\n <identifier>UpdatedIdentifier</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/9/policies\"/>\n</Role>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update the Role." }, "412": { "description": "Error - the current ETag does not match with the provided one in the If-Match header." } }, "summary": "Update Role", "description": "Updates a Role. PATCH or POST with header X-HTTP-Method-Override PATCH", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the new user is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The RoleInput schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "ETag Causes to patch only if the specified ETag is the current one. Otherwise a 412 is returned.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated RoleUpdateController resource", "content": { "application/vnd.ibexa.api.RoleInput+json": { "schema": { "$ref": "#/components/schemas/RoleInputWrapper" }, "example": { "RoleInput": { "identifier": "NewRole" } } }, "application/vnd.ibexa.api.RoleInput+xml": { "schema": { "$ref": "#/components/schemas/RoleInput" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleInput>\n <identifier>NewRole</identifier>\n</RoleInput>" } }, "required": false }, "deprecated": false } }, "/user/roles/{id}/draft": { "get": { "operationId": "api_userroles_iddraft_get", "tags": [ "User Role" ], "responses": { "200": { "description": "OK - Role draft by original Role ID.", "content": { "application/vnd.ibexa.api.Role+json": { "schema": { "$ref": "#/components/schemas/RoleWrapper" }, "example": { "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/6", "identifier": "UpdatedIdentifier", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/6/policies" } } } }, "application/vnd.ibexa.api.Role+xml": { "schema": { "$ref": "#/components/schemas/Role" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/9\">\n <identifier>UpdatedIdentifier</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/9/policies\"/>\n</Role>\n" } } }, "401": { "description": "Error - the user has no permission to read Roles." }, "404": { "description": "Error - there is no draft or Role with the given ID." } }, "summary": "Load Role draft", "description": "Loads a Role draft by original Role ID.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the User list returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_userroles_iddraft_delete", "tags": [ "User Role" ], "responses": { "204": { "description": "No Content." }, "401": { "description": "Error - the user is not authorized to delete this Role." } }, "summary": "Delete Role draft", "description": "The given Role draft is deleted.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_userroles_iddraft_patch", "tags": [ "User Role" ], "responses": { "200": { "description": "OK - Role draft updated.", "content": { "application/vnd.ibexa.api.Role+json": { "schema": { "$ref": "#/components/schemas/RoleWrapper" }, "example": { "Role": { "_media-type": "application/vnd.ibexa.api.Role+json", "_href": "/api/ibexa/v2/user/roles/6", "identifier": "UpdatedIdentifier", "Policies": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/6/policies" } } } }, "application/vnd.ibexa.api.Role+xml": { "schema": { "$ref": "#/components/schemas/Role" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/9\">\n <identifier>UpdatedIdentifier</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/9/policies\"/>\n</Role>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the user is not authorized to update the Role." }, "404": { "description": "Error - there is no draft or Role with the given ID." }, "412": { "description": "Error - the current ETag does not match with the one provided in the If-Match header." } }, "summary": "Update Role draft", "description": "Updates a Role draft. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Role is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The RoleInput schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "Performs a PATCH only if the specified ETag is the current one. Otherwise a 412 is returned.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated RoleDraftUpdateController resource", "content": { "application/vnd.ibexa.api.RoleInput+json": { "schema": { "$ref": "#/components/schemas/RoleInputWrapper" }, "example": { "RoleInput": { "identifier": "NewRole" } } }, "application/vnd.ibexa.api.RoleInput+xml": { "schema": { "$ref": "#/components/schemas/RoleInput" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleInput>\n <identifier>NewRole</identifier>\n</RoleInput>" } }, "required": false }, "deprecated": false } }, "/user/roles/{id}/policies": { "get": { "operationId": "api_userroles_idpolicies_get", "tags": [ "User Role" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.PolicyList+json": { "schema": { "$ref": "#/components/schemas/PolicyListWrapper" }, "example": { "PolicyList": { "_media-type": "application/vnd.ibexa.api.PolicyList+json", "_href": "/api/ibexa/v2/user/roles/1/policies", "Policy": [ { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/349", "id": 349, "module": "content", "function": "read", "limitations": { "limitation": [ { "_identifier": "Section", "values": { "ref": [ { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "1" }, { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "3" }, { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "6" } ] } } ] } }, { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/350", "id": 350, "module": "user", "function": "login", "limitations": { "limitation": [ { "_identifier": "SiteAccess", "values": { "ref": [ { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "2282622326" }, { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "1766001124" } ] } } ] } }, { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/351", "id": 351, "module": "content", "function": "view_embed", "limitations": { "limitation": [ { "_identifier": "Class", "values": { "ref": [ { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "5" }, { "_media-type": "application/vnd.ibexa.api.ref+json", "_href": "12" } ] } } ] } }, { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/352", "id": 352, "module": "user", "function": "register" }, { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/353", "id": 353, "module": "user", "function": "password" } ] } } }, "application/vnd.ibexa.api.PolicyList+xml": { "schema": { "$ref": "#/components/schemas/PolicyList" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<PolicyList media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/1/policies\">\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"/api/ibexa/v2/user/roles/1/policies/349\">\n <id>349</id>\n <module>content</module>\n <function>read</function>\n <limitations>\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"1\"/>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"3\"/>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"6\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"/api/ibexa/v2/user/roles/1/policies/350\">\n <id>350</id>\n <module>user</module>\n <function>login</function>\n <limitations>\n <limitation identifier=\"SiteAccess\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"2282622326\"/>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"1766001124\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"/api/ibexa/v2/user/roles/1/policies/351\">\n <id>351</id>\n <module>content</module>\n <function>view_embed</function>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"5\"/>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"12\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"/api/ibexa/v2/user/roles/1/policies/352\">\n <id>352</id>\n <module>user</module>\n <function>register</function>\n </Policy>\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"/api/ibexa/v2/user/roles/1/policies/353\">\n <id>353</id>\n <module>user</module>\n <function>password</function>\n </Policy>\n</PolicyList>\n" } } }, "401": { "description": "Error - the user has no permission to read Roles." }, "404": { "description": "Error - the Role does not exist." } }, "summary": "Load Policies", "description": "Loads Policies for the given Role.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Policy list is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "api_userroles_idpolicies_post", "tags": [ "User Role" ], "responses": { "201": { "description": "201", "content": { "application/vnd.ibexa.api.Policy+json": { "schema": { "$ref": "#/components/schemas/PolicyWrapper" }, "example": { "Policy": { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/352", "id": 352, "module": "user", "function": "register" } } }, "application/vnd.ibexa.api.Policy+xml": { "schema": { "$ref": "#/components/schemas/Policy" }, "example": "<Policy href=\"/user/roles/11/policies/55\" media-type=\"application/vnd.ibexa.api.Policy+xml\">\n <id>55</id>\n <module>content</module>\n <function>create</function>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref href=\"/content/types/14\"/>\n </values>\n </limitation>\n <limitation identifier=\"ParentClass\">\n <values>\n <ref href=\"/content/types/10\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition or validation of limitation in PolicyCreate fails." }, "401": { "description": "Error - the user is not authorized to create the Policy." }, "404": { "description": "Error - the Role does not exist." } }, "summary": "Create Policy", "description": "Creates a Policy", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Policy is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "If set, the updated Policy is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new RolePolicyCreateController resource", "content": { "application/vnd.ibexa.api.PolicyCreate+json": { "schema": { "$ref": "#/components/schemas/PolicyCreateWrapper" } }, "application/vnd.ibexa.api.PolicyCreate+xml": { "schema": { "$ref": "#/components/schemas/PolicyCreate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<PolicyCreate>\n <module>content</module>\n <function>create</function>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref href=\"2\"/>\n </values>\n </limitation>\n <limitation identifier=\"ParentClass\">\n <values>\n <ref href=\"1\"/>\n </values>\n </limitation>\n </limitations>\n</PolicyCreate>\n" } }, "required": false }, "deprecated": false }, "delete": { "operationId": "api_userroles_idpolicies_delete", "tags": [ "User Role" ], "responses": { "204": { "description": "No Content - all Policies of the given Role are deleted." }, "401": { "description": "Error - the user is not authorized to delete this content type." } }, "summary": "Delete Policies", "description": "All Policies of the given Role are deleted.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/roles/{roleId}/policies/{policyId}": { "get": { "operationId": "api_userroles_roleIdpolicies_policyId_get", "tags": [ "User Role" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Policy+json": { "schema": { "$ref": "#/components/schemas/PolicyWrapper" }, "example": { "Policy": { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/352", "id": 352, "module": "user", "function": "register" } } }, "application/vnd.ibexa.api.Policy+xml": { "schema": { "$ref": "#/components/schemas/Policy" }, "example": "<Policy href=\"/user/roles/11/policies/55\" media-type=\"application/vnd.ibexa.api.Policy+xml\">\n <id>55</id>\n <module>content</module>\n <function>create</function>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref href=\"/content/types/14\"/>\n </values>\n </limitation>\n <limitation identifier=\"ParentClass\">\n <values>\n <ref href=\"/content/types/10\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n" } } }, "401": { "description": "Error - the user has no permission to read Roles." }, "404": { "description": "Error - the Role or Policy does not exist." } }, "summary": "Load Policy", "description": "Loads a Policy for the given module and function.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the Policy is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-None-Match", "in": "header", "description": "ETag", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "policyId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "roleId", "in": "path", "description": "RolePolicyLoadByIdController identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "delete": { "operationId": "api_userroles_roleIdpolicies_policyId_delete", "tags": [ "User Role" ], "responses": { "204": { "description": "No Content - the given Policy is deleted." }, "401": { "description": "Error - the user is not authorized to delete this content type." }, "404": { "description": "Error - the Role or Policy does not exist." } }, "summary": "Delete Policy", "description": "Deletes given Policy.", "parameters": [ { "name": "policyId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "roleId", "in": "path", "description": "RolePolicyDeleteController identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "patch": { "operationId": "api_userroles_roleIdpolicies_policyId_patch", "tags": [ "User Role" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Policy+json": { "schema": { "$ref": "#/components/schemas/PolicyWrapper" }, "example": { "Policy": { "_media-type": "application/vnd.ibexa.api.Policy+json", "_href": "/api/ibexa/v2/user/roles/1/policies/352", "id": 352, "module": "user", "function": "register" } } }, "application/vnd.ibexa.api.Policy+xml": { "schema": { "$ref": "#/components/schemas/Policy" }, "example": "<Policy href=\"/user/roles/11/policies/55\" media-type=\"application/vnd.ibexa.api.Policy+xml\">\n <id>55</id>\n <module>content</module>\n <function>create</function>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref href=\"/content/types/14\"/>\n </values>\n </limitation>\n <limitation identifier=\"ParentClass\">\n <values>\n <ref href=\"/content/types/10\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition or validation of limitation in PolicyUpdate fails." }, "401": { "description": "Error - the user is not authorized to update the Policy." }, "404": { "description": "Error - the Role does not exist." }, "412": { "description": "Error - the current ETag does not match with the one provided in the If-Match header." } }, "summary": "Update Policy", "description": "Updates a Policy. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the updated Policy is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "If set, the updated Policy is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "If-Match", "in": "header", "description": "Causes to patch only if the specified ETag is the current one. Otherwise a 412 is returned.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "policyId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "roleId", "in": "path", "description": "RolePolicyUpdateController identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated RolePolicyUpdateController resource", "content": { "application/vnd.ibexa.api.PolicyUpdate+json": { "schema": { "$ref": "#/components/schemas/PolicyUpdateWrapper" } }, "application/vnd.ibexa.api.PolicyUpdate+xml": { "schema": { "$ref": "#/components/schemas/PolicyUpdate" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<PolicyUpdate>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref href=\"2\"/>\n </values>\n </limitation>\n <limitation identifier=\"ParentClass\">\n <values>\n <ref href=\"1\"/>\n </values>\n </limitation>\n </limitations>\n</PolicyUpdate>\n" } }, "required": false }, "deprecated": false } }, "/user/sessions": { "post": { "operationId": "api_usersessions_post", "tags": [ "User Session" ], "responses": { "200": { "description": "Session already exists.", "content": { "application/vnd.ibexa.api.Session+json": { "schema": { "$ref": "#/components/schemas/SessionWrapper" }, "example": { "Session": { "_media-type": "application/vnd.ibexa.api.Session", "name": "eZSSID", "identifier": "go327ij2cirpo59pb6rrv2a4el2", "csrfToken": "23lkneri34ijajedfw39orj3j93", "User": { "_href": "/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" } } } }, "application/vnd.ibexa.api.Session+xml": { "schema": { "$ref": "#/components/schemas/Session" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Session media-type=\"application/vnd.ibexa.api.Session+xml\" href=\"/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ\">\n <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name>\n <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier>\n <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken>\n <User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n</Session>\n" } } }, "201": { "description": "Session is created.", "content": { "application/vnd.ibexa.api.Session+json": { "schema": { "$ref": "#/components/schemas/SessionWrapper" }, "example": { "Session": { "_media-type": "application/vnd.ibexa.api.Session", "name": "eZSSID", "identifier": "go327ij2cirpo59pb6rrv2a4el2", "csrfToken": "23lkneri34ijajedfw39orj3j93", "User": { "_href": "/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" } } } }, "application/vnd.ibexa.api.Session+xml": { "schema": { "$ref": "#/components/schemas/Session" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Session media-type=\"application/vnd.ibexa.api.Session+xml\" href=\"/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ\">\n <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name>\n <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier>\n <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken>\n <User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n</Session>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { "description": "Error - the authorization failed." }, "409": { "description": "Error - header contained a session cookie but different user was authorized." } }, "summary": "Create session (login a User)", "description": "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.", "parameters": [ { "name": "Accept", "in": "header", "description": "If set, the session is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The SessionInput schema encoded in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Cookie", "in": "header", "description": "Only needed for session's checking {sessionName}={sessionID}.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new SessionCreateController resource", "content": { "application/vnd.ibexa.api.SessionInput+json": { "schema": { "$ref": "#/components/schemas/SessionInputWrapper" }, "example": { "SessionInput": { "login": "admin", "password": "secret" } } }, "application/vnd.ibexa.api.SessionInput+xml": { "schema": { "$ref": "#/components/schemas/SessionInput" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SessionInput>\n <login>admin</login>\n <password>secret</password>\n</SessionInput>\n" } }, "required": false }, "deprecated": false } }, "/user/sessions/current": { "get": { "operationId": "api_usersessionscurrent_get", "tags": [ "User Session" ], "responses": { "200": { "description": "User is currently logged in and has a valid session.", "content": { "application/vnd.ibexa.api.Session+json": { "schema": { "$ref": "#/components/schemas/SessionWrapper" }, "example": { "Session": { "_media-type": "application/vnd.ibexa.api.Session", "name": "eZSSID", "identifier": "go327ij2cirpo59pb6rrv2a4el2", "csrfToken": "23lkneri34ijajedfw39orj3j93", "User": { "_href": "/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" } } } }, "application/vnd.ibexa.api.Session+xml": { "schema": { "$ref": "#/components/schemas/Session" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Session media-type=\"application/vnd.ibexa.api.Session+xml\" href=\"/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ\">\n <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name>\n <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier>\n <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken>\n <User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n</Session>\n" } } }, "404": { "description": "User does not have a valid session, or it has expired." } }, "summary": "Get current session", "description": "Get current user session, if any.", "parameters": [ { "name": "Cookie", "in": "header", "description": "Only needed for session's checking {sessionName}={sessionID}.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Accept", "in": "header", "description": "If set, the session is returned in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/sessions/{sessionId}": { "delete": { "operationId": "api_usersessions_sessionId_delete", "tags": [ "User Session" ], "responses": { "204": { "description": "OK - session deleted." }, "404": { "description": "Error - the session does not exist." } }, "summary": "Delete session (logout a User)", "description": "The user session is removed i.e. the user is logged out.", "parameters": [ { "name": "Cookie", "in": "header", "description": "{sessionName}={sessionID}", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "The {csrfToken} needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "sessionId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false } }, "/user/sessions/{sessionId}/refresh": { "post": { "operationId": "api_usersessions_sessionIdrefresh_post", "tags": [ "User Session" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.Session+json": { "schema": { "$ref": "#/components/schemas/SessionWrapper" }, "example": { "Session": { "_media-type": "application/vnd.ibexa.api.Session", "name": "eZSSID", "identifier": "go327ij2cirpo59pb6rrv2a4el2", "csrfToken": "23lkneri34ijajedfw39orj3j93", "User": { "_href": "/user/users/14", "_media-type": "application/vnd.ibexa.api.User+json" } } } }, "application/vnd.ibexa.api.Session+xml": { "schema": { "$ref": "#/components/schemas/Session" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Session media-type=\"application/vnd.ibexa.api.Session+xml\" href=\"/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ\">\n <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name>\n <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier>\n <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken>\n <User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n</Session>\n" } } }, "404": { "description": "Error - the session does not exist." } }, "summary": "Refresh session (deprecated)", "description": "Get the session's User information. Deprecated as of Ibexa DXP 4.6, use GET /user/sessions/current instead.", "parameters": [ { "name": "Cookie", "in": "header", "description": "{sessionName}={sessionID}", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "X-CSRF-Token", "in": "header", "description": "The {csrfToken} needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Accept", "in": "header", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "sessionId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new SessionRefreshController resource", "content": [], "required": false }, "deprecated": false } }, "/user/token/jwt": { "post": { "operationId": "api_usertokenjwt_post", "tags": [ "User Token" ], "responses": { "200": { "description": "OK - returns the JWT in JSON format.", "content": { "application/vnd.ibexa.api.JWT+json": { "schema": { "$ref": "#/components/schemas/JWTWrapper" }, "example": { "JWT": { "_media-type": "application/vnd.ibexa.api.JWT+json", "_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3ODAsImV4cCI6MTYwMjg0NDM4MCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.0LHa799HwSwwfDBZd2V0q2xHwGt86PpyZamKnXHQyYI", "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3ODAsImV4cCI6MTYwMjg0NDM4MCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.0LHa799HwSwwfDBZd2V0q2xHwGt86PpyZamKnXHQyYI" } } } } }, "401": { "description": "Error - Unauthorized" } }, "summary": "Create JWT token", "description": "Creates JWT authentication token.", "parameters": [], "requestBody": { "description": "The credentials in JWTInput JSON format.", "content": { "application/vnd.ibexa.api.JWTInput+json": { "schema": { "$ref": "#/components/schemas/JWTInputWrapper" }, "example": { "JWTInput": { "_media-type": "application/vnd.ibexa.api.JWTInput", "username": "admin", "password": "publish" } } } }, "required": false }, "deprecated": false } }, "/views": { "post": { "operationId": "api_views_post", "tags": [ "Views" ], "responses": { "200": { "description": "200", "content": { "application/vnd.ibexa.api.View+xml; version=1.1": { "schema": { "$ref": "#/components/schemas/View" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<View href=\"/views/TitleView\" media-type=\"application/vnd.ibexa.api.View+xml; version=1.1\">\n <identifier>TitleView</identifier>\n <User href=\"/user/users/14\" media-type=\"vnd.ibexa.api.User+xml\"/>\n <public>false</public>\n <LocationQuery>\n <Filter>\n <ParentLocationIdCriterion>2</ParentLocationIdCriterion>\n </Filter>\n <limit>10</limit>\n <offset>0</offset>\n <SortClauses>\n <ContentName>ascending</ContentName>\n </SortClauses>\n <FacetBuilders>\n <contentTypeFacetBuilder/>\n </FacetBuilders>\n </LocationQuery>\n <Result href=\"/content/views/view1234/results\"\n media-type=\"application/vnd.ibexa.api.ViewResult+xml\" count=\"34\" time=\"31\" maxScore=\"1.0\">\n <searchHits>\n <searchHit score=\"1.0\" index=\"installid1234567890\">\n <hightlight/>\n <value>\n <Location media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1/2\">\n <id>2</id>\n <priority>0</priority>\n <hidden>false</hidden>\n <invisible>false</invisible>\n <ParentLocation media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/1\"/>\n <pathString>/1/2/</pathString>\n <depth>1</depth>\n <childCount>8</childCount>\n <remoteId>f3e90596361e31d496d4026eb624c983</remoteId>\n <Children media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/locations/1/2/children\"/>\n <Content media-type=\"application/vnd.ibexa.api.Content+xml\" href=\"/api/ibexa/v2/content/objects/57\"/>\n <sortField>PRIORITY</sortField>\n <sortOrder>ASC</sortOrder>\n <UrlAliases media-type=\"application/vnd.ibexa.api.UrlAliasRefList+xml\" href=\"/api/ibexa/v2/content/locations/1/2/urlaliases\"/>\n </Location>\n\n </value>\n </searchHit>\n <!-- ... -->\n </searchHits>\n <facets>\n <contentTypeFacet>\n <contentTypeFacetEntry>\n <contentType href=\"/content/types/1\" media-type=\"application/vnd.ibexa.api.ContentType+xml\"/>\n <count>3</count>\n </contentTypeFacetEntry>\n <contentTypeFacetEntry>\n <contentType href=\"/content/types/7\" media-type=\"application/vnd.ibexa.api.ContentType+xml\"/>\n <count>9</count>\n </contentTypeFacetEntry>\n <contentTypeFacetEntry>\n <contentType href=\"/content/types/11\" media-type=\"application/vnd.ibexa.api.ContentType+xml\"/>\n <count>1</count>\n </contentTypeFacetEntry>\n <contentTypeFacetEntry>\n <contentType href=\"/content/types/15\" media-type=\"application/vnd.ibexa.api.ContentType+xml\"/>\n <count>8</count>\n </contentTypeFacetEntry>\n </contentTypeFacet>\n </facets>\n </Result>\n</View>\n" } } }, "400": { "description": "Error - the input does not match the input schema definition." } }, "summary": "Search content", "description": "Executes a query and returns a View including the results.\nView input reflects the criteria model of the public PHP API.\nRefer to [Search Criteria Reference](/en/latest/search/criteria_reference/search_criteria_reference/)", "parameters": [ { "name": "Accept", "in": "header", "description": "The view in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "Content-Type", "in": "header", "description": "The view input in XML or JSON format.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new Views resource", "content": { "application/vnd.ibexa.api.ViewInput+json": { "schema": { "$ref": "#/components/schemas/ViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", "Query": { "Filter": { "ContentTypeIdentifierCriterion": "image", "SectionIdentifierCriterion": "media", "DateMetadataCriterion": { "Target": "modified", "Value": 1675681020, "Operator": "gte" } }, "limit": 10, "offset": 0, "SortClauses": { "ContentName": "ascending" }, "Aggregations": [ { "ContentTypeTermAggregation": { "name": "some name" } } ] } } } }, "application/vnd.ibexa.api.ViewInput+xml": { "schema": { "$ref": "#/components/schemas/ViewInput" }, "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ViewInput>\n <identifier>TitleView</identifier>\n <Query>\n <Filter>\n <ContentTypeIdentifierCriterion>image</ContentTypeIdentifierCriterion>\n <SectionIdentifierCriterion>media</SectionIdentifierCriterion>\n <DateMetadataCriterion>\n <Target>modified</Target>\n <Value>1675681020</Value>\n <Operator>gte</Operator>\n </DateMetadataCriterion>\n </Filter>\n <limit>10</limit>\n <offset>0</offset>\n <SortClauses>\n <ContentName>ascending</ContentName>\n </SortClauses>\n <Aggregations>\n <Aggregation>\n <ContentTypeTermAggregation>\n <name>some name</name>\n </ContentTypeTermAggregation>\n </Aggregation>\n </Aggregations>\n </Query>\n</ViewInput>\n" } }, "required": false }, "deprecated": false } } }, "components": { "schemas": { "BaseObject": { "type": "object", "required": [ "_media-type" ], "properties": { "_media-type": { "xml": { "attribute": true, "name": "media-type" }, "type": "string" }, "_href": { "xml": { "attribute": true, "name": "href" }, "type": "string" } } }, "Ref": { "$ref": "#/components/schemas/BaseObject" }, "UnixTimestamp": { "type": "integer" }, "Href": { "type": "object", "required": [ "_href" ], "properties": { "_href": { "xml": { "attribute": true, "name": "href" }, "type": "string" } } }, "Target": { "description": "Struct that stores extra target information for a SortClause object.", "type": "object" }, "SortClause": { "description": "This class is the base for SortClause classes, used to set sorting of content queries.", "type": "object", "required": [ "direction", "target", "targetData" ], "properties": { "direction": { "description": "Sort direction. One of Query::SORT_ASC or Query::SORT_DESC.", "type": "string" }, "target": { "description": "Sort target, high level: section_identifier, attribute_value, etc.", "type": "string" }, "targetData": { "description": "Extra target data, required by some sort clauses, field for instance.", "$ref": "#/components/schemas/Target" } } }, "ErrorMessage": { "description": "Represents an error response. Might contain additional properties depending on an error type.", "type": "object", "required": [ "errorCode", "errorMessage", "errorDescription" ], "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorDescription": { "type": "string" } } }, "Value": { "description": "Struct that stores extra value information for a Criterion object.", "type": "object", "required": [ "_languageCode", "#text" ], "properties": { "_languageCode": { "description": "Language code.", "type": "string" }, "#text": { "description": "Content type description.", "type": [ "string", "null" ] } } }, "ValueObject": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Value" } } } }, "ValueArray": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Value" } } } }, "MultilingualValue": { "description": "Object that represents a multilingual (translated) value.", "type": "object", "required": [ "_languageCode", "#text" ], "properties": { "_languageCode": { "description": "Language code.", "type": "string" }, "#text": { "description": "Translation contents.", "type": [ "string", "null" ] } } }, "KeyValue": { "description": "Key-value structure", "type": "object", "required": [ "_key", "#text" ], "properties": { "_key": { "type": "string" }, "#text": { "type": [ "string", "null" ] } } }, "DateRange": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Representation of date range.", "type": "object", "required": [ "startDate", "endDate" ], "properties": { "startDate": { "type": "string" }, "endDate": { "type": "string" } } } ] }, "BookmarkList": { "description": "List of bookmarked Locations.", "type": "object", "required": [ "count", "items" ], "properties": { "count": { "description": "The total number of bookmarks.", "type": "integer" }, "items": { "description": "List of bookmarked Locations.", "type": "array", "items": { "type": "object", "required": [ "Location", "_media-type", "__href" ], "properties": { "Location": { "$ref": "#/components/schemas/Location" }, "_media-type": { "type": "string" }, "__href": { "type": "string" } } } } } }, "BookmarkListWrapper": { "type": "object", "required": [ "BookmarkList" ], "properties": { "BookmarkList": { "$ref": "#/components/schemas/BookmarkList" } } }, "SummaryEntry": { "type": "object", "required": [ "identifier", "id", "names", "quantity", "Price", "PriceInclVat", "SubtotalPrice", "SubtotalPriceInclVat", "VatCategory", "Product" ], "properties": { "identifier": { "type": "string" }, "id": { "type": "integer" }, "names": { "$ref": "#/components/schemas/SummaryEntryNames" }, "quantity": { "type": "integer" }, "Price": { "$ref": "#/components/schemas/RestPriceWrapper" }, "PriceInclVat": { "$ref": "#/components/schemas/RestPriceWrapper" }, "SubtotalPrice": { "$ref": "#/components/schemas/RestPriceWrapper" }, "SubtotalPriceInclVat": { "$ref": "#/components/schemas/RestPriceWrapper" }, "VatCategory": { "$ref": "#/components/schemas/VatCategory" }, "Product": { "$ref": "#/components/schemas/Product" } } }, "SummaryEntryNames": { "$ref": "#/components/schemas/ValueObject" }, "Location": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a Location in the Repository.", "type": "object", "required": [ "id", "priority", "hidden", "invisible", "remoteId", "ContentInfo", "ParentLocation", "pathString", "depth", "childCount", "sortField", "sortOrder", "Content" ], "properties": { "id": { "description": "The ID of the Location.", "type": "integer" }, "priority": { "description": "Location priority. Position of the Location among its siblings when sorted using priority sort order.", "type": "integer" }, "hidden": { "description": "Indicates that the Location entity has been explicitly marked as hidden.", "type": "boolean" }, "invisible": { "description": "Indicates that the Location is implicitly marked as hidden by a parent Location.", "type": "boolean" }, "remoteId": { "description": "Remote ID, universally unique identifier.", "type": "string" }, "ContentInfo": { "description": "This class provides all version independent information of the content item.", "$ref": "#/components/schemas/ContentInfo" }, "ParentLocation": { "description": "Parent Location." }, "Children": { "description": "Children Location." }, "pathString": { "description": "The materialized path of the Location entry e.g. /1/2/.", "type": "string" }, "depth": { "description": "Depth Location has in the Location tree.", "type": "integer" }, "childCount": { "description": "Depth Location has in the Location tree.", "type": "integer" }, "sortField": { "description": "Specifies which property the child Locations should be sorted on. Map for Location sort fields to their respective SortClauses - class name/identifier and modified subnode. One of the fallowing values: PATH.", "enum": [ "PATH", "PUBLISHED", "MODIFIED", "SECTION", "DEPTH", "CLASS_IDENTIFIER", "CLASS_NAME", "PRIORITY", "NAME", "MODIFIED_SUBNODE", "NODE_ID", "CONTENTOBJECT_ID" ], "type": "string" }, "sortOrder": { "description": "Specifies whether the sort order should be ascending or descending. Map for Location sort order to their respective Query SORT constants. One of the fallowing values: const SORT_ORDER_DESC = 0; const SORT_ORDER_ASC = 1.", "enum": [ "ASC", "DESC" ], "type": "string" }, "Content": { "description": "Represents a content item in a specific version." }, "UrlAliases": { "description": "This class represents URL aliases." } } } ] }, "LocationWrapper": { "type": "object", "required": [ "Location" ], "properties": { "Location": { "$ref": "#/components/schemas/Location" } } }, "LocationCreate": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "required": [ "ParentLocation", "priority", "hidden", "sortField", "sortOrder" ], "properties": { "ParentLocation": { "type": "object", "required": [ "_href" ], "properties": { "_href": { "xml": { "attribute": true, "name": "href" }, "type": "string" } } }, "priority": { "type": "string" }, "hidden": { "type": [ "string", "boolean" ] }, "sortField": { "type": "string" }, "sortOrder": { "type": "string" } } } ] }, "LocationCreateWrapper": { "type": "object", "required": [ "LocationCreate" ], "properties": { "LocationCreate": { "$ref": "#/components/schemas/LocationCreate" } } }, "LocationUpdateStruct": { "description": "This class is used for updating Location meta data.", "type": "object", "required": [ "priority", "remoteId", "hidden", "sortField", "sortOrder" ], "properties": { "priority": { "description": "If set the Location priority is changed to the new value.", "type": "string" }, "remoteId": { "description": "If set the Location gets a new remoteId. Needs to be a unique Location->remoteId string value.", "type": "string" }, "hidden": { "type": "boolean" }, "sortField": { "description": "If set the sortField is changed. The sort field specifies which property the child Locations should be sorted on. Valid values are found at {@link Location::SORT_FIELD_*}.", "enum": [ "PATH", "PUBLISHED", "MODIFIED", "SECTION", "DEPTH", "CLASS_IDENTIFIER", "CLASS_NAME", "PRIORITY", "NAME", "MODIFIED_SUBNODE", "NODE_ID", "CONTENTOBJECT_ID" ], "type": "string" }, "sortOrder": { "description": "If set the sortOrder is changed. The sort order specifies whether the sort order should be ascending or descending. Valid values are {@link Location::SORT_ORDER_*}.", "enum": [ "ASC", "DESC" ], "type": "string" } } }, "LocationUpdateStructWrapper": { "type": "object", "required": [ "LocationUpdate" ], "properties": { "LocationUpdate": { "$ref": "#/components/schemas/LocationUpdateStruct" } } }, "LocationList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a queried Location list holding a totalCount and a partial list of Locations (by offset/limit parameters and permission filters).", "type": "object", "required": [ "Location" ], "properties": { "Location": { "description": "The partial list of Locations controlled by offset/limit.", "type": "array", "items": { "$ref": "#/components/schemas/Ref" } } } } ] }, "LocationListWrapper": { "type": "object", "required": [ "LocationList" ], "properties": { "LocationList": { "$ref": "#/components/schemas/LocationList" } } }, "Content": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Content ID matcher class.", "type": "object", "required": [ "_remoteId", "_id", "ContentType", "Name", "Versions", "CurrentVersion", "Section", "Locations", "Owner", "mainLanguageCode", "currentVersionNo", "alwaysAvailable", "status", "ObjectStates" ], "properties": { "_remoteId": { "description": "Remote ID of the content type.", "xml": { "attribute": true, "name": "remoteId" }, "type": "string" }, "_id": { "description": "Unique ID of the content type.", "xml": { "attribute": true, "name": "id" }, "type": "integer" }, "ContentType": { "description": "Content type.", "$ref": "#/components/schemas/BaseObject" }, "Name": { "description": "Name of the domain object in a given language.", "type": "string" }, "Versions": { "description": "Returns the VersionInfo for this version.", "$ref": "#/components/schemas/BaseObject" }, "CurrentVersion": { "description": "Current version.", "$ref": "#/components/schemas/BaseObject" }, "Section": { "description": "The Section to which the content item is assigned to.", "$ref": "#/components/schemas/BaseObject" }, "Locations": { "description": "Location of the content item.", "$ref": "#/components/schemas/BaseObject" }, "Owner": { "description": "The owner of the content item.", "$ref": "#/components/schemas/BaseObject" }, "lastModificationDate": { "description": "Content item modification date.", "type": "string", "format": "date-time" }, "publishedDate": { "description": "Content item publication date.", "type": "string", "format": "date-time" }, "mainLanguageCode": { "description": "The main language code of the content item.", "type": "string" }, "currentVersionNo": { "description": "Current version number is the version number of the published version or the version number of a newly created draft (which is 1).", "type": "integer" }, "alwaysAvailable": { "description": "Indicates if the content item is shown in the main language if it's not present in an other requested language.", "type": "boolean" }, "status": { "description": "Status of the content. Possible values: const STATUS_DRAFT = 0;const STATUS_PUBLISHED = 1; const STATUS_TRASHED = 2.", "type": "string" }, "ObjectStates": { "description": "Object states.", "$ref": "#/components/schemas/BaseObject" } } } ] }, "ContentWrapper": { "type": "object", "required": [ "Content" ], "properties": { "Content": { "$ref": "#/components/schemas/Content" } } }, "ContentCreate": { "description": "This class is used for creating a new content item.", "type": "object", "required": [ "ContentType", "mainLanguageCode", "LocationCreate", "fields" ], "properties": { "ContentType": { "description": "The content type for which the new content item is created.", "oneOf": [ { "$ref": "#/components/schemas/Content" }, { "$ref": "#/components/schemas/Href" } ] }, "Section": { "description": "The Section the content item is assigned to. If not set the Section of the parent is used or a default Section.", "$ref": "#/components/schemas/Href" }, "User": { "description": "The owner of the content. If not given the current authenticated User is set as owner.", "type": "integer" }, "alwaysAvailable": { "description": "Indicates if the content item is shown in the main language if it's not present in an other requested language.", "type": "string" }, "remoteId": { "description": "Remote identifier used as a custom identifier for the content item. Needs to be a unique Content->remoteId string value.", "type": "string" }, "mainLanguageCode": { "description": "The main language code for the content. This language will also be used for as initial language for the first created version. It is also used as default language for added fields.", "type": "string" }, "modificationDate": { "description": "Modification date. If not given, the current integer is used.", "type": "string", "format": "date-time" }, "LocationCreate": { "type": "object" }, "fields": { "type": "object", "required": [ "field" ], "properties": { "field": { "type": "array", "items": { "type": "object" } } } } } }, "ContentCreateWrapper": { "type": "object", "required": [ "ContentCreate" ], "properties": { "ContentCreate": { "$ref": "#/components/schemas/ContentCreate" } } }, "ContentUpdate": { "description": "This class is used to update a Content.", "type": "object", "required": [ "mainLanguageCode", "Section", "MainLocation", "Owner", "alwaysAvailable", "remoteId" ], "properties": { "mainLanguageCode": { "type": "string" }, "Section": { "$ref": "#/components/schemas/Section" }, "MainLocation": { "$ref": "#/components/schemas/Location" }, "Owner": { "$ref": "#/components/schemas/User" }, "alwaysAvailable": { "type": "boolean" }, "remoteId": { "type": "string" } } }, "ContentInfo": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class provides all version independent information of the content item.", "type": "object", "required": [ "Content" ], "properties": { "Content": { "description": "Content ID matcher class.", "$ref": "#/components/schemas/Content" } } } ] }, "ContentInfoWrapper": { "type": "object", "required": [ "ContentInfo" ], "properties": { "ContentInfo": { "$ref": "#/components/schemas/ContentInfo" } } }, "ContentMetadataUpdate": { "description": "This class is used to update a Content metadata.", "type": "object", "required": [ "ownerId", "publishedDate", "modificationDate", "mainLanguageCode", "alwaysAvailable", "remoteId", "mainLocationId", "name" ], "properties": { "ownerId": { "type": [] }, "publishedDate": { "type": "string", "format": "date-time" }, "modificationDate": { "type": "string", "format": "date-time" }, "mainLanguageCode": { "type": "string" }, "alwaysAvailable": { "type": "boolean" }, "remoteId": { "type": "string" }, "mainLocationId": { "type": [] }, "name": { "type": "string" } } }, "ContentCreateContentType": { "type": "object", "required": [ "_href", "FieldDefinitions" ], "properties": { "_href": { "xml": { "attribute": true, "name": "href" }, "type": "string" }, "FieldDefinitions": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "properties": { "FieldDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDefinition" } } } } ] } } }, "ContentObjectStates": { "description": "Represents a list of object states.", "type": "object", "required": [ "ObjectState" ], "properties": { "ObjectState": { "description": "List of object state values.", "type": "array", "items": { "$ref": "#/components/schemas/Href" } } } }, "ContentObjectStatesWrapper": { "type": "object", "required": [ "ContentObjectStates" ], "properties": { "ContentObjectStates": { "$ref": "#/components/schemas/ContentObjectStates" } } }, "VersionInfo": { "description": "This class holds version information data. It also contains the corresponding {@link Content} to which the version belongs to.", "type": "object", "required": [ "id", "versionNo", "status", "modificationDate", "Creator", "creationDate", "initialLanguageCode", "languageCodes", "VersionTranslationInfo", "names", "Content" ], "properties": { "id": { "description": "Version ID.", "type": "integer" }, "versionNo": { "description": "Version number. In contrast to {@link $id}, this is the version number, which only increments in scope of a single content item.", "type": "integer" }, "status": { "description": "One of: VersionInfo::STATUS_DRAFT=0, VersionInfo::STATUS_PUBLISHED=1, VersionInfo::STATUS_ARCHIVED=3.", "enum": [ "DRAFT", "PUBLISHED", "ARCHIVED" ], "type": "string" }, "modificationDate": { "description": "The last modified date of this version.", "type": "string", "format": "date-time" }, "Creator": { "description": "Creator of the version, in the search API this is referred to as the modifier of the published content.", "$ref": "#/components/schemas/BaseObject" }, "creationDate": { "description": "Content creation date.", "type": "string", "format": "date-time" }, "initialLanguageCode": { "description": "The language code which is used for labeling a translation.", "type": "string" }, "languageCodes": { "description": "List of languages in this version. Reflects which languages fields exists in for this version.", "type": "string" }, "VersionTranslationInfo": { "description": "Translation information." }, "names": { "description": "Names.", "$ref": "#/components/schemas/ValueArray" }, "Content": { "description": "Represents a content item in a specific version.", "$ref": "#/components/schemas/BaseObject" } } }, "Version": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Returns the VersionInfo for this version.", "type": "object", "required": [ "VersionInfo", "Fields", "Relations" ], "properties": { "VersionInfo": { "description": "VersionInfo for this version." }, "Fields": { "type": "object", "required": [ "field" ], "properties": { "field": { "description": "Fields of a Company content item.", "type": "array", "items": { "$ref": "#/components/schemas/Field" } } } }, "Relations": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Relations of the user.", "type": "object", "required": [ "Relation" ], "properties": { "Relation": { "type": "array", "items": { "$ref": "#/components/schemas/Relation" } } } } ] } } } ] }, "VersionWrapper": { "type": "object", "required": [ "Version" ], "properties": { "Version": { "$ref": "#/components/schemas/Version" } } }, "VersionUpdate": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class is used to update a content version.", "type": "object", "required": [ "modificationDate", "initialLanguageCode", "fields" ], "properties": { "modificationDate": { "type": "string", "format": "date-time" }, "initialLanguageCode": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" } } } } ] }, "VersionUpdateWrapper": { "type": "object", "required": [ "VersionUpdate" ], "properties": { "VersionUpdate": { "$ref": "#/components/schemas/VersionUpdate" } } }, "VersionList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of all versions of the content.", "type": "object", "required": [ "VersionItem" ], "properties": { "VersionItem": { "type": "array", "items": { "$ref": "#/components/schemas/VersionItem" } } } } ] }, "VersionListWrapper": { "type": "object", "required": [ "VersionList" ], "properties": { "VersionList": { "$ref": "#/components/schemas/VersionList" } } }, "VersionItem": { "description": "Version of content.", "type": "object", "required": [ "Version", "VersionInfo" ], "properties": { "Version": { "description": "Returns the VersionInfo for this version.", "$ref": "#/components/schemas/BaseObject" }, "VersionInfo": { "$ref": "#/components/schemas/VersionInfo" } } }, "VersionTranslationInfo": { "description": "Translation information.", "type": "object", "required": [ "_media-type", "Language" ], "properties": { "_media-type": { "type": "string" }, "Language": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageCode" } } } }, "LanguageCode": { "description": "Language code.", "type": "object", "required": [ "languageCode" ], "properties": { "languageCode": { "type": "string" } } }, "Relation": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Class representing a relation between content.", "type": "object", "required": [ "SourceContent", "DestinationContent", "RelationType" ], "properties": { "SourceContent": { "description": "The content of the source content of the relation.", "$ref": "#/components/schemas/Ref" }, "DestinationContent": { "description": "The content of the destination content of the relation.", "$ref": "#/components/schemas/Ref" }, "RelationType": { "description": "The relation type bitmask. Relations: Relation::COMMON = 1, Relation::EMBED = 2, Relation::LINK = 4, Relation::FIELD = 8, Relation::ASSET = 16", "type": "string" } } } ] }, "RelationWrapper": { "type": "object", "required": [ "Relation" ], "properties": { "Relation": { "$ref": "#/components/schemas/Relation" } } }, "RelationCreate": { "type": "object", "required": [ "Destination" ], "properties": { "Destination": { "$ref": "#/components/schemas/Href" } } }, "RelationCreateWrapper": { "type": "object", "required": [ "RelationCreate" ], "properties": { "RelationCreate": { "$ref": "#/components/schemas/RelationCreate" } } }, "RelationList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Class representing a list of relations between content.", "type": "object", "required": [ "Relation" ], "properties": { "Relation": { "type": "array", "items": { "$ref": "#/components/schemas/Relation" } } } } ] }, "RelationListWrapper": { "type": "object", "required": [ "Relations" ], "properties": { "Relations": { "$ref": "#/components/schemas/RelationList" } } }, "Fields": { "type": "object", "required": [ "field" ], "properties": { "field": { "type": "array", "items": { "$ref": "#/components/schemas/Field" } } } }, "Section": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a Section.", "type": "object", "required": [ "sectionId", "identifier", "name" ], "properties": { "sectionId": { "description": "ID of the Section.", "type": "integer" }, "identifier": { "description": "Unique identifier of the Section.", "type": "string" }, "name": { "description": "Name of the Section.", "type": "string" } } } ] }, "SectionWrapper": { "type": "object", "required": [ "Section" ], "properties": { "Section": { "$ref": "#/components/schemas/Section" } } }, "SectionInput": { "type": "object", "required": [ "identifier", "name" ], "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "SectionInputWrapper": { "type": "object", "required": [ "SectionInput" ], "properties": { "SectionInput": { "$ref": "#/components/schemas/SectionInput" } } }, "SectionList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a Section list.", "type": "object", "required": [ "Section" ], "properties": { "Section": { "type": "array", "items": { "$ref": "#/components/schemas/Section" } } } } ] }, "SectionListWrapper": { "type": "object", "required": [ "SectionList" ], "properties": { "SectionList": { "$ref": "#/components/schemas/SectionList" } } }, "Trash": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "required": [ "TrashItem" ], "properties": { "TrashItem": { "type": "array", "items": { "$ref": "#/components/schemas/TrashItem" } } } } ] }, "TrashWrapper": { "type": "object", "required": [ "Trash" ], "properties": { "Trash": { "$ref": "#/components/schemas/Trash" } } }, "TrashItem": { "description": "This class represents a trash item, which is actually a trashed Location.", "$ref": "#/components/schemas/Location" }, "TrashItemWrapper": { "type": "object", "required": [ "TrashItem" ], "properties": { "TrashItem": { "$ref": "#/components/schemas/TrashItem" } } }, "ContentTypeGroup": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a content type group value.", "type": "object", "required": [ "id", "identifier", "created", "modified", "Creator", "Modifier", "ContentTypes" ], "properties": { "id": { "description": "Primary key.", "type": "integer" }, "identifier": { "description": "Readable string identifier of a group.", "type": "string" }, "created": { "description": "Created date (integer).", "type": "string", "format": "date-time" }, "modified": { "description": "Modified date (integer).", "type": "string", "format": "date-time" }, "Creator": { "description": "Creator User ID.", "$ref": "#/components/schemas/BaseObject" }, "Modifier": { "description": "Modifier User ID.", "$ref": "#/components/schemas/BaseObject" }, "ContentTypes": { "description": "Content types.", "$ref": "#/components/schemas/BaseObject" } } } ] }, "ContentTypeGroupWrapper": { "type": "object", "required": [ "ContentTypeGroup" ], "properties": { "ContentTypeGroup": { "$ref": "#/components/schemas/ContentTypeGroup" } } }, "ContentTypeGroupInput": { "type": "object" }, "ContentTypeGroupInputWrapper": { "type": "object", "required": [ "ContentTypeGroupInput" ], "properties": { "ContentTypeGroupInput": { "$ref": "#/components/schemas/ContentTypeGroupInput" } } }, "ContentTypeGroupListWrapper": { "type": "object", "required": [ "ContentTypeGroupList" ], "properties": { "ContentTypeGroupList": { "$ref": "#/components/schemas/ContentTypeGroupList" } } }, "ContentTypeGroupRef": { "description": "Content type group reference.", "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/BaseObject", "type": "object", "properties": { "unlink": { "$ref": "#/components/schemas/Unlink" } } } ] } }, "ContentTypeGroupRefList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of content type groups references.", "type": "object", "required": [ "ContentTypeGroupRef" ], "properties": { "ContentTypeGroupRef": { "$ref": "#/components/schemas/ContentTypeGroupRef" } } } ] }, "ContentTypeGroupList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of content type groups.", "type": "object", "required": [ "ContentTypeGroup" ], "properties": { "ContentTypeGroup": { "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeGroup" } } } } ] }, "ContentTypeGroupRefListWrapper": { "type": "object", "required": [ "ContentTypeGroupRefList" ], "properties": { "ContentTypeGroupRefList": { "$ref": "#/components/schemas/ContentTypeGroupRefList" } } }, "ContentType": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a content type.", "type": "object", "required": [ "id", "status", "identifier", "names", "descriptions", "creationDate", "modificationDate", "Creator", "Modifier", "Groups", "Draft", "remoteId", "urlAliasSchema", "nameSchema", "isContainer", "defaultAlwaysAvailable", "defaultSortField", "defaultSortOrder", "FieldDefinitions" ], "properties": { "id": { "description": "Content type ID.", "type": "integer" }, "status": { "description": "The status of the content type. Possible values: const STATUS_DEFINED = 0; Status constant for defined (aka published) Type, const STATUS_DRAFT = 1; Status constant for draft (aka temporary) Type; const STATUS_MODIFIED = 2; Status constant for modified (aka deferred for publishing) Type.", "enum": [ "DEFINED", "DRAFT", "MODIFIED", "PUBLISHED" ], "type": "string" }, "identifier": { "description": "String identifier of a content type.", "type": "string" }, "names": { "description": "Name of a content type." }, "descriptions": { "description": "Description of a content type." }, "creationDate": { "description": "Creation date of the content type.", "type": "string", "format": "date-time" }, "modificationDate": { "description": "Modification date of the content type.", "type": "string", "format": "date-time" }, "Creator": { "description": "Creator User of the content type.", "$ref": "#/components/schemas/BaseObject" }, "Modifier": { "description": "Modifier User of the content type.", "$ref": "#/components/schemas/BaseObject" }, "Groups": { "description": "Group User of the content type.", "$ref": "#/components/schemas/BaseObject" }, "Draft": { "description": "Draft of the content type.", "$ref": "#/components/schemas/BaseObject" }, "remoteId": { "description": "Unique remote ID of the content type.", "type": "string" }, "urlAliasSchema": { "description": "URL alias schema. If nothing is provided, $nameSchema will be used instead.", "type": [ "string", "null" ] }, "nameSchema": { "description": "Name schema. Can be composed of FieldDefinition identifier place holders.", "type": "string" }, "isContainer": { "description": "A flag used to hint if content of this type may have children or not. It is highly recommended to respect this flag and not create/move content below non-containers. But this flag is not considered as part of the content model and the API will not in any way enforce this flag to be respected.", "type": "boolean" }, "defaultAlwaysAvailable": { "description": "If an instance of a content type is created the always available flag is set by default to this value.", "type": "boolean" }, "defaultSortField": { "description": "Specifies which property the child Locations should be sorted on by default when created. Map for Location sort fields to their respective SortClauses - class name/identifier and modified subnode. One of the fallowing values: const SORT_FIELD_PATH = 1; const SORT_FIELD_PUBLISHED = 2; const SORT_FIELD_MODIFIED = 3; const SORT_FIELD_SECTION = 4; const SORT_FIELD_DEPTH = 5; const SORT_FIELD_PRIORITY = 8; const SORT_FIELD_NAME = 9; const SORT_FIELD_NODE_ID = 11; const SORT_FIELD_CONTENTOBJECT_ID = 12.", "enum": [ "PATH", "PUBLISHED", "MODIFIED", "SECTION", "DEPTH", "PRIORITY", "NAME", "NODE_ID", "CONTENTOBJECT_ID" ], "type": "string" }, "defaultSortOrder": { "description": "Specifies whether the sort order should be ascending or descending by default when created. Map for Location sort order to their respective Query SORT constants. Possible values: const SORT_ORDER_DESC = 0; const SORT_ORDER_ASC = 1.", "enum": [ "ASC", "DESC" ], "type": "string" }, "FieldDefinitions": { "description": "This method returns the content type Field definitions from this type." } } } ] }, "ContentTypeWrapper": { "type": "object", "required": [ "ContentType" ], "properties": { "ContentType": { "$ref": "#/components/schemas/ContentType" } } }, "ContentTypeCreate": { "description": "This class is used to create a content type.", "type": "object", "required": [ "identifier", "mainLanguageCode", "remoteId", "urlAliasSchema", "nameSchema", "isContainer", "defaultSortField", "defaultSortOrder", "defaultAlwaysAvailable", "names", "descriptions" ], "properties": { "identifier": { "type": "string" }, "mainLanguageCode": { "type": "string" }, "remoteId": { "type": "string" }, "urlAliasSchema": { "type": "string" }, "nameSchema": { "type": "string" }, "isContainer": { "type": "boolean" }, "defaultSortField": { "description": "Specifies which property the child Locations should be sorted on by default when created." }, "defaultSortOrder": { "description": "Specifies whether the sort order should be ascending or descending by default when created." }, "defaultAlwaysAvailable": { "type": "boolean" }, "names": { "$ref": "#/components/schemas/ValueObject" }, "descriptions": { "$ref": "#/components/schemas/ValueObject" }, "FieldDefinition": { "$ref": "#/components/schemas/FieldDefinition" }, "creatorId": { "description": "If set, this value overrides the current user as creator." }, "creationDate": { "type": "string", "format": "date-time" } } }, "ContentTypeCreateWrapper": { "type": "object", "required": [ "ContentTypeCreate" ], "properties": { "ContentTypeCreate": { "$ref": "#/components/schemas/ContentTypeCreate" } } }, "ContentTypeUpdateStruct": { "description": "This class is used for updating a content type.", "type": "object", "properties": { "identifier": { "description": "If set the unique identifier of a type is changed to this value.", "type": "string" }, "remoteId": { "description": "If set the remote ID is changed to this value.", "type": "string" }, "urlAliasSchema": { "description": "If set the URL alias schema is changed to this value.", "type": "string" }, "nameSchema": { "description": "f set the name schema is changed to this value.", "type": "string" }, "isContainer": { "description": "If set the container flag is set to this value.", "type": "boolean" }, "mainLanguageCode": { "description": "If set the main language is changed to this value.", "type": "string" }, "defaultSortField": { "description": "If set the default sort field is changed to this value.", "enum": [ "PATH", "PUBLISHED", "MODIFIED", "SECTION", "DEPTH", "PRIORITY", "NAME", "NODE_ID", "CONTENTOBJECT_ID" ], "type": "string" }, "defaultSortOrder": { "description": "If set the default sort order is set to this value.", "enum": [ "ASC", "DESC" ], "type": "string" }, "defaultAlwaysAvailable": { "description": "If set the default always available flag is set to this value.", "type": "boolean" }, "modifierId": { "description": "If set this value overrides the current User as creator.", "type": "integer" }, "modificationDate": { "description": "If set this value overrides the current time for creation.", "type": "string", "format": "date-time" }, "names": { "description": "If set this array of names with languageCode keys replace the complete name collection." }, "descriptions": { "description": "If set this array of descriptions with languageCode keys replace the complete description collection." } } }, "ContentTypeUpdate": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class is used to update a content type.", "type": "object", "properties": { "identifier": { "type": "string" }, "mainLanguageCode": { "type": "string" }, "remoteId": { "type": "string" }, "urlAliasSchema": { "type": [ "string", "null" ] }, "nameSchema": { "type": "string" }, "isContainer": { "type": "boolean" }, "defaultSortField": { "description": "Specifies which property the child Locations should be sorted on by default when updated." }, "defaultSortOrder": { "description": "Specifies whether the sort order should be ascending or descending by default when updated." }, "defaultAlwaysAvailable": { "type": [ "string", "boolean" ] }, "names": { "$ref": "#/components/schemas/ValueObject" }, "descriptions": { "$ref": "#/components/schemas/ValueObject" }, "modifierId": { "description": "If set, this value overrides the current user as creator." }, "modificationDate": { "type": "string", "format": "date-time" } } } ] }, "ContentTypeUpdateWrapper": { "type": "object", "required": [ "ContentTypeUpdate" ], "properties": { "ContentTypeUpdate": { "$ref": "#/components/schemas/ContentTypeUpdate" } } }, "ContentTypeList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of content types.", "type": "object", "required": [ "ContentType" ], "properties": { "ContentType": { "type": "array", "items": { "$ref": "#/components/schemas/ContentType" } } } } ] }, "ContentTypeListWrapper": { "type": "object", "required": [ "ContentTypeList" ], "properties": { "ContentTypeList": { "$ref": "#/components/schemas/ContentTypeList" } } }, "ContentTypeInfo": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class stores content type information.", "type": "object", "required": [ "id", "status", "identifier", "names", "descriptions", "creationDate", "modificationDate", "Creator", "Modifier", "Groups", "Draft", "remoteId", "urlAliasSchema", "nameSchema", "isContainer", "mainLanguageCode", "defaultAlwaysAvailable", "defaultSortField", "defaultSortOrder" ], "properties": { "id": { "description": "Content type ID.", "type": "integer" }, "status": { "description": "The status of the content type. Possible values: const STATUS_DEFINED = 0; Status constant for defined (aka published) Type, const STATUS_DRAFT = 1; Status constant for draft (aka temporary) Type; const STATUS_MODIFIED = 2; Status constant for modified (aka deferred for publishing) Type.", "enum": [ "DEFINED", "DRAFT", "MODIFIED", "PUBLISHED" ], "type": "string" }, "identifier": { "description": "String identifier of a content type.", "type": "string" }, "names": { "description": "Name of a content type." }, "descriptions": { "description": "Description of a content type." }, "creationDate": { "description": "Creation date of the content type.", "type": "string", "format": "date-time" }, "modificationDate": { "description": "Modification date of the content type.", "type": "string", "format": "date-time" }, "Creator": { "description": "Creator User of the content type.", "$ref": "#/components/schemas/BaseObject" }, "Modifier": { "description": "Modifier User of the content type.", "$ref": "#/components/schemas/BaseObject" }, "Groups": { "description": "Group User of the content type.", "$ref": "#/components/schemas/BaseObject" }, "Draft": { "description": "Draft of the content type.", "$ref": "#/components/schemas/BaseObject" }, "remoteId": { "description": "Unique remote ID of the content type.", "type": "string" }, "urlAliasSchema": { "description": "URL alias schema. If nothing is provided, $nameSchema will be used instead.", "type": [ "string", "null" ] }, "nameSchema": { "description": "Name schema. Can be composed of FieldDefinition identifier place holders.", "type": "string" }, "isContainer": { "description": "A flag used to hint if content of this type may have children or not. It is highly recommended to respect this flag and not create/move content below non-containers. But this flag is not considered as part of the content model and the API will not in any way enforce this flag to be respected.", "type": "boolean" }, "mainLanguageCode": { "description": "Main language code.", "type": "string" }, "defaultAlwaysAvailable": { "description": "If an instance of a content type is created the always available flag is set by default to this value.", "type": "boolean" }, "defaultSortField": { "description": "Specifies which property the child Locations should be sorted on by default when created. Map for Location sort fields to their respective SortClauses - class name/identifier and modified subnode. One of the fallowing values: const SORT_FIELD_PATH = 1; const SORT_FIELD_PUBLISHED = 2; const SORT_FIELD_MODIFIED = 3; const SORT_FIELD_SECTION = 4; const SORT_FIELD_DEPTH = 5; const SORT_FIELD_PRIORITY = 8; const SORT_FIELD_NAME = 9; const SORT_FIELD_NODE_ID = 11; const SORT_FIELD_CONTENTOBJECT_ID = 12.", "enum": [ "PATH", "PUBLISHED", "MODIFIED", "SECTION", "DEPTH", "PRIORITY", "NAME", "NODE_ID", "CONTENTOBJECT_ID" ], "type": "string" }, "defaultSortOrder": { "description": "Specifies whether the sort order should be ascending or descending by default when created. Map for Location sort order to their respective Query SORT constants. Possible values: const SORT_ORDER_DESC = 0; const SORT_ORDER_ASC = 1.", "enum": [ "ASC", "DESC" ], "type": "string" } } } ] }, "ContentTypeInfoWrapper": { "type": "object", "required": [ "ContentTypeInfo" ], "properties": { "ContentTypeInfo": { "$ref": "#/components/schemas/ContentTypeInfo" } } }, "ContentTypeInfoList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of content type information.", "type": "object", "required": [ "ContentType" ], "properties": { "ContentType": { "description": "This class stores content type information.", "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeInfo" } } } } ] }, "ContentTypeInfoListWrapper": { "type": "object", "required": [ "ContentTypeList" ], "properties": { "ContentTypeList": { "$ref": "#/components/schemas/ContentTypeInfoList" } } }, "ContentTypeQuery": { "description": "This class represents a content type query.", "type": "object", "properties": { "limit": { "description": "The maximum number of results to return.", "type": "integer" }, "offset": { "description": "The offset to start returning results from.", "type": "integer" }, "Query": { "description": "An array of filters to apply to the query.", "type": "object", "properties": { "ContentTypeIdCriterion": { "oneOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "integer" } ] }, "ContentTypeIdentifierCriterion": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "IsSystemCriterion": { "type": "boolean" }, "ContentTypeGroupIdCriterion": { "oneOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "integer" } ] }, "ContainsFieldDefinitionIdCriterion": { "oneOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "integer" } ] } } }, "SortClauses": { "description": "An array of sort clauses to apply to the query.", "type": "object", "properties": { "Id": { "type": "string", "enum": [ "ascending", "descending" ] }, "Identifier": { "type": "string", "enum": [ "ascending", "descending" ] } } } } }, "ContentTypeViewInput": { "description": "This class represents a content type view input.", "xml": { "name": "ViewInput" }, "type": "object", "required": [ "identifier", "ContentTypeQuery" ], "properties": { "identifier": { "description": "The identifier of a view.", "type": "string" }, "ContentTypeQuery": { "$ref": "#/components/schemas/ContentTypeQuery" } } }, "ContentTypeViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { "$ref": "#/components/schemas/ContentTypeViewInput" } } }, "Field": { "description": "This class represents a field of a content item.", "type": "object", "required": [ "fieldDefinitionIdentifier", "fieldValue" ], "properties": { "id": { "description": "The field ID.", "type": "integer" }, "fieldDefinitionIdentifier": { "description": "The Field definition identifier.", "type": "string" }, "languageCode": { "description": "The language code.", "type": "string" }, "fieldTypeIdentifier": { "description": "Field Type identifier.", "type": "string" }, "fieldValue": { "description": "A Field Type value or a value type which can be converted by the corresponding field type." } } }, "FieldDefinition": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a Field definition.", "type": "object", "required": [ "id", "identifier", "fieldType", "fieldGroup", "position", "isTranslatable", "isRequired", "isInfoCollector", "defaultValue", "isSearchable", "names", "descriptions", "fieldSettings", "validatorConfiguration" ], "properties": { "id": { "description": "The unique ID of this Field definition.", "type": "integer" }, "identifier": { "description": "Readable string identifier of a Field definition.", "type": "string" }, "fieldType": { "description": "String identifier of the field type.", "type": "string" }, "fieldGroup": { "description": "Field group name.", "type": "string" }, "position": { "description": "The position of the Field definition in the content type.", "type": "integer" }, "isTranslatable": { "description": "If the field is translatable.", "type": "boolean" }, "isRequired": { "description": "Is the field required.", "type": "boolean" }, "isInfoCollector": { "description": "The flag if this field is used for information collection.", "type": "boolean" }, "defaultValue": { "description": "Default value of the field." }, "isSearchable": { "description": "Indicates if th the content is searchable by this attribute.", "type": "boolean" }, "names": { "description": "Names of content types." }, "descriptions": { "description": "Descriptions of content types." }, "fieldSettings": { "description": "Settings for the Field definition supported by the field type." }, "validatorConfiguration": { "description": "Validator configuration of this Field definition supported by the field type.", "oneOf": [ { "$ref": "#/components/schemas/StringLengthValidator" }, { "$ref": "#/components/schemas/StringLengthValidatorWrapper" }, { "type": "array" } ] } } } ] }, "FieldDefinitionWrapper": { "type": "object", "required": [ "FieldDefinition" ], "properties": { "FieldDefinition": { "$ref": "#/components/schemas/FieldDefinition" } } }, "FieldDefinitionCreate": { "$ref": "#/components/schemas/BaseObject" }, "FieldDefinitionCreateWrapper": { "type": "object", "required": [ "FieldDefinitionCreate" ], "properties": { "FieldDefinitionCreate": { "$ref": "#/components/schemas/FieldDefinitionCreate" } } }, "FieldDefinitionUpdate": { "$ref": "#/components/schemas/BaseObject" }, "FieldDefinitionUpdateWrapper": { "type": "object", "required": [ "FieldDefinitionUpdate" ], "properties": { "FieldDefinitionUpdate": { "$ref": "#/components/schemas/FieldDefinitionUpdate" } } }, "FieldDefinitions": { "type": "object", "required": [ "FieldDefinition" ], "properties": { "FieldDefinition": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDefinition" } } } }, "FieldDefinitionsWrapper": { "type": "object", "required": [ "FieldDefinitions" ], "properties": { "FieldDefinitions": { "$ref": "#/components/schemas/FieldDefinitions" } } }, "StringLengthValidator": { "description": "Validator for checking min. and max. length of strings.", "type": "object", "required": [ "maxStringLength", "minStringLength" ], "properties": { "maxStringLength": { "description": "Maximum length of strings.", "type": [ "integer", "null" ] }, "minStringLength": { "description": "Minimum length of strings.", "type": [ "integer", "null" ] } } }, "StringLengthValidatorWrapper": { "type": "object", "required": [ "StringLengthValidator" ], "properties": { "StringLengthValidator": { "$ref": "#/components/schemas/StringLengthValidator" } } }, "UrlAlias": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a URL alias in the Repository.", "type": "object", "required": [ "_id", "_type", "resource", "path", "languageCodes", "alwaysAvailable", "isHistory", "forward", "custom" ], "properties": { "_id": { "description": "A unique identifier for the alias.", "xml": { "attribute": true, "name": "id" }, "type": "string" }, "_type": { "description": "The type of the URL Alias i.e. one of URLAlias::LOCATION=0, URLAlias::RESOURCE=1, URLAlias::VIRTUAL=2.", "enum": [ "LOCATION", "RESOURCE", "VIRTUAL" ], "xml": { "attribute": true, "name": "type" }, "type": "string" }, "resource": { "description": "If type = URLAlias::LOCATION it is a Location ID otherwise a string (e.g. /content/search)." }, "path": { "description": "The full path of the alias.", "type": "string" }, "languageCodes": { "description": "The languageCodes for which this path is valid.", "type": "string" }, "alwaysAvailable": { "description": "Fallback indicator for other languages.", "type": "boolean" }, "isHistory": { "description": "Indicates that this alias was autogenerated for an in the meanwhile archived version of the content.", "type": "boolean" }, "forward": { "description": "Indicates if the URL should be redirected.", "type": "boolean" }, "custom": { "description": "If false this alias was autogenerated otherwise manually created.", "type": "boolean" } } } ] }, "UrlAliasWrapper": { "type": "object", "required": [ "UrlAlias" ], "properties": { "UrlAlias": { "$ref": "#/components/schemas/UrlAlias" } } }, "UrlAliasCreate": { "type": "object", "required": [ "_type" ], "properties": { "_type": { "type": "string" }, "location": { "$ref": "#/components/schemas/Href" }, "resource": { "type": "string" }, "languageCode": { "type": "string" }, "alwaysAvailable": { "type": [ "string", "boolean" ] }, "forward": { "type": [ "string", "boolean" ] } } }, "UrlAliasCreateWrapper": { "type": "object", "required": [ "UrlAliasCreate" ], "properties": { "UrlAliasCreate": { "$ref": "#/components/schemas/UrlAliasCreate" } } }, "UrlAliasRefList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of URL alias in the Repository.", "type": "object", "required": [ "UrlAlias" ], "properties": { "UrlAlias": { "type": "array", "items": { "$ref": "#/components/schemas/Ref" } } } } ] }, "UrlAliasRefListWrapper": { "type": "object", "required": [ "UrlAliasRefList" ], "properties": { "UrlAliasRefList": { "$ref": "#/components/schemas/UrlAliasRefList" } } }, "UrlWildcard": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a URL alias in the Repository.", "type": "object", "required": [ "_id", "sourceUrl", "destinationUrl", "forward" ], "properties": { "_id": { "description": "The unique ID.", "xml": { "attribute": true, "name": "id" }, "type": "integer" }, "sourceUrl": { "description": "The source URL.", "type": "string" }, "destinationUrl": { "description": "The destination URL containing placeholders e.g. /destination/{1}.", "type": "string" }, "forward": { "description": "Indicates if the URL is redirected or not.", "type": "boolean" } } } ] }, "UrlWildcardWrapper": { "type": "object", "required": [ "UrlWildcard" ], "properties": { "UrlWildcard": { "$ref": "#/components/schemas/UrlWildcard" } } }, "UrlWildcardCreate": { "description": "Creates a new URL wildcard.", "type": "object", "required": [ "sourceUrl", "destinationUrl", "forward" ], "properties": { "sourceUrl": { "type": "string" }, "destinationUrl": { "type": "string" }, "forward": { "type": [ "string", "boolean" ] } } }, "UrlWildcardCreateWrapper": { "type": "object", "required": [ "URLWildcardCreate" ], "properties": { "URLWildcardCreate": { "$ref": "#/components/schemas/UrlWildcardCreate" } } }, "UrlWildcardList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of URL alias in the Repository.", "type": "object", "required": [ "UrlWildcard" ], "properties": { "UrlWildcard": { "type": "array", "items": { "$ref": "#/components/schemas/UrlWildcard" } } } } ] }, "UrlWildcardListWrapper": { "type": "object", "required": [ "UrlWildcardList" ], "properties": { "UrlWildcardList": { "$ref": "#/components/schemas/UrlWildcardList" } } }, "Language": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a language in the Repository.", "type": "object", "required": [ "languageId", "languageCode", "name" ], "properties": { "languageId": { "description": "The language ID (auto generated).", "type": [ "string", "null" ] }, "languageCode": { "description": "The languageCode code.", "type": "string" }, "name": { "description": "Human readable name of the language.", "type": "string" } } } ] }, "LanguageWrapper": { "type": "object", "required": [ "Language" ], "properties": { "Language": { "$ref": "#/components/schemas/Language" } } }, "LanguageList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of languages.", "type": "object", "required": [ "Language" ], "properties": { "Language": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } } } } ] }, "LanguageListWrapper": { "type": "object", "required": [ "LanguageList" ], "properties": { "LanguageList": { "$ref": "#/components/schemas/LanguageList" } } }, "ObjectState": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a Object state value.", "type": "object", "required": [ "id", "identifier", "priority", "ObjectStateGroup", "languageCodes", "names", "descriptions" ], "properties": { "id": { "description": "Primary key.", "type": "integer" }, "identifier": { "description": "Readable string identifier of the Object state.", "type": "string" }, "priority": { "description": "Priority for ordering.", "type": "integer" }, "ObjectStateGroup": { "description": "The Object state group this Object state belongs to.", "$ref": "#/components/schemas/BaseObject" }, "languageCodes": { "description": "The available language codes for names an descriptions.", "type": "string" }, "names": { "description": "Names." }, "descriptions": { "description": "Descriptions." } } } ] }, "ObjectStateWrapper": { "type": "object", "required": [ "ObjectState" ], "properties": { "ObjectState": { "$ref": "#/components/schemas/ObjectState" } } }, "ObjectStateCreate": { "description": "This class represents a value for creating Object states.", "type": "object", "required": [ "identifier", "priority", "defaultLanguageCode", "languageCodes", "names", "descriptions" ], "properties": { "identifier": { "description": "Readable unique string identifier of a group.", "type": "string" }, "priority": { "description": "Priority for ordering. If not set the Object state is created as the last one.", "type": "string" }, "defaultLanguageCode": { "description": "The default language code.", "type": "string" }, "languageCodes": { "description": "Language codes.", "type": "string" }, "names": { "description": "An array of names with languageCode keys. At least one name in the main language is required.", "type": "object", "required": [ "value" ], "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Value" } } } }, "descriptions": { "description": "An array of descriptions with languageCode keys.", "type": "object", "required": [ "value" ], "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Value" } } } } } }, "ObjectStateCreateWrapper": { "type": "object", "required": [ "ObjectStateCreate" ], "properties": { "ObjectStateCreate": { "$ref": "#/components/schemas/ObjectStateCreate" } } }, "ObjectStateUpdate": { "description": "This class represents a value for updating Object states.", "type": "object", "properties": { "identifier": { "description": "Readable unique string identifier of a group.", "type": "string" }, "defaultLanguageCode": { "description": "The default language code.", "type": "string" }, "names": { "description": "An array of names with languageCode keys." }, "descriptions": { "description": "An array of descriptions with languageCode keys." } } }, "ObjectStateUpdateWrapper": { "type": "object", "required": [ "ObjectStateUpdate" ], "properties": { "ObjectStateUpdate": { "$ref": "#/components/schemas/ObjectStateUpdate" } } }, "ObjectStateList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of Object states.", "type": "object", "required": [ "ObjectState" ], "properties": { "ObjectState": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectState" } } } } ] }, "ObjectStateListWrapper": { "type": "object", "required": [ "ObjectStateList" ], "properties": { "ObjectStateList": { "$ref": "#/components/schemas/ObjectStateList" } } }, "ObjectStateGroup": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents an Object state group value.", "type": "object", "required": [ "id", "identifier", "defaultLanguageCode", "languageCodes", "ObjectStates", "names", "descriptions" ], "properties": { "id": { "description": "Primary key.", "type": "integer" }, "identifier": { "description": "Readable string identifier of a group.", "type": "string" }, "defaultLanguageCode": { "description": "The default language code.", "type": "string" }, "languageCodes": { "description": "The available language codes for names an descriptions.", "type": "string" }, "ObjectStates": { "description": "Object States.", "$ref": "#/components/schemas/BaseObject" }, "names": { "description": "List of names." }, "descriptions": { "description": "List of descriptions." } } } ] }, "ObjectStateGroupWrapper": { "type": "object", "required": [ "ObjectStateGroup" ], "properties": { "ObjectStateGroup": { "$ref": "#/components/schemas/ObjectStateGroup" } } }, "ObjectStateGroupCreate": { "description": "This class represents a value for creating Object state groups.", "type": "object", "required": [ "identifier", "defaultLanguageCode", "names", "descriptions" ], "properties": { "identifier": { "description": "Readable unique string identifier of a group.", "type": "string" }, "defaultLanguageCode": { "description": "The default language code.", "type": "string" }, "names": { "description": "An array of names with languageCode keys. At least one name in the main language is required." }, "descriptions": { "description": "An array of descriptions with languageCode keys." } } }, "ObjectStateGroupCreateWrapper": { "type": "object", "required": [ "ObjectStateGroupCreate" ], "properties": { "ObjectStateGroupCreate": { "$ref": "#/components/schemas/ObjectStateGroupCreate" } } }, "ObjectStateGroupUpdate": { "description": "This class represents a value for updating Object state groups.", "type": "object", "properties": { "identifier": { "description": "Readable unique string identifier of a group.", "type": "string" }, "defaultLanguageCode": { "description": "The default language code.", "type": "string" }, "names": { "description": "An array of names with languageCode keys." }, "descriptions": { "description": "An array of descriptions with languageCode keys." } } }, "ObjectStateGroupUpdateWrapper": { "type": "object", "required": [ "ObjectStateGroupUpdate" ], "properties": { "ObjectStateGroupUpdate": { "$ref": "#/components/schemas/ObjectStateGroupUpdate" } } }, "ObjectStateGroupList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of Object state groups.", "type": "object", "required": [ "ObjectStateGroup" ], "properties": { "ObjectStateGroup": { "description": "This class represents an Object state group value.", "type": "array", "items": { "$ref": "#/components/schemas/ObjectStateGroup" } } } } ] }, "ObjectStateGroupListWrapper": { "type": "object", "required": [ "ObjectStateGroupList" ], "properties": { "ObjectStateGroupList": { "$ref": "#/components/schemas/ObjectStateGroupList" } } }, "CountryList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class is representing an ISO-3166 formatted list of world countries.", "type": "object", "required": [ "Country" ], "properties": { "Country": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } ] }, "Country": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class is representing a country.", "type": "object", "required": [ "_id", "name", "Alpha2", "Alpha3", "IDC" ], "properties": { "_id": { "description": "ID that represents a country name.", "xml": { "attribute": true, "name": "id" }, "type": "string" }, "name": { "description": "Name of the country.", "type": "string" }, "Alpha2": { "description": "Two-letter code that represents a country name.", "type": "string" }, "Alpha3": { "description": "Three-letter code that represents a country name.", "type": "string" }, "IDC": { "description": "IDC", "type": "integer" } } } ] }, "CountryListWrapper": { "type": "object", "required": [ "CountryList" ], "properties": { "CountryList": { "$ref": "#/components/schemas/CountryList" } } }, "View": { "description": "View.", "type": "object", "required": [ "identifier", "User", "public", "LocationQuery", "Result" ], "properties": { "identifier": { "description": "Content identifier.", "type": "string" }, "User": { "$ref": "#/components/schemas/User" }, "public": { "type": "boolean" }, "LocationQuery": { "$ref": "#/components/schemas/LocationQuery" }, "Result": { "$ref": "#/components/schemas/BaseObject" } } }, "ViewInput": { "description": "This class represents a View input.", "type": "object", "required": [ "identifier", "Query" ], "properties": { "identifier": { "description": "Content identifier.", "type": "string" }, "languageCode": { "type": "string" }, "useAlwaysAvailable": { "type": "string" }, "Query": { "$ref": "#/components/schemas/Query" } } }, "ViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { "$ref": "#/components/schemas/ViewInput" } } }, "Query": { "description": "This class is used to perform a Content query.", "type": "object", "properties": { "Filter": { "description": "The Query filter. Can contain multiple criterion, as items of a logical one (by default AND).", "$ref": "#/components/schemas/Criterion" }, "Query": { "description": "The Query query. Can contain multiple criterion, as items of a logical one (by default AND).", "$ref": "#/components/schemas/Criterion" }, "sortClauses": { "description": "Query sorting clauses.", "type": "array", "items": { "$ref": "#/components/schemas/SortClause" } }, "facetBuilders": { "description": "An array of facet builders. Search engines may ignore any, or given facet builders they don't support and will just return search result facets supported by the engine. API consumer should dynamically iterate over returned facets for further use.", "type": "array", "items": { "$ref": "#/components/schemas/FacetBuilder" } }, "offset": { "description": "Query offset. Sets the offset for search hits, used for paging the results.", "type": "integer" }, "limit": { "description": "Query limit. Limit for number of search hits to return. If value is `0`, search query will not return any search hits, useful for doing a count.", "type": "integer" }, "spellcheck": { "description": "If true spellcheck suggestions are returned.", "type": "boolean" }, "performCount": { "description": "If true, search engine should perform count even if that means extra lookup.", "type": "boolean" } } }, "LocationQuery": { "description": "This class is used to perform a Location query.", "$ref": "#/components/schemas/Query" }, "Criterion": { "description": "Criterion implementations.", "type": "object", "properties": { "operator": { "description": "The operator used by the Criterion.", "type": "string" }, "value": { "description": "The value(s) matched by the Criteria.", "type": "array", "items": { "type": [] } }, "target": { "description": "The target used by the Criteria (field, metadata...).", "type": "string" }, "valueData": { "description": "Additional value data, required by some Criteria, MapLocationDistance for instance." }, "Specifications": { "description": "Criterion description function. Returns the combination of the Criterion's supported operator/value, as an array of objects.", "type": "array", "items": { "$ref": "#/components/schemas/Specifications" } } } }, "FacetBuilder": { "description": "This class is the base class for facet builders.", "type": "object", "required": [ "name", "global", "filter", "limit", "minCount" ], "properties": { "name": { "description": "The name of the facet.", "type": "string" }, "global": { "description": "If true the facet runs in a global mode not restricted by the query.", "type": "boolean" }, "filter": { "description": "An additional facet filter that will further filter the documents the facet will be executed on.", "$ref": "#/components/schemas/Criterion" }, "limit": { "description": "Number of facets (terms) returned.", "type": "integer" }, "minCount": { "description": "Specifies the minimum count. Only facet groups with more or equal results are returned.", "type": "integer" } } }, "Specifications": { "description": "This class is used by Criteria to describe which operators they support. Instances of this class are returned in an array by the {@see Criterion::getSpecifications()} method.", "type": "object", "required": [ "operator", "valueFormat", "valueTypes", "valueCount" ], "properties": { "operator": { "description": "Specified operator, as one of the Operator::* constants.", "type": "string" }, "valueFormat": { "description": "Format supported for the Criterion value, either {@see self::FORMAT_SINGLE} for single or {@see self::FORMAT_ARRAY} for multiple.", "type": "string" }, "valueTypes": { "description": "Accepted values types, specifying what type of variables are accepted as a value. Criterion input value type description constants: const TYPE_INTEGER = 1; const TYPE_STRING = 2; const TYPE_BOOLEAN = 4.", "type": "integer" }, "valueCount": { "description": "Limitation on the number of items as the value. Only usable if {@see $valueFormat} is {@see self::FORMAT_ARRAY}.", "type": "integer" } } }, "Role": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a role.", "type": "object", "required": [ "identifier", "Policies" ], "properties": { "identifier": { "description": "Readable string identifier of a role.", "type": "string" }, "Policies": { "description": "Returns the list of policies of this role.", "$ref": "#/components/schemas/BaseObject" } } } ] }, "RoleWrapper": { "type": "object", "required": [ "Role" ], "properties": { "Role": { "$ref": "#/components/schemas/Role" } } }, "RoleDraft": { "description": "This class represents a draft of a role, extends Role.", "$ref": "#/components/schemas/Role" }, "RoleDraftWrapper": { "type": "object", "required": [ "Role" ], "properties": { "Role": { "$ref": "#/components/schemas/RoleDraft" } } }, "RoleInput": { "description": "This class represents a Role input.", "type": "object", "required": [ "identifier" ], "properties": { "identifier": { "type": "string" } } }, "RoleInputWrapper": { "type": "object", "required": [ "RoleInput" ], "properties": { "RoleInput": { "$ref": "#/components/schemas/RoleInput" } } }, "RoleList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a list roles.", "type": "object", "required": [ "Role" ], "properties": { "Role": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } } ] }, "RoleListWrapper": { "type": "object", "required": [ "RoleList" ], "properties": { "RoleList": { "$ref": "#/components/schemas/RoleList" } } }, "Policy": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a policy value.", "type": "object", "required": [ "id", "module", "function" ], "properties": { "id": { "description": "ID of the policy.", "type": "integer" }, "module": { "description": "Name of module, associated with the Policy e.g. content.", "type": "string" }, "function": { "description": "Name of the module function Or all functions with '*' e.g. read.", "type": "string" }, "limitations": { "description": "Limitations.", "type": "object", "required": [ "limitation" ], "properties": { "limitation": { "type": "array", "items": { "$ref": "#/components/schemas/Limitation" } } } } } } ] }, "PolicyWrapper": { "type": "object", "required": [ "Policy" ], "properties": { "Policy": { "$ref": "#/components/schemas/Policy" } } }, "Limitation": { "description": "This class represents a Limitation applied to a policy.", "type": "object", "required": [ "_identifier", "values" ], "properties": { "_identifier": { "description": "Returns the limitation identifier (one of the defined constants) or a custom limitation. Constants: CONTENTTYPE = Class; LANGUAGE = Language; LOCATION = Node; OWNER = Owner; PARENTOWNER = ParentOwner; PARENTCONTENTTYPE = ParentClass; PARENTDEPTH = ParentDepth; SECTION = Section; NEWSECTION = NewSection; SITEACCESS = SiteAccess; STATE = State; NEWSTATE = NewState; SUBTREE = Subtree; USERGROUP = Group; PARENTUSERGROUP = ParentGroup; STATUS = Status.", "enum": [ "ContentType", "Language", "Location", "Owner", "Parentowner", "ParentContentType", "ParentDepth", "Section", "NewSection", "SiteAccess", "State", "NewState", "Subtree", "UserGroup", "ParentUserGroup", "Status", "Class" ], "xml": { "attribute": true, "name": "identifier" }, "type": "string" }, "values": { "description": "A read-only list of IDs or identifiers for which the limitation should be applied. The value of this property must conform to a hash, which means that it may only consist of array and scalar values, but must not contain objects or resources.", "type": "object", "required": [ "$ref" ], "properties": { "ref": { "type": "array", "items": { "$ref": "#/components/schemas/Ref" } } } } } }, "PolicyList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of policies.", "type": "object", "required": [ "Policy" ], "properties": { "Policy": { "type": "array", "items": { "$ref": "#/components/schemas/Policy" } } } } ] }, "PolicyListWrapper": { "type": "object", "required": [ "PolicyList" ], "properties": { "PolicyList": { "$ref": "#/components/schemas/PolicyList" } } }, "PolicyCreate": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class is used to create a Policy.", "type": "object", "required": [ "module", "function", "Limitations" ], "properties": { "module": { "description": "Name of module associated with the Policy. For example, content.", "type": "string" }, "function": { "description": "Name of the module function, or all functions with ''*''. For example, read.", "type": "string" }, "Limitations": { "type": "array", "items": { "$ref": "#/components/schemas/Limitation" } } } } ] }, "PolicyCreateWrapper": { "type": "object", "required": [ "PolicyCreate" ], "properties": { "PolicyCreate": { "$ref": "#/components/schemas/PolicyCreate" } } }, "PolicyUpdate": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class is used to update a Policy.", "type": "object", "required": [ "Limitations" ], "properties": { "Limitations": { "type": "array", "items": { "$ref": "#/components/schemas/Limitation" } } } } ] }, "PolicyUpdateWrapper": { "type": "object", "required": [ "PolicyUpdate" ], "properties": { "PolicyUpdate": { "$ref": "#/components/schemas/PolicyUpdate" } } }, "RoleAssignment": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This value object represents an assignment of a User or User group to a role including a limitation.", "type": "object", "required": [ "Role" ], "properties": { "limitation": { "description": "Returns the limitation of the role assignment." }, "Role": { "description": "Returns the role to which the User or User group is assigned to.", "$ref": "#/components/schemas/Ref" } } } ] }, "RoleAssignmentWrapper": { "type": "object", "required": [ "RoleAssignment" ], "properties": { "RoleAssignment": { "$ref": "#/components/schemas/RoleAssignment" } } }, "RoleAssignInput": { "description": "This class represents a Role assign input.", "type": "object", "required": [ "Role", "limitation" ], "properties": { "Role": { "description": "Returns the Role to which the user or user group is assigned to.", "$ref": "#/components/schemas/Ref" }, "limitation": { "description": "Returns the Limitation of the Role assignment.", "$ref": "#/components/schemas/Limitation" } } }, "RoleAssignInputWrapper": { "type": "object", "required": [ "RoleAssignInput" ], "properties": { "RoleAssignInput": { "$ref": "#/components/schemas/RoleAssignInput" } } }, "RoleAssignmentList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This value object represents a list of assignments of a User or User group to a role including a limitation.", "type": "object", "required": [ "RoleAssignment" ], "properties": { "RoleAssignment": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignment" } } } } ] }, "RoleAssignmentListWrapper": { "type": "object", "required": [ "RoleAssignmentList" ], "properties": { "RoleAssignmentList": { "$ref": "#/components/schemas/RoleAssignmentList" } } }, "Session": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Value for session.", "type": "object", "required": [ "name", "identifier", "csrfToken", "User" ], "properties": { "name": { "description": "Name.", "type": "string" }, "identifier": { "description": "Identifier.", "type": "string" }, "csrfToken": { "description": "csrfToken.", "type": "string" }, "User": { "description": "User.", "$ref": "#/components/schemas/BaseObject" } } } ] }, "SessionWrapper": { "type": "object", "required": [ "Session" ], "properties": { "Session": { "$ref": "#/components/schemas/Session" } } }, "SessionInput": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a session input.", "type": "object", "required": [ "login", "password" ], "properties": { "login": { "type": "string" }, "password": { "type": "string" } } } ] }, "SessionInputWrapper": { "type": "object", "required": [ "SessionInput" ], "properties": { "SessionInput": { "$ref": "#/components/schemas/SessionInput" } } }, "JWT": { "description": "This class represents the JWT authentication token", "type": "object", "required": [ "token" ], "properties": { "token": { "description": "JWT authentication token", "type": "string" } } }, "JWTWrapper": { "type": "object", "required": [ "JWT" ], "properties": { "JWT": { "$ref": "#/components/schemas/JWT" } } }, "JWTInput": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents the input for a JWT authentication token", "type": "object", "required": [ "username", "password" ], "properties": { "username": { "description": "User name", "type": "string" }, "password": { "description": "User password", "type": "string" } } } ] }, "JWTInputWrapper": { "type": "object", "required": [ "JWTInput" ], "properties": { "JWTInput": { "$ref": "#/components/schemas/JWTInput" } } }, "UserGroup": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Content ID matcher class.", "type": "object", "required": [ "_remoteId", "_id", "ContentType", "name", "Versions", "Section", "MainLocation", "Locations", "Owner", "lastModificationDate", "mainLanguageCode", "alwaysAvailable", "Version", "ParentUserGroup", "Subgroups", "Users", "Roles" ], "properties": { "_remoteId": { "description": "Remote ID of the content type.", "xml": { "attribute": true, "name": "remoteId" }, "type": "string" }, "_id": { "description": "Unique ID of the content type.", "xml": { "attribute": true, "name": "id" }, "type": "integer" }, "ContentType": { "description": "Content type.", "$ref": "#/components/schemas/Ref" }, "name": { "type": "string" }, "Versions": { "description": "Returns the VersionInfo for this version.", "$ref": "#/components/schemas/Ref" }, "Section": { "description": "The Section to which the content item is assigned to.", "$ref": "#/components/schemas/Ref" }, "MainLocation": { "$ref": "#/components/schemas/Ref" }, "Locations": { "description": "Location of the content item.", "$ref": "#/components/schemas/Ref" }, "Owner": { "description": "The owner of the content item.", "$ref": "#/components/schemas/Ref" }, "lastModificationDate": { "description": "Content item modification date.", "type": "string", "format": "date-time" }, "mainLanguageCode": { "description": "The main language code of the content item.", "type": "string" }, "alwaysAvailable": { "type": "boolean" }, "Version": { "$ref": "#/components/schemas/Version" }, "ParentUserGroup": { "$ref": "#/components/schemas/Ref" }, "Subgroups": { "$ref": "#/components/schemas/Ref" }, "Users": { "$ref": "#/components/schemas/Ref" }, "Roles": { "$ref": "#/components/schemas/Ref" } } } ] }, "UserGroupWrapper": { "type": "object", "required": [ "UserGroup" ], "properties": { "UserGroup": { "$ref": "#/components/schemas/UserGroup" } } }, "UserGroupList": { "description": "This class represents a User Group list.", "$ref": "#/components/schemas/BaseObject" }, "UserGroupListWrapper": { "type": "object", "required": [ "UserGroupList" ], "properties": { "UserGroupList": { "$ref": "#/components/schemas/UserGroupList" } } }, "UserGroupRefList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Returns a list of the sub groups.", "type": "object", "required": [ "UserGroup" ], "properties": { "UserGroup": { "description": "This class represents a User group.", "type": "array", "items": { "$ref": "#/components/schemas/Ref" } } } } ] }, "UserGroupRefListWrapper": { "type": "object", "required": [ "UserGroupRefList" ], "properties": { "UserGroupRefList": { "$ref": "#/components/schemas/UserGroupRefList" } } }, "UserGroupCreate": { "description": "This class is used to create a User Group.", "type": "object", "required": [ "mainLanguageCode", "remoteId", "fields" ], "properties": { "mainLanguageCode": { "type": "string" }, "remoteId": { "type": "string" }, "fields": { "$ref": "#/components/schemas/Fields" } } }, "UserGroupCreateWrapper": { "type": "object", "required": [ "UserGroupCreate" ], "properties": { "UserGroupCreate": { "$ref": "#/components/schemas/UserGroupCreate" } } }, "UserGroupUpdate": { "description": "This class is used to update a User group in the Repository.", "type": "object", "required": [ "Section" ], "properties": { "Section": { "type": "object", "required": [ "_href" ], "properties": { "_href": { "xml": { "attribute": true, "name": "href" }, "type": "string" } } } } }, "UserGroupUpdateWrapper": { "type": "object", "required": [ "UserGroupUpdate" ], "properties": { "UserGroupUpdate": { "$ref": "#/components/schemas/UserGroupUpdate" } } }, "UserGroupUnassign": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a User group.", "type": "object", "required": [ "Unassign" ], "properties": { "Unassign": { "$ref": "#/components/schemas/Unlink" } } } ] }, "Unlink": { "description": "Unlink a content type group from a content type.", "type": "object", "required": [ "_href", "_method" ], "properties": { "_href": { "type": "string" }, "_method": { "enum": [ "DELETE" ], "type": "string" } } }, "User": { "type": "object", "description": "Reference to a registered user account", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for the user reference" }, "_href": { "type": "string", "description": "REST API URL reference to the user resource", "format": "uri" } }, "required": [ "_media-type", "_href" ], "additionalProperties": false }, "UserWrapper": { "type": "object", "required": [ "User" ], "properties": { "User": { "$ref": "#/components/schemas/User" } } }, "UserList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a list of users.", "type": "object", "required": [ "User" ], "properties": { "User": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } ] }, "UserListWrapper": { "type": "object", "required": [ "UserList" ], "properties": { "UserList": { "$ref": "#/components/schemas/UserList" } } }, "UserRefList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Returns a list of the users.", "type": "object", "required": [ "User" ], "properties": { "User": { "description": "This class represents a User.", "type": "array", "items": { "$ref": "#/components/schemas/BaseObject" } } } } ] }, "UserRefListWrapper": { "type": "object", "required": [ "UserRefList" ], "properties": { "UserRefList": { "$ref": "#/components/schemas/UserRefList" } } }, "UserUpdate": { "description": "This class is used to update a User.", "type": "object", "required": [ "login" ], "properties": { "login": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "enabled": { "type": "boolean" }, "maxLogin": { "type": "integer" }, "ContentUpdate": { "description": "The update structure for the profile content." }, "ContentMetadataUpdate": { "description": "The update structure for the profile metadata." } } }, "UserUpdateWrapper": { "type": "object", "required": [ "UserUpdate" ], "properties": { "UserUpdate": { "$ref": "#/components/schemas/UserUpdate" } } }, "UserCreate": { "description": "This class is used to create a User.", "type": "object", "required": [ "mainLanguageCode", "remoteId", "login", "email", "password" ], "properties": { "mainLanguageCode": { "type": "string" }, "remoteId": { "type": "string" }, "login": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "enabled": { "type": "boolean" } } }, "UserCreateWrapper": { "type": "object", "required": [ "UserCreate" ], "properties": { "UserCreate": { "$ref": "#/components/schemas/UserCreate" } } }, "Event": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Calendar event.", "type": "object", "required": [ "id", "datetime", "type", "name", "attributes" ], "properties": { "id": { "description": "The unique ID.", "type": "string" }, "datetime": { "type": "string", "format": "date-time" }, "type": { "description": "Event type identifier or name.", "type": "string" }, "name": { "description": "Name of the calendar event.", "type": "string" }, "attributes": { "description": "List of event attributes.", "type": "array", "items": { "$ref": "#/components/schemas/EventAttribute" } } } } ] }, "EventAttribute": { "type": "object", "required": [ "label", "value" ], "properties": { "label": { "description": "Label of the attribute.", "type": "string" }, "value": { "description": "Value of the attribute.", "type": "string" } } }, "EventList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "List of calendar events.", "type": "object", "required": [ "_currentPage", "totalCount", "events" ], "properties": { "_currentPage": { "description": "Current page representation.", "xml": { "attribute": true, "name": "currentPage" }, "type": "string" }, "nextPage": { "description": "Next page representation.", "type": "string" }, "totalCount": { "description": "Total count of events.", "type": "integer" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } } } ] }, "EventListWrapper": { "type": "object", "required": [ "EventList" ], "properties": { "EventList": { "$ref": "#/components/schemas/EventList" } } }, "EventGroup": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Event group.", "type": "object", "required": [ "_currentPage", "totalCount", "events" ], "properties": { "_currentPage": { "description": "Current page representation.", "xml": { "attribute": true, "name": "currentPage" }, "type": "string" }, "nextPage": { "description": "Next page representation.", "type": "string" }, "groupKey": { "$ref": "#/components/schemas/DateRange" }, "totalCount": { "description": "Total count of events.", "type": "integer" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } } } ] }, "EventGroupList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "Grouped calendar event list.", "type": "object", "required": [ "groups" ], "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/EventGroup" } } } } ] }, "EventGroupListWrapper": { "type": "object", "required": [ "EventGroupList" ], "properties": { "EventGroupList": { "$ref": "#/components/schemas/EventGroupList" } } }, "UnscheduleAction": { "description": "This class represents events to unschedule", "type": "object", "required": [ "events" ], "properties": { "events": { "description": "list of events", "type": "array", "items": { "type": "string" } } } }, "UnscheduleActionWrapper": { "type": "object", "required": [ "UnscheduleAction" ], "properties": { "UnscheduleAction": { "$ref": "#/components/schemas/UnscheduleAction" } } }, "AttributeGroup": { "description": "This class represents an attribute group.", "type": "object", "required": [ "name", "identifier", "position" ], "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "position": { "type": "integer" } } }, "AttributeGroupWrapper": { "type": "object", "required": [ "AttributeGroup" ], "properties": { "AttributeGroup": { "$ref": "#/components/schemas/AttributeGroup" } } }, "AttributeGroupCreate": { "description": "This class is used to create an attribute group.", "type": "object", "required": [ "identifier", "names", "position" ], "properties": { "identifier": { "type": "string" }, "names": { "type": "object" }, "position": { "type": "integer" } } }, "AttributeGroupCreateWrapper": { "type": "object", "required": [ "AttributeGroupCreate" ], "properties": { "AttributeGroupCreate": { "$ref": "#/components/schemas/AttributeGroupCreate" } } }, "AttributeGroupUpdate": { "description": "This class is used to update an attribute group.", "type": "object", "required": [ "identifier", "names", "position" ], "properties": { "identifier": { "type": "string" }, "names": { "type": "object" }, "position": { "type": "integer" } } }, "AttributeGroupUpdateWrapper": { "type": "object", "required": [ "AttributeGroupUpdate" ], "properties": { "AttributeGroupUpdate": { "$ref": "#/components/schemas/AttributeGroupUpdate" } } }, "AttributeGroupList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents an attribute group list.", "type": "object", "required": [ "AttributeGroup" ], "properties": { "AttributeGroup": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeGroup" } } } } ] }, "AttributeGroupListWrapper": { "type": "object", "required": [ "AttributeGroupList" ], "properties": { "AttributeGroupList": { "$ref": "#/components/schemas/AttributeGroupList" } } }, "AttributeGroupListGet": { "description": "This class represents an attribute group list request.", "type": "object", "required": [ "prefix", "offset", "limit" ], "properties": { "prefix": { "type": "string" }, "offset": { "type": "integer" }, "limit": { "type": "integer" } } }, "AttributeGroupListGetWrapper": { "type": "object", "required": [ "AttributeGroupListGet" ], "properties": { "AttributeGroupListGet": { "$ref": "#/components/schemas/AttributeGroupListGet" } } }, "AttributeGroupGet": { "description": "This class represents an attribute group query.", "type": "object", "required": [ "languages" ], "properties": { "languages": { "type": "array", "items": { "type": "string" } } } }, "AttributeGroupGetWrapper": { "type": "object", "required": [ "AttributeGroupGet" ], "properties": { "AttributeGroupGet": { "$ref": "#/components/schemas/AttributeGroupGet" } } }, "AttributeGroupListResult": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "required": [ "count", "AttributeGroupList" ], "properties": { "count": { "type": "integer" }, "AttributeGroupList": { "$ref": "#/components/schemas/AttributeGroupList" } } } ] }, "AttributeGroupView": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents an attribute group view.", "type": "object", "required": [ "identifier", "Result" ], "properties": { "identifier": { "type": "string" }, "Result": { "$ref": "#/components/schemas/AttributeGroupListResult" } } } ] }, "AttributeGroupViewWrapper": { "type": "object", "required": [ "AttributeGroupView" ], "properties": { "AttributeGroupView": { "$ref": "#/components/schemas/AttributeGroupView" } } }, "AttributeGroupViewInput": { "description": "This class represents an attribute group view input.", "xml": { "name": "ViewInput" }, "type": "object", "required": [ "identifier", "AttributeGroupQuery" ], "properties": { "identifier": { "type": "string" }, "AttributeGroupQuery": { "type": "object", "required": [ "limit", "offset", "name_prefix" ], "properties": { "limit": { "type": "string" }, "offset": { "type": "string" }, "name_prefix": { "type": "string" } } } } }, "AttributeGroupViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { "$ref": "#/components/schemas/AttributeGroupViewInput" } } }, "AttributeType": { "description": "This class represents an attribute type.", "type": "object", "required": [ "identifier", "name" ], "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "AttributeTypeWrapper": { "type": "object", "required": [ "AttributeType" ], "properties": { "AttributeType": { "$ref": "#/components/schemas/AttributeType" } } }, "AttributeTypeList": { "description": "This class represents an attribute type list.", "type": "object", "required": [ "attributeTypes" ], "properties": { "attributeTypes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeType" } } } }, "AttributeTypeListWrapper": { "type": "object", "required": [ "AttributeTypeList" ], "properties": { "AttributeTypeList": { "$ref": "#/components/schemas/AttributeTypeList" } } }, "CartList": { "type": "object" }, "Attribute": { "description": "This class represents an attribute.", "type": "object", "required": [ "name", "identifier", "description", "type", "type_identifier", "value", "group", "position", "options" ], "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "type_identifier": { "type": "string" }, "value": { "type": [] }, "group": { "type": "string" }, "position": { "type": "integer" }, "options": { "type": [ "object", "array" ] } } }, "AttributeWrapper": { "type": "object", "required": [ "Attribute" ], "properties": { "Attribute": { "$ref": "#/components/schemas/Attribute" } } }, "AttributeCreate": { "description": "This class is used to create an attribute.", "type": "object", "required": [ "identifier", "type", "group", "names", "descriptions", "position", "options" ], "properties": { "identifier": { "type": "string" }, "type": { "type": "string" }, "group": { "type": "string" }, "names": { "type": "object" }, "descriptions": { "type": "object" }, "position": { "type": "integer" }, "options": { "type": [ "object", "array" ] } } }, "AttributeCreateWrapper": { "type": "object", "required": [ "AttributeCreate" ], "properties": { "AttributeCreate": { "$ref": "#/components/schemas/AttributeCreate" } } }, "AttributeUpdate": { "description": "This class is used to update an attribute.", "type": "object", "required": [ "identifier", "names", "descriptions", "position", "options" ], "properties": { "identifier": { "type": "string" }, "names": { "type": "object" }, "descriptions": { "type": "object" }, "position": { "type": "integer" }, "options": { "type": "object" } } }, "AttributeUpdateWrapper": { "type": "object", "required": [ "AttributeUpdate" ], "properties": { "AttributeUpdate": { "$ref": "#/components/schemas/AttributeUpdate" } } }, "AttributeList": { "description": "This class represents an attribute list.", "type": "object", "required": [ "Attribute" ], "properties": { "Attribute": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" } } } }, "AttributeListWrapper": { "type": "object", "required": [ "AttributeList" ], "properties": { "AttributeList": { "$ref": "#/components/schemas/AttributeList" } } }, "AttributeView": { "description": "This class represents an attribute view.", "type": "object", "required": [ "identifier", "AttributeQuery", "Result" ], "properties": { "identifier": { "type": "string" }, "AttributeQuery": { "type": "object" }, "Result": { "type": "object" } } }, "AttributeViewWrapper": { "type": "object", "required": [ "AttributeView" ], "properties": { "AttributeView": { "$ref": "#/components/schemas/AttributeView" } } }, "AttributeViewInput": { "description": "This class represents an attribute view input.", "xml": { "name": "ViewInput" }, "type": "object", "required": [ "identifier", "AttributeQuery" ], "properties": { "identifier": { "type": "string" }, "AttributeQuery": { "type": "object" } } }, "AttributeViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { "$ref": "#/components/schemas/AttributeViewInput" } } }, "AttributeAssignment": { "type": "object", "required": [ "is_required", "is_discriminator", "Attribute" ], "properties": { "is_required": { "type": "boolean" }, "is_discriminator": { "type": "boolean" }, "Attribute": { "$ref": "#/components/schemas/Attribute" } } }, "Catalog": { "description": "This class represents a catalog.", "type": "object", "required": [ "identifier", "name", "description", "created", "modified", "status", "User", "Criteria" ], "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "created": { "type": "integer" }, "modified": { "type": "integer" }, "status": { "type": "string" }, "User": { "$ref": "#/components/schemas/Ref" }, "Criteria": { "type": "array", "items": { "$ref": "#/components/schemas/Criterion" } } } }, "CatalogWrapper": { "type": "object", "required": [ "Catalog" ], "properties": { "Catalog": { "$ref": "#/components/schemas/Catalog" } } }, "CatalogCreate": { "description": "This class is used to create a catalog.", "type": "object", "required": [ "identifier", "criteria", "names", "status" ], "properties": { "identifier": { "type": "string" }, "criteria": { "$ref": "#/components/schemas/Criterion" }, "names": { "type": "object" }, "descriptions": { "type": "object" }, "status": { "type": "string" }, "creator_id": { "type": "integer" } } }, "CatalogCreateWrapper": { "type": "object", "required": [ "CatalogCreate" ], "properties": { "CatalogCreate": { "$ref": "#/components/schemas/CatalogCreate" } } }, "CatalogUpdate": { "description": "This class is used to update a catalog.", "type": "object", "required": [ "identifier", "transition", "criteria", "names", "descriptions" ], "properties": { "identifier": { "type": "string" }, "transition": { "type": "string" }, "criteria": { "$ref": "#/components/schemas/Criterion" }, "names": { "type": "object" }, "descriptions": { "type": "object" } } }, "CatalogUpdateWrapper": { "type": "object", "required": [ "CatalogUpdate" ], "properties": { "CatalogUpdate": { "$ref": "#/components/schemas/CatalogUpdate" } } }, "CatalogCopy": { "description": "This class is used to copy a catalog.", "type": "object", "required": [ "identifier", "creator_id" ], "properties": { "identifier": { "type": "string" }, "creator_id": { "description": "Optional", "type": "integer" } } }, "CatalogCopyWrapper": { "type": "object", "required": [ "CatalogCopy" ], "properties": { "CatalogCopy": { "$ref": "#/components/schemas/CatalogCopy" } } }, "CatalogList": { "description": "This class represents a catalog list.", "type": "object", "required": [ "Catalog" ], "properties": { "Catalog": { "type": "array", "items": { "$ref": "#/components/schemas/Catalog" } } } }, "CatalogListViewResult": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "required": [ "CatalogList" ], "properties": { "CatalogList": { "$ref": "#/components/schemas/CatalogList" } } } ] }, "CatalogView": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "required": [ "identifier", "CatalogQuery", "Result" ], "properties": { "identifier": { "type": "string" }, "CatalogQuery": { "$ref": "#/components/schemas/Ref" }, "Result": { "$ref": "#/components/schemas/CatalogListViewResult" } } } ] }, "CatalogViewWrapper": { "type": "object", "required": [ "CatalogView" ], "properties": { "CatalogView": { "$ref": "#/components/schemas/CatalogView" } } }, "CatalogViewInput": { "description": "This class represents a catalog view input.", "xml": { "name": "ViewInput" }, "type": "object", "required": [ "CatalogQuery" ], "properties": { "CatalogQuery": { "type": "object" } } }, "CatalogViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { "$ref": "#/components/schemas/CatalogViewInput" } } }, "Currency": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents currency.", "type": "object", "required": [ "id", "code", "subunits", "enabled" ], "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "subunits": { "type": "integer" }, "enabled": { "type": "boolean" } } } ] }, "CurrencyWrapper": { "type": "object", "required": [ "Currency" ], "properties": { "Currency": { "$ref": "#/components/schemas/Currency" } } }, "CurrencyCreate": { "description": "This class is used to create currency.", "type": "object", "required": [ "code", "subunits", "enabled" ], "properties": { "code": { "type": "string" }, "subunits": { "type": "integer" }, "enabled": { "type": "boolean" } } }, "CurrencyCreateWrapper": { "type": "object", "required": [ "CurrencyCreate" ], "properties": { "CurrencyCreate": { "$ref": "#/components/schemas/CurrencyCreate" } } }, "CurrencyUpdate": { "description": "This class is used to update currency.", "type": "object", "required": [ "subunits", "enabled" ], "properties": { "subunits": { "type": "integer" }, "enabled": { "type": "boolean" } } }, "CurrencyUpdateWrapper": { "type": "object", "required": [ "CurrencyUpdate" ], "properties": { "CurrencyUpdate": { "$ref": "#/components/schemas/CurrencyUpdate" } } }, "CurrencyView": { "description": "This class represents a currency view.", "type": "object", "required": [ "identifier", "CurrencyQuery", "Result" ], "properties": { "identifier": { "type": "string" }, "CurrencyQuery": { "type": "object" }, "Result": { "type": "object" } } }, "CurrencyViewWrapper": { "type": "object", "required": [ "CurrencyView" ], "properties": { "CurrencyView": { "$ref": "#/components/schemas/CurrencyView" } } }, "CurrencyViewInput": { "description": "This class represents a currency view input.", "xml": { "name": "ViewInput" }, "type": "object", "required": [ "CurrencyQuery" ], "properties": { "CurrencyQuery": { "type": "object" } } }, "CurrencyViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { "$ref": "#/components/schemas/CurrencyViewInput" } } }, "CurrencyList": { "description": "This class represents a currency list.", "type": "object", "required": [ "Currency" ], "properties": { "Currency": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } } } }, "CurrencyListWrapper": { "type": "object", "required": [ "CurrencyList" ], "properties": { "CurrencyList": { "$ref": "#/components/schemas/CurrencyList" } } }, "CustomerGroup": { "description": "This class represents a customer group.", "type": "object", "required": [ "id", "name", "identifier", "description", "users", "global_price_rate" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "users": { "description": "A list of users attached to the customer group.", "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "global_price_rate": { "description": "A numeric string", "type": "string" } } }, "CustomerGroupWrapper": { "type": "object", "required": [ "CustomerGroup" ], "properties": { "CustomerGroup": { "$ref": "#/components/schemas/CustomerGroup" } } }, "CustomerGroupCreate": { "description": "This class is used to create a customer group.", "type": "object", "required": [ "identifier", "names", "descriptions", "global_price_rate" ], "properties": { "identifier": { "type": "string" }, "names": { "type": "object" }, "descriptions": { "type": "object" }, "global_price_rate": { "description": "numeric-string", "type": "string" } } }, "CustomerGroupCreateWrapper": { "type": "object", "required": [ "CustomerGroupCreate" ], "properties": { "CustomerGroupCreate": { "$ref": "#/components/schemas/CustomerGroupCreate" } } }, "CustomerGroupUpdate": { "description": "This class is used to update a customer group.", "type": "object", "required": [ "names", "identifier", "global_price_rate" ], "properties": { "names": { "type": "object" }, "identifier": { "type": "string" }, "global_price_rate": { "type": "string" }, "descriptions": { "type": "array", "items": { "type": "string" } } } }, "CustomerGroupUpdateWrapper": { "type": "object", "required": [ "CustomerGroupUpdate" ], "properties": { "CustomerGroupUpdate": { "$ref": "#/components/schemas/CustomerGroupUpdate" } } }, "CustomerGroupList": { "description": "This class represents a customer group list.", "type": "object", "required": [ "CustomerGroup" ], "properties": { "CustomerGroup": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerGroup" } } } }, "CustomerGroupListWrapper": { "type": "object", "required": [ "CustomerGroupList" ], "properties": { "CustomerGroupList": { "$ref": "#/components/schemas/CustomerGroupList" } } }, "CustomerGroupListResult": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "required": [ "CustomerGroupList" ], "properties": { "CustomerGroupList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "required": [ "CustomerGroup" ], "properties": { "CustomerGroup": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerGroup" } } } } ] } } } ] }, "CustomerGroupViewInput": { "description": "This class represents a customer group view input.", "xml": { "name": "ViewInput" }, "type": "object", "required": [ "CustomerGroupQuery" ], "properties": { "CustomerGroupQuery": { "type": "object" } } }, "CustomerGroupViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { "$ref": "#/components/schemas/CustomerGroupViewInput" } } }, "CustomerGroupView": { "description": "This class represents a customer group view.", "type": "object", "required": [ "identifier", "CustomerGroupQuery", "Result" ], "properties": { "identifier": { "type": "string" }, "CustomerGroupQuery": { "type": "object" }, "Result": { "$ref": "#/components/schemas/CustomerGroupListResult" } } }, "CustomerGroupViewWrapper": { "type": "object", "required": [ "CustomerGroupView" ], "properties": { "CustomerGroupView": { "$ref": "#/components/schemas/CustomerGroupView" } } }, "Region": { "description": "This class represents a region.", "type": "object", "required": [ "identifier" ], "properties": { "identifier": { "type": "string" } } }, "RegionWrapper": { "type": "object", "required": [ "Region" ], "properties": { "Region": { "$ref": "#/components/schemas/Region" } } }, "RegionList": { "description": "This class represents a region list.", "type": "object", "required": [ "Region" ], "properties": { "Region": { "type": "array", "items": { "$ref": "#/components/schemas/Ref" } } } }, "RegionListWrapper": { "type": "object", "required": [ "RegionList" ], "properties": { "RegionList": { "$ref": "#/components/schemas/RegionList" } } }, "RegionView": { "description": "This class represents a region view.", "type": "object", "required": [ "identifier", "RegionQuery", "Result" ], "properties": { "identifier": { "type": "string" }, "RegionQuery": { "type": "object" }, "Result": { "type": "object" } } }, "RegionViewWrapper": { "type": "object", "required": [ "RegionView" ], "properties": { "RegionView": { "$ref": "#/components/schemas/RegionView" } } }, "RegionViewInput": { "description": "This class represents a region view input.", "xml": { "name": "ViewInput" }, "type": "object", "required": [ "RegionQuery" ], "properties": { "RegionQuery": { "type": "object" } } }, "RegionViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { "$ref": "#/components/schemas/RegionViewInput" } } }, "ProductType": { "description": "This class represents a product type.", "type": "object", "required": [ "identifier", "name", "AttributeAssignmentList" ], "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "AttributeAssignmentList": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeAssignment" } } } }, "ProductTypeWrapper": { "type": "object", "required": [ "ProductType" ], "properties": { "ProductType": { "$ref": "#/components/schemas/ProductType" } } }, "ProductTypeCreate": { "description": "This class is used to create a product type.", "type": "object", "required": [ "ContentTypeCreateStruct", "main_language_code", "assigned_attributes" ], "properties": { "ContentTypeCreateStruct": { "type": "object" }, "main_language_code": { "type": "string" }, "assigned_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ProductTypeAssignedAttribute" } } } }, "ProductTypeCreateWrapper": { "type": "object", "required": [ "ProductTypeCreate" ], "properties": { "ProductTypeCreate": { "$ref": "#/components/schemas/ProductTypeCreate" } } }, "ProductTypeUpdate": { "description": "This class is used to update a product type.", "type": "object", "required": [ "ContentTypeUpdateStruct", "assigned_attributes" ], "properties": { "ContentTypeUpdateStruct": { "$ref": "#/components/schemas/ContentTypeUpdateStruct" }, "assigned_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ProductTypeAssignedAttribute" } } } }, "ProductTypeUpdateWrapper": { "type": "object", "required": [ "ProductTypeUpdate" ], "properties": { "ProductTypeUpdate": { "$ref": "#/components/schemas/ProductTypeUpdate" } } }, "ProductTypeUsage": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a product type usage.", "type": "object", "required": [ "is_used" ], "properties": { "is_used": { "type": "boolean" } } } ] }, "ProductTypeUsageWrapper": { "type": "object", "required": [ "ProductTypeUsage" ], "properties": { "ProductTypeUsage": { "$ref": "#/components/schemas/ProductTypeUsage" } } }, "ProductTypeView": { "description": "This class represents a product type view.", "type": "object", "required": [ "identifier", "ProductTypeQuery", "Result" ], "properties": { "identifier": { "type": "string" }, "ProductTypeQuery": { "type": "object" }, "Result": { "type": "object" } } }, "ProductTypeViewWrapper": { "type": "object", "required": [ "ProductTypeView" ], "properties": { "ProductTypeView": { "$ref": "#/components/schemas/ProductTypeView" } } }, "ProductTypeList": { "description": "This class represents a product type list.", "type": "object", "required": [ "ProductType" ], "properties": { "ProductType": { "type": "array", "items": { "$ref": "#/components/schemas/ProductType" } } } }, "ProductTypeListWrapper": { "type": "object", "required": [ "ProductTypeList" ], "properties": { "ProductTypeList": { "$ref": "#/components/schemas/ProductTypeList" } } }, "ProductTypeListGet": { "description": "This class represents a product type list query.", "type": "object", "required": [ "name_prefix", "offset", "limit" ], "properties": { "name_prefix": { "type": "string" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "languages": { "type": "array", "items": { "type": "string" } } } }, "ProductTypeListGetWrapper": { "type": "object", "required": [ "ProductTypeListGet" ], "properties": { "ProductTypeListGet": { "$ref": "#/components/schemas/ProductTypeListGet" } } }, "ProductTypeViewInput": { "description": "This class represents a product type view input.", "xml": { "name": "ViewInput" }, "type": "object", "required": [ "ProductTypeQuery" ], "properties": { "ProductTypeQuery": { "type": "object" } } }, "ProductTypeViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { "$ref": "#/components/schemas/ProductTypeViewInput" } } }, "ProductTypeAssignedAttribute": { "type": "object", "required": [ "identifier", "is_required", "is_discriminator" ], "properties": { "identifier": { "type": "string" }, "is_required": { "type": "boolean" }, "is_discriminator": { "type": "boolean" } } }, "ProductVariant": { "description": "This class represents a product variant.", "type": "object", "required": [ "code", "name", "Product", "DiscriminatorAttributesList" ], "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "Product": { "$ref": "#/components/schemas/Product" }, "DiscriminatorAttributesList": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" } } } }, "ProductVariantWrapper": { "type": "object", "required": [ "ProductVariant" ], "properties": { "ProductVariant": { "$ref": "#/components/schemas/ProductVariant" } } }, "ProductVariantView": { "description": "This class represents a product variant view.", "type": "object", "required": [ "identifier", "ProductVariantQuery", "Result" ], "properties": { "identifier": { "type": "string" }, "ProductVariantQuery": { "type": "object" }, "Result": { "type": "object" } } }, "ProductVariantViewWrapper": { "type": "object", "required": [ "ProductVariantView" ], "properties": { "ProductVariantView": { "$ref": "#/components/schemas/ProductVariantView" } } }, "ProductVariantViewInput": { "description": "This class represents a product variant view input.", "type": "object", "required": [ "ProductVariantQuery" ], "properties": { "ProductVariantQuery": { "type": "object" } } }, "ProductVariantViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { "$ref": "#/components/schemas/ProductVariantViewInput" } } }, "ProductVariantCreate": { "description": "This class is used to create a product variant.", "type": "object", "required": [ "code", "attributes" ], "properties": { "code": { "type": "string" }, "attributes": { "description": "array<int|string,mixed>", "type": "object" } } }, "ProductVariantCreateWrapper": { "type": "object", "required": [ "ProductVariantCreate" ], "properties": { "ProductVariantCreate": { "$ref": "#/components/schemas/ProductVariantCreate" } } }, "ProductVariantUpdate": { "description": "This class is used to update a product variant.", "type": "object", "required": [ "code", "attributes" ], "properties": { "code": { "type": "string" }, "attributes": { "description": "array<int|string,mixed>", "type": "object" } } }, "ProductVariantUpdateWrapper": { "type": "object", "required": [ "ProductVariantUpdate" ], "properties": { "ProductVariantUpdate": { "$ref": "#/components/schemas/ProductVariantUpdate" } } }, "ProductVariantGenerate": { "description": "This class is used to generate a product variant.", "type": "object", "required": [ "attributes" ], "properties": { "attributes": { "description": "array<int|string,mixed>", "type": "object" } } }, "ProductVariantGenerateWrapper": { "type": "object", "required": [ "ProductVariantGenerate" ], "properties": { "ProductVariantGenerate": { "$ref": "#/components/schemas/ProductVariantGenerate" } } }, "ProductSortClause": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "ProductSortClauseList": { "description": "This class represents a product sort clause list.", "type": "object", "required": [ "ProductSortClause" ], "properties": { "ProductSortClause": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSortClause" } } } }, "ProductSortClauseListWrapper": { "type": "object", "required": [ "ProductSortClauseList" ], "properties": { "ProductSortClauseList": { "$ref": "#/components/schemas/ProductSortClauseList" } } }, "Product": { "description": "This class represents a product.", "type": "object", "required": [ "code", "name", "ProductType", "AttributesList" ], "properties": { "isVariant": { "type": "boolean" }, "isBaseProduct": { "type": "boolean" }, "code": { "type": "string" }, "name": { "type": "string" }, "ProductType": { "$ref": "#/components/schemas/ProductType" }, "Content": { "$ref": "#/components/schemas/Content" }, "Thumbnail": { "$ref": "#/components/schemas/Thumbnail" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "AttributesList": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" } } } }, "ProductWrapper": { "type": "object", "required": [ "Product" ], "properties": { "Product": { "$ref": "#/components/schemas/Product" } } }, "ProductCreate": { "description": "This class is used to create a product.", "type": "object", "required": [ "ContentCreate", "code", "attributes" ], "properties": { "ContentCreate": { "$ref": "#/components/schemas/ContentCreate" }, "code": { "type": "string" }, "attributes": { "type": "object" } } }, "ProductCreateWrapper": { "type": "object", "required": [ "ProductCreate" ], "properties": { "ProductCreate": { "$ref": "#/components/schemas/ProductCreate" } } }, "ProductUpdate": { "description": "This class is used to update a product.", "type": "object", "required": [ "ContentUpdate", "code" ], "properties": { "ContentUpdate": { "$ref": "#/components/schemas/ContentUpdate" }, "code": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object" } } } }, "ProductUpdateWrapper": { "type": "object", "required": [ "ProductUpdate" ], "properties": { "ProductUpdate": { "$ref": "#/components/schemas/ProductUpdate" } } }, "ProductContentUpdate": { "type": "object", "required": [ "__url", "fields" ], "properties": { "__url": { "xml": { "attribute": true, "name": "url" }, "type": "string" }, "fields": { "type": "object", "required": [ "field" ], "properties": { "field": { "type": "array", "items": { "$ref": "#/components/schemas/Field" } } } } } }, "ProductView": { "description": "This class represents a product view.", "type": "object", "required": [ "identifier", "ProductQuery", "Result" ], "properties": { "identifier": { "type": "string" }, "ProductQuery": { "type": "object" }, "Result": { "type": "object" } } }, "ProductViewWrapper": { "type": "object", "required": [ "ProductView" ], "properties": { "ProductView": { "$ref": "#/components/schemas/ProductView" } } }, "ProductViewInput": { "description": "This class represents a product view input.", "xml": { "name": "ViewInput" }, "type": "object", "required": [ "ProductQuery" ], "properties": { "ProductQuery": { "type": "object" } } }, "ProductViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { "$ref": "#/components/schemas/ProductViewInput" } } }, "ProductList": { "description": "This class represents a product list.", "type": "object", "required": [ "Product" ], "properties": { "Product": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } }, "ProductListWrapper": { "type": "object", "required": [ "ProductList" ], "properties": { "ProductList": { "$ref": "#/components/schemas/ProductList" } } }, "ProductListGet": { "description": "This class represents a product list GET.", "type": "object", "required": [ "offset", "limit", "languages" ], "properties": { "offset": { "type": "integer" }, "limit": { "type": "integer" }, "languages": { "type": "array", "items": { "type": "string" } } } }, "ProductListGetWrapper": { "type": "object", "required": [ "ProductListGet" ], "properties": { "ProductListGet": { "$ref": "#/components/schemas/ProductListGet" } } }, "ProductGet": { "description": "This class represents a product GET.", "type": "object", "required": [ "languages" ], "properties": { "languages": { "type": "array", "items": { "type": "string" } } } }, "ProductGetWrapper": { "type": "object", "required": [ "ProductGet" ], "properties": { "ProductGet": { "$ref": "#/components/schemas/ProductGet" } } }, "ProductFilter": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "ProductFilterList": { "description": "This class represents a product filter list.", "type": "object", "required": [ "ProductFilter" ], "properties": { "ProductFilter": { "type": "array", "items": { "$ref": "#/components/schemas/ProductFilter" } } } }, "ProductFilterListWrapper": { "type": "object", "required": [ "ProductFilterList" ], "properties": { "ProductFilterList": { "$ref": "#/components/schemas/ProductFilterList" } } }, "Price": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a price.", "type": "object", "required": [ "amount", "Currency" ], "properties": { "amount": { "type": "string" }, "base_amount": { "type": "string" }, "Currency": { "$ref": "#/components/schemas/Currency" }, "money": { "type": "string" }, "base_money": { "type": "string" } } } ] }, "PriceWrapper": { "type": "object", "required": [ "Price" ], "properties": { "Price": { "$ref": "#/components/schemas/Price" } } }, "PriceCreateStruct": { "description": "This class represents a price creation structure.", "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" } } }, "PriceCreateStructWrapper": { "type": "object", "required": [ "PriceCreateStruct" ], "properties": { "PriceCreateStruct": { "$ref": "#/components/schemas/PriceCreateStruct" } } }, "RestPrice": { "type": "object", "required": [ "Price", "formatted" ], "properties": { "Price": { "$ref": "#/components/schemas/Price" }, "formatted": { "type": "string" } } }, "RestPriceWrapper": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "required": [ "RestPrice" ], "properties": { "RestPrice": { "$ref": "#/components/schemas/RestPrice" } } } ] }, "CustomPrice": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a custom price.", "type": "object", "required": [ "amount", "base_amount", "Currency", "money", "base_money", "custom_money", "custom_amount" ], "properties": { "amount": { "type": "string" }, "base_amount": { "type": "string" }, "Currency": { "$ref": "#/components/schemas/Currency" }, "money": { "type": "string" }, "base_money": { "type": "string" }, "custom_money": { "type": "string" }, "custom_amount": { "type": "string" }, "custom_rule": { "type": [ "string", "null" ] } } } ] }, "CustomPriceWrapper": { "type": "object", "required": [ "CustomPrice" ], "properties": { "CustomPrice": { "$ref": "#/components/schemas/CustomPrice" } } }, "CustomPriceCreateStruct": { "description": "This class represents a custom price creation structure.", "type": "object", "required": [ "amount", "currency", "customAmount", "customerGroup" ], "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" }, "customAmount": { "type": "integer" }, "customerGroup": { "type": "string" } } }, "CustomPriceCreateStructWrapper": { "type": "object", "required": [ "CustomPriceCreateStruct" ], "properties": { "CustomPriceCreateStruct": { "$ref": "#/components/schemas/CustomPriceCreateStruct" } } }, "CustomPriceUpdateStruct": { "description": "This class represents a custom price updating structure.", "type": "object", "required": [ "amount", "currency", "customAmount" ], "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" }, "customAmount": { "type": "integer" } } }, "CustomPriceUpdateStructWrapper": { "type": "object", "required": [ "CustomPriceUpdateStruct" ], "properties": { "CustomPriceUpdateStruct": { "$ref": "#/components/schemas/CustomPriceUpdateStruct" } } }, "PriceUpdateStruct": { "description": "This class represents a price updating structure.", "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" } } }, "PriceUpdateStructWrapper": { "type": "object", "required": [ "PriceUpdateStruct" ], "properties": { "PriceUpdateStruct": { "$ref": "#/components/schemas/PriceUpdateStruct" } } }, "PriceList": { "description": "This class represents a price list.", "type": "object", "required": [ "prices" ], "properties": { "prices": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } } } }, "PriceListWrapper": { "type": "object", "required": [ "PriceList" ], "properties": { "PriceList": { "$ref": "#/components/schemas/PriceList" } } }, "Thumbnail": { "description": "This class represents a thumbnail that can be a target URL or a Base64 data.", "type": "object", "required": [ "resource", "width", "height", "mimeType" ], "properties": { "resource": { "type": "string" }, "width": { "type": [ "integer", "null" ] }, "height": { "type": [ "integer", "null" ] }, "mimeType": { "type": "string" } } }, "VatCategory": { "description": "This class represents a VAT category.", "type": "object", "required": [ "identifier", "region", "vatValue" ], "properties": { "identifier": { "type": "string" }, "region": { "type": "string" }, "vatValue": { "type": [ "number", "null" ] } } }, "VatCategoryWrapper": { "type": "object", "required": [ "VatCategory" ], "properties": { "VatCategory": { "$ref": "#/components/schemas/VatCategory" } } }, "VatCategoryList": { "description": "This class represents a VAT category list.", "type": "object", "required": [ "VatCategory" ], "properties": { "VatCategory": { "type": "array", "items": { "$ref": "#/components/schemas/VatCategory" } } } }, "VatCategoryListWrapper": { "type": "object", "required": [ "VatCategoryList" ], "properties": { "VatCategoryList": { "$ref": "#/components/schemas/VatCategoryList" } } }, "VatCategorySummary": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a VAT category summary.", "type": "object", "required": [ "VatCategory", "RestPrice" ], "properties": { "VatCategory": { "$ref": "#/components/schemas/VatCategory" }, "RestPrice": { "$ref": "#/components/schemas/RestPrice" } } } ] }, "TaxonomyEntry": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a taxonomy entry.", "type": "object", "required": [ "id", "identifier", "name", "content", "taxonomy" ], "properties": { "id": { "type": "integer" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "content": { "$ref": "#/components/schemas/Ref" }, "taxonomy": { "type": "string" } } } ] }, "TaxonomyEntryWrapper": { "type": "object", "required": [ "TaxonomyEntry" ], "properties": { "TaxonomyEntry": { "$ref": "#/components/schemas/TaxonomyEntry" } } }, "TaxonomyEntryBulkRemove": { "description": "This class is used to bulk remove taxonomy entries.", "type": "object", "required": [ "entries" ], "properties": { "entries": { "type": "array", "items": { "type": "integer" } } } }, "TaxonomyEntryBulkRemoveWrapper": { "type": "object", "required": [ "TaxonomyEntryBulkRemove" ], "properties": { "TaxonomyEntryBulkRemove": { "$ref": "#/components/schemas/TaxonomyEntryBulkRemove" } } }, "TaxonomyEntryMove": { "type": "object", "required": [ "entry", "sibling", "position" ], "properties": { "entry": { "type": "integer" }, "sibling": { "type": "integer" }, "position": { "type": "string" } } }, "TaxonomyEntryBulkMove": { "description": "This class is used to bulk move taxonomy entries.", "type": "object", "required": [ "entries" ], "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyEntryMove" } } } }, "TaxonomyEntryBulkMoveWrapper": { "type": "object", "required": [ "TaxonomyEntryBulkMove" ], "properties": { "TaxonomyEntryBulkMove": { "$ref": "#/components/schemas/TaxonomyEntryBulkMove" } } }, "TaxonomyEntryAssignment": { "description": "This class represents a taxonomy entry assignment.", "type": "object", "required": [ "id", "content", "entry" ], "properties": { "id": { "type": "integer" }, "content": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "required": [ "Content" ], "properties": { "Content": { "$ref": "#/components/schemas/Content" } } } ] }, "entry": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "required": [ "TaxonomyEntry" ], "properties": { "TaxonomyEntry": { "$ref": "#/components/schemas/TaxonomyEntry" } } } ] } } }, "TaxonomyEntryAssignmentWrapper": { "type": "object", "required": [ "TaxonomyEntryAssignment" ], "properties": { "TaxonomyEntryAssignment": { "$ref": "#/components/schemas/TaxonomyEntryAssignment" } } }, "TaxonomyEntryAssignToContent": { "description": "This class is used to assign taxonomy entry to content.", "type": "object", "required": [ "content", "entries" ], "properties": { "content": { "type": "integer" }, "entries": { "type": "array", "items": { "type": "integer" } } } }, "TaxonomyEntryAssignToContentWrapper": { "type": "object", "required": [ "TaxonomyEntryAssignToContent" ], "properties": { "TaxonomyEntryAssignToContent": { "$ref": "#/components/schemas/TaxonomyEntryAssignToContent" } } }, "TaxonomyEntryUnassignFromContent": { "description": "This class is used to unassign taxonomy entry from content.", "type": "object", "required": [ "content", "entries" ], "properties": { "content": { "type": "integer" }, "entries": { "type": "array", "items": { "type": "integer" } } } }, "TaxonomyEntryUnassignFromContentWrapper": { "type": "object", "required": [ "TaxonomyEntryUnassignFromContent" ], "properties": { "TaxonomyEntryUnassignFromContent": { "$ref": "#/components/schemas/TaxonomyEntryUnassignFromContent" } } }, "EntryAssignmentCollection": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a taxonomy assignment collection.", "type": "object", "required": [ "content", "assignments" ], "properties": { "content": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "required": [ "Content" ], "properties": { "Content": { "$ref": "#/components/schemas/Content" } } } ] }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyEntryAssignment" } } } } ] }, "EntryAssignmentCollectionWrapper": { "type": "object", "required": [ "EntryAssignmentCollection" ], "properties": { "EntryAssignmentCollection": { "$ref": "#/components/schemas/EntryAssignmentCollection" } } }, "Segment": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a segment.", "type": "object", "required": [ "id", "identifier", "name", "SegmentGroup" ], "properties": { "id": { "type": "integer" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "SegmentGroup": { "$ref": "#/components/schemas/SegmentGroup" } } } ] }, "SegmentWrapper": { "type": "object", "required": [ "Segment" ], "properties": { "Segment": { "$ref": "#/components/schemas/Segment" } } }, "SegmentList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class lists segments.", "type": "object", "required": [ "Segment" ], "properties": { "Segment": { "type": "array", "items": { "$ref": "#/components/schemas/Segment" } } } } ] }, "SegmentListWrapper": { "type": "object", "required": [ "SegmentList" ], "properties": { "SegmentList": { "$ref": "#/components/schemas/SegmentList" } } }, "SegmentGroup": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a segment group.", "type": "object", "required": [ "id", "identifier", "name" ], "properties": { "id": { "type": "integer" }, "identifier": { "type": "string" }, "name": { "type": "string" } } } ] }, "SegmentGroupWrapper": { "type": "object", "required": [ "SegmentGroup" ], "properties": { "SegmentGroup": { "$ref": "#/components/schemas/SegmentGroup" } } }, "SegmentGroupList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class lists segment groups.", "type": "object", "required": [ "SegmentGroup" ], "properties": { "SegmentGroup": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentGroup" } } } } ] }, "SegmentGroupListWrapper": { "type": "object", "required": [ "SegmentGroupList" ], "properties": { "SegmentGroupList": { "$ref": "#/components/schemas/SegmentGroupList" } } }, "UserSegment": { "description": "This class represents a segment and a user it's associate to.", "type": "object", "properties": { "id": { "type": "integer" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "SegmentGroup": { "$ref": "#/components/schemas/Ref" }, "User": { "$ref": "#/components/schemas/Ref" } } }, "UserSegmentList": { "description": "this class lists segments associated to users.", "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "type": "object", "properties": { "UserSegment": { "type": "array", "items": { "$ref": "#/components/schemas/UserSegment" } } } } ] }, "UserSegmentListWrapper": { "type": "object", "required": [ "UserSegmentList" ], "properties": { "UserSegmentList": { "$ref": "#/components/schemas/SegmentList" } } }, "UserSegmentAssignInput": { "type": "object", "properties": { "segments": { "type": "array", "items": { "type": "string" } } } }, "UserSegmentAssignInputWrapper": { "type": "object", "required": [ "UserSegmentAssignInput" ], "properties": { "UserSegmentAssignInput": { "$ref": "#/components/schemas/UserSegmentAssignInput" } } }, "CorporateAccountRoot": { "description": "This class represents Corporate Account Root resource information.", "type": "object", "required": [ "links" ], "properties": { "links": { "xml": { "wrapped": false }, "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "CorporateAccountRootWrapper": { "type": "object", "required": [ "CorporateAccountRoot" ], "properties": { "CorporateAccountRoot": { "$ref": "#/components/schemas/CorporateAccountRoot" } } }, "Link": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents REST resource information.", "type": "object", "required": [ "_rel" ], "properties": { "_rel": { "description": "Unique identifier of a resource.", "xml": { "attribute": true, "name": "rel" }, "type": "string" } } } ] }, "Company": { "description": "This class represents a company.", "type": "object", "required": [ "id", "name", "Content", "billingAddress", "contactId", "salesRepresentativeId", "defaultAddressId", "addressBookId", "membersId", "MemberList", "Location", "locationPath", "isActive" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "Content": { "$ref": "#/components/schemas/Content" }, "billingAddress": { "$ref": "#/components/schemas/BillingAddress" }, "contactId": { "type": [ "integer", "null" ] }, "salesRepresentativeId": { "type": "integer" }, "defaultAddressId": { "type": [ "integer", "null" ] }, "addressBookId": { "description": "Address book Folder Content ID.", "type": "integer" }, "membersId": { "description": "Members Folder Content ID.", "type": "integer" }, "MemberList": { "description": "Reference to Members List resource.", "$ref": "#/components/schemas/BaseObject" }, "Location": { "description": "Reference to Location resource.", "$ref": "#/components/schemas/BaseObject" }, "locationPath": { "description": "Company content item Location path string.", "type": "string" }, "isActive": { "type": "boolean" } } }, "CompanyWrapper": { "type": "object", "required": [ "Company" ], "properties": { "Company": { "$ref": "#/components/schemas/Company" } } }, "CompanyCreate": { "description": "This class is used to create a company.", "type": "object", "required": [ "fields" ], "properties": { "fields": { "type": "object", "required": [ "field" ], "properties": { "field": { "description": "Fields of a Company content item.", "type": "array", "items": { "$ref": "#/components/schemas/Field" } } } } } }, "CompanyCreateWrapper": { "type": "object", "required": [ "CompanyCreate" ], "properties": { "CompanyCreate": { "$ref": "#/components/schemas/CompanyCreate" } } }, "CompanyUpdate": { "description": "This class is used to update a Company.", "type": "object", "required": [ "fields" ], "properties": { "fields": { "type": "object", "required": [ "field" ], "properties": { "field": { "description": "Fields of a Company content item.", "type": "array", "items": { "$ref": "#/components/schemas/Field" } } } } } }, "CompanyUpdateWrapper": { "type": "object", "required": [ "CompanyUpdate" ], "properties": { "CompanyUpdate": { "$ref": "#/components/schemas/CompanyUpdate" } } }, "CompanyList": { "description": "This class represents a list of companies.", "type": "object", "required": [ "companies" ], "properties": { "companies": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } } }, "CompanyListWrapper": { "type": "object", "required": [ "CompanyList" ], "properties": { "CompanyList": { "$ref": "#/components/schemas/CompanyList" } } }, "Member": { "description": "This class represents a company member.", "type": "object", "required": [ "id", "name", "Company", "User", "Role" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "Company": { "$ref": "#/components/schemas/Company" }, "User": { "description": "Underlying User object of a member.", "$ref": "#/components/schemas/User" }, "Role": { "description": "Reference to the member role in a Company resource.", "$ref": "#/components/schemas/BaseObject" } } }, "MemberWrapper": { "type": "object", "required": [ "Member" ], "properties": { "Member": { "$ref": "#/components/schemas/Member" } } }, "MemberCreate": { "description": "This class is used to create a member.", "type": "object", "required": [ "login", "email", "password", "Role", "fields" ], "properties": { "login": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "Role": { "description": "Reference to a Role resource company member should be given.", "$ref": "#/components/schemas/BaseObject" }, "fields": { "type": "object", "required": [ "field" ], "properties": { "field": { "description": "Fields of a Member content item.", "type": "array", "items": { "$ref": "#/components/schemas/Field" } } } } } }, "MemberCreateWrapper": { "type": "object", "required": [ "MemberCreate" ], "properties": { "MemberCreate": { "$ref": "#/components/schemas/MemberCreate" } } }, "MemberUpdate": { "description": "This class is used to update a member.", "type": "object", "required": [ "email", "password", "enabled", "maxLogin", "Role", "fields" ], "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "enabled": { "type": "boolean" }, "maxLogin": { "description": "Max number of failed login attempts.", "type": "integer" }, "Role": { "description": "Reference to a Role resource company member should be given.", "$ref": "#/components/schemas/BaseObject" }, "fields": { "type": "object", "required": [ "field" ], "properties": { "field": { "description": "Fields of a Member content item.", "type": "array", "items": { "$ref": "#/components/schemas/Field" } } } } } }, "MemberUpdateWrapper": { "type": "object", "required": [ "MemberUpdate" ], "properties": { "MemberUpdate": { "$ref": "#/components/schemas/MemberUpdate" } } }, "MemberList": { "description": "This class represents a list of company members.", "type": "object", "required": [ "members" ], "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } } } }, "MemberListWrapper": { "type": "object", "required": [ "MemberList" ], "properties": { "MemberList": { "$ref": "#/components/schemas/MemberList" } } }, "SalesRepresentativesList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a list of sales representatives.", "type": "object", "required": [ "users" ], "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } ] }, "SalesRepresentativesListWrapper": { "type": "object", "required": [ "SalesRepresentativesList" ], "properties": { "SalesRepresentativesList": { "$ref": "#/components/schemas/SalesRepresentativesList" } } }, "BillingAddress": { "type": "object", "required": [ "name", "country", "fields" ], "properties": { "name": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "fields": { "type": [ "object", "array" ] } } }, "ActivityLog": { "description": "This class represents an activity log entry.", "type": "object" }, "ActivityLogGroup": { "type": "object", "required": [ "user_id", "logged_at", "ActivityLogEntries" ], "properties": { "user_id": { "description": "The ID of the user performing the logged actions", "type": "integer" }, "logged_at": { "description": "Timestamp representing when the group has been logged", "type": "integer" }, "ActivityLogEntries": { "description": "Log entries from the group", "type": "array", "items": { "$ref": "#/components/schemas/ActivityLog" } } } }, "ActivityLogGroupListInput": { "description": "This class represents the activity log group search query's criteria and sort clauses.", "type": "object" }, "ActivityLogGroupListInputWrapper": { "type": "object", "required": [ "ActivityLogGroupListInput" ], "properties": { "ActivityLogGroupListInput": { "$ref": "#/components/schemas/ActivityLogGroupListInput" } } }, "ActivityLogGroupList": { "description": "This class represents activity log context groups", "type": "object", "required": [ "ActivityLogGroups" ], "properties": { "ActivityLogGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityLogGroup" } } } }, "ActivityLogGroupListWrapper": { "type": "object", "required": [ "ActivityLogGroupList" ], "properties": { "ActivityLogGroupList": { "$ref": "#/components/schemas/ActivityLogGroupList" } } }, "Cart": { "description": "This class represents a Cart", "type": "object", "required": [ "id", "identifier", "owner", "Currency", "entries" ], "properties": { "id": { "description": "Cart ID", "type": "integer" }, "identifier": { "description": "Cart unique identifier", "type": "string" }, "owner": { "description": "User reference", "$ref": "#/components/schemas/Ref" }, "Currency": { "$ref": "#/components/schemas/Currency" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/CartEntry" } } } }, "CartWrapper": { "type": "object", "required": [ "Cart" ], "properties": { "Cart": { "$ref": "#/components/schemas/Cart" } } }, "CartCreate": { "description": "This class represents a new Cart to create", "type": "object", "required": [ "name", "currencyCode" ], "properties": { "name": { "description": "the name of the new Cart", "type": "string" }, "currencyCode": { "description": "the currency code such as `EUR`", "type": "string" }, "context": { "description": "associative array of scalars describing additional, contextual data attached to the cart", "type": "object" } } }, "CartCreateWrapper": { "type": "object", "required": [ "CartCreate" ], "properties": { "CartCreate": { "$ref": "#/components/schemas/CartCreate" } } }, "CartProduct": { "description": "This class represents a cart entry product", "type": "object", "required": [ "code" ], "properties": { "code": { "description": "product's code", "type": "string" } } }, "CartView": { "description": "This class represents a cart view.", "type": "object", "required": [ "identifier", "Result" ], "properties": { "identifier": { "type": "string" }, "Result": { "$ref": "#/components/schemas/CartListViewResult" } } }, "CartViewWrapper": { "type": "object", "required": [ "CartView" ], "properties": { "CartView": { "$ref": "#/components/schemas/CartView" } } }, "CartViewInput": { "description": "This class represents a cart view input.", "type": "object", "required": [ "identifier", "CartQuery" ], "properties": { "identifier": { "type": "string" }, "CartQuery": { "$ref": "#/components/schemas/CartViewInput" } } }, "CartViewInputWrapper": { "type": "object", "required": [ "CartViewInput" ], "properties": { "CartViewInput": { "$ref": "#/components/schemas/CartViewInput" } } }, "CartQuery": { "type": "object", "required": [ "offset", "limit", "ownerId" ], "properties": { "offset": { "type": "integer" }, "limit": { "type": "integer" }, "ownerId": { "type": "integer" } } }, "CartEntry": { "type": "object", "required": [ "identifier", "id", "names", "quantity", "Price" ], "properties": { "identifier": { "type": "string" }, "id": { "type": "integer" }, "names": { "type": "array", "items": { "type": "object" } }, "quantity": { "type": "integer" }, "Price": { "$ref": "#/components/schemas/Price" } } }, "CartEntryAdd": { "description": "This class represents a cart entry", "type": "object", "required": [ "quantity", "Product" ], "properties": { "quantity": { "description": "the quantity of entry items", "type": "integer" }, "Product": { "description": "product data" }, "context": { "description": "associative array of scalars describing additional, contextual data attached to the cart entry", "type": "object" } } }, "CartEntryAddWrapper": { "type": "object", "required": [ "CartEntryAdd" ], "properties": { "CartEntryAdd": { "$ref": "#/components/schemas/CartEntryAdd" } } }, "CartEntryUpdate": { "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "type": "integer" }, "context": { "description": "associative array of scalars describing additional, contextual data attached to the cart entry", "type": "object" } } }, "CartEntryUpdateWrapper": { "type": "object", "required": [ "CartEntryUpdate" ], "properties": { "CartEntryUpdate": { "$ref": "#/components/schemas/CartEntryUpdate" } } }, "CartMetadataUpdate": { "description": "This class represents the update of cart metadata.", "type": "object", "required": [ "identifier", "defaultLanguageCode", "names", "descriptions" ], "properties": { "identifier": { "type": "string" }, "defaultLanguageCode": { "type": "string" }, "names": { "type": "array", "items": { "$ref": "#/components/schemas/Value" } }, "descriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Value" } } } }, "CartMetadataUpdateWrapper": { "type": "object", "required": [ "CartMetadataUpdate" ], "properties": { "CartMetadataUpdate": { "$ref": "#/components/schemas/CartMetadataUpdate" } } }, "CartSummary": { "description": "This class represents a cart summary.", "type": "object", "required": [ "id", "identifier", "name", "createdAt", "updatedAt", "Owner", "SummaryEntryCollection", "TotalPrice", "TotalPriceInclVat", "vatCategorySummary", "Currency" ], "properties": { "id": { "type": "integer" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "Owner": { "$ref": "#/components/schemas/Ref" }, "SummaryEntryCollection": { "$ref": "#/components/schemas/SummaryEntryCollection" }, "TotalPrice": { "$ref": "#/components/schemas/RestPriceWrapper" }, "TotalPriceInclVat": { "$ref": "#/components/schemas/RestPriceWrapper" }, "vatCategorySummary": { "type": "array", "items": { "$ref": "#/components/schemas/VatCategorySummary" } }, "Currency": { "$ref": "#/components/schemas/Currency" } } }, "CartSummaryWrapper": { "type": "object", "required": [ "CartSummary" ], "properties": { "CartSummary": { "$ref": "#/components/schemas/CartSummary" } } }, "CartListViewResult": { "type": "object", "required": [ "count", "Result" ], "properties": { "count": { "type": "integer" }, "Result": { "$ref": "#/components/schemas/CartList" } } }, "SummaryEntryCollection": { "description": "This class represents a summary entry collection.", "type": "object", "required": [ "count", "SummaryEntry" ], "properties": { "count": { "type": "string" }, "SummaryEntry": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryEntry" } } } }, "ShoppingListEntryIdentifiers": { "description": "This class represents a list of shopping list entry identifiers to add to cart", "type": "object", "required": [ "entries" ], "properties": { "entries": { "description": "Array of entry identifiers", "type": "array", "items": { "type": "object", "required": [ "identifier" ], "properties": { "identifier": { "description": "Entry identifier", "type": "string" } } } } } }, "ShoppingListEntryIdentifiersWrapper": { "type": "object", "required": [ "ShoppingListEntryIdentifiers" ], "properties": { "ShoppingListEntryIdentifiers": { "$ref": "#/components/schemas/ShoppingListEntryIdentifiers" } } }, "CartEntryIdentifiers": { "description": "This class represents a list of cart entry identifiers", "type": "object", "required": [ "entries" ], "properties": { "entries": { "description": "Array of entry identifiers", "type": "array", "items": { "type": "object", "required": [ "identifier" ], "properties": { "identifier": { "description": "Entry identifier", "type": "string" } } } } } }, "CartEntryIdentifiersWrapper": { "type": "object", "required": [ "CartEntryIdentifiers" ], "properties": { "CartEntryIdentifiers": { "$ref": "#/components/schemas/CartEntryIdentifiers" } } }, "TimezoneDate": { "type": "object", "required": [ "date", "timezone_type", "timezone" ], "properties": { "date": { "type": "string" }, "timezone_type": { "type": "integer" }, "timezone": { "type": "string" } } }, "Order": { "description": "This class represents order.", "type": "object", "required": [ "id", "identifier", "created", "modified", "status", "OrderUser", "OrderCurrency", "OrderValue", "OrderItemsList", "context" ], "properties": { "id": { "type": "integer" }, "identifier": { "type": "string" }, "created": { "$ref": "#/components/schemas/TimezoneDate" }, "modified": { "$ref": "#/components/schemas/TimezoneDate" }, "status": { "type": "string" }, "source": { "type": "string" }, "OrderUser": { "$ref": "#/components/schemas/OrderUser" }, "OrderCurrency": { "$ref": "#/components/schemas/OrderCurrency" }, "OrderValue": { "$ref": "#/components/schemas/OrderValue" }, "OrderCompany": { "$ref": "#/components/schemas/OrderCompany" }, "OrderItemsList": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } }, "context": { "type": "object" } } }, "OrderWrapper": { "type": "object", "required": [ "Order" ], "properties": { "Order": { "$ref": "#/components/schemas/Order" } } }, "OrderList": { "description": "This class represents an orders list.", "type": "object", "required": [ "Order" ], "properties": { "Order": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } }, "OrderListWrapper": { "type": "object", "required": [ "OrderList" ], "properties": { "OrderList": { "$ref": "#/components/schemas/OrderList" } } }, "OrderUser": { "description": "This class represents order user.", "type": "object", "required": [ "id", "name", "email" ], "properties": { "id": { "type": [ "null", "integer" ] }, "name": { "type": "string" }, "email": { "type": "string" } } }, "OrderCurrency": { "description": "This class represents order currency.", "type": "object", "required": [ "id", "code" ], "properties": { "id": { "type": "integer" }, "code": { "type": "string" } } }, "OrderValue": { "description": "This class represents order value.", "type": "object", "required": [ "vat", "total_gross", "total_net" ], "properties": { "vat": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/OrderPrice" } ] }, "total_gross": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/OrderPrice" } ] }, "total_net": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/OrderPrice" } ] } } }, "OrderCompany": { "description": "This class represents order company.", "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "OrderPrice": { "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } } }, "OrderCreate": { "description": "This class is used to create order.", "type": "object", "required": [ "source", "OrderUser", "OrderCurrency", "OrderValue", "OrderCompany", "items" ], "properties": { "source": { "type": "string" }, "OrderUser": { "$ref": "#/components/schemas/OrderUser" }, "OrderCurrency": { "$ref": "#/components/schemas/OrderCurrency" }, "OrderValue": { "$ref": "#/components/schemas/OrderValue" }, "OrderCompany": { "$ref": "#/components/schemas/OrderCompany" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemWrapper" } } } }, "OrderCreateWrapper": { "type": "object", "required": [ "OrderCreate" ], "properties": { "OrderCreate": { "$ref": "#/components/schemas/OrderCreate" } } }, "OrderItem": { "description": "This class represents order item.", "type": "object", "required": [ "OrderItemValue", "OrderItemProduct" ], "properties": { "OrderItemValue": { "$ref": "#/components/schemas/OrderItemValue" }, "OrderItemProduct": { "$ref": "#/components/schemas/OrderItemProduct" }, "quantity": { "type": "integer" }, "context": { "type": "object" } } }, "OrderItemWrapper": { "type": "object", "required": [ "OrderItem" ], "properties": { "OrderItem": { "$ref": "#/components/schemas/OrderItem" } } }, "OrderItemValue": { "description": "This class represents order item value.", "type": "object", "required": [ "unit_price_gross", "unit_price_net", "vat_rate", "subtotal_price_gross", "subtotal_price_net" ], "properties": { "unit_price_gross": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/OrderPrice" } ] }, "unit_price_net": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/OrderPrice" } ] }, "vat_rate": { "type": "string" }, "subtotal_price_gross": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/OrderPrice" } ] }, "subtotal_price_net": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/OrderPrice" } ] } } }, "OrderItemProduct": { "description": "This class represents order item product.", "type": "object", "required": [ "id", "code", "name" ], "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "OrderUpdate": { "description": "This class is used to update order.", "type": "object", "required": [ "status", "transition" ], "properties": { "status": { "type": "string" }, "transition": { "type": "string" } } }, "OrderUpdateWrapper": { "type": "object", "required": [ "OrderUpdate" ], "properties": { "OrderUpdate": { "$ref": "#/components/schemas/OrderUpdate" } } }, "PaymentMethod": { "type": "object", "required": [ "id", "identifier", "enabled", "name", "description" ], "properties": { "id": { "type": "integer" }, "identifier": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "PaymentMethodWrapper": { "type": "object", "required": [ "PaymentMethod" ], "properties": { "PaymentMethod": { "$ref": "#/components/schemas/PaymentMethod" } } }, "PaymentMethodCreateStruct": { "type": "object", "required": [ "identifier", "type", "names" ], "properties": { "identifier": { "type": "string" }, "type": { "type": "string" }, "names": { "description": "If set this array of names with languageCode keys replace the complete name collection.", "type": "object" }, "descriptions": { "description": "An array of descriptions with languageCode keys.", "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "options": { "type": "object" } } }, "PaymentMethodCreateStructWrapper": { "type": "object", "required": [ "PaymentMethodCreateStruct" ], "properties": { "PaymentMethodCreateStruct": { "$ref": "#/components/schemas/PaymentMethodCreateStruct" } } }, "PaymentMethodUpdateStruct": { "type": "object", "properties": { "identifier": { "type": "string" }, "names": { "description": "If set this array of names with languageCode keys replace the complete name collection.", "type": "object" }, "descriptions": { "description": "An array of descriptions with languageCode keys.", "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "options": { "type": "array", "items": { "type": [] } } } }, "PaymentMethodUpdateStructWrapper": { "type": "object", "required": [ "PaymentMethodUpdateStructParser" ], "properties": { "PaymentMethodUpdateStructParser": { "$ref": "#/components/schemas/PaymentMethodUpdateStruct" } } }, "PaymentMethodView": { "type": "object", "required": [ "identifier", "Result" ], "properties": { "identifier": { "type": "string" }, "Result": { "$ref": "#/components/schemas/PaymentMethodList" } } }, "PaymentMethodViewWrapper": { "type": "object", "required": [ "PaymentMethodView" ], "properties": { "PaymentMethodView": { "$ref": "#/components/schemas/PaymentMethodView" } } }, "PaymentMethodViewInput": { "type": "object", "required": [ "identifier", "PaymentMethodQuery" ], "properties": { "identifier": { "type": "string" }, "PaymentMethodQuery": { "type": "object" } } }, "PaymentMethodViewInputWrapper": { "type": "object", "required": [ "PaymentMethodViewInput" ], "properties": { "PaymentMethodViewInput": { "$ref": "#/components/schemas/PaymentMethodViewInput" } } }, "PaymentMethodList": { "type": "object", "required": [ "count", "PaymentMethodList" ], "properties": { "count": { "type": "integer" }, "PaymentMethodList": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } }, "Shipment": { "description": "This class represents a single shipment.", "type": "object", "required": [ "id", "identifier", "status", "transitions", "Order", "Amount", "createdAt", "updatedAt", "Owner", "Method" ], "properties": { "id": { "type": "integer" }, "identifier": { "type": "string" }, "status": { "type": "string" }, "transitions": { "type": "object", "required": [ "transitionList" ], "properties": { "transitionList": { "description": "Next steps available in the shipment workflow for the current status", "type": "array", "items": { "type": "string" } } } }, "Order": { "$ref": "#/components/schemas/Ref" }, "Amount": { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "string" }, "currency": { "type": "string" } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "Owner": { "$ref": "#/components/schemas/Ref" }, "Method": { "$ref": "#/components/schemas/Ref" } } }, "ShipmentWrapper": { "type": "object", "required": [ "Shipment" ], "properties": { "Shipment": { "$ref": "#/components/schemas/Shipment" } } }, "ShipmentRefList": { "description": "This class represents a list of Shipments", "type": "object", "required": [ "shipmentRefList" ], "properties": { "shipmentRefList": { "type": "array", "items": { "$ref": "#/components/schemas/Ref" } } } }, "ShipmentRefListWrapper": { "type": "object", "required": [ "ShipmentRefList" ], "properties": { "ShipmentRefList": { "$ref": "#/components/schemas/ShipmentRefList" } } }, "ShipmentUpdate": { "description": "This class represents the update of a shipment.", "type": "object", "required": [ "identifier", "transition", "Owner", "Context" ], "properties": { "identifier": { "type": "string" }, "transition": { "type": "string" }, "Owner": { "$ref": "#/components/schemas/Ref" }, "Context": { "type": "object" } } }, "ShipmentUpdateWrapper": { "type": "object", "required": [ "ShipmentUpdate" ], "properties": { "ShipmentUpdate": { "$ref": "#/components/schemas/ShipmentUpdate" } } }, "ShipmentCreate": { "description": "This class represents the creation of a shipment.", "type": "object", "required": [ "identifier", "ShippingMethod", "Owner", "Context" ], "properties": { "identifier": { "type": "string" }, "ShippingMethod": { "$ref": "#/components/schemas/Ref" }, "Owner": { "$ref": "#/components/schemas/Ref" }, "Context": { "type": "object" } } }, "ShipmentCreateWrapper": { "type": "object", "required": [ "ShipmentCreate" ], "properties": { "ShipmentCreate": { "$ref": "#/components/schemas/ShipmentCreate" } } }, "ShippingMethod": { "description": "This class represents a shipping method.", "type": "object", "required": [ "identifier", "name", "names", "description", "descriptions", "enabled", "options", "regions", "type" ], "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "names": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/MultilingualValue" } } } }, "description": { "type": "string" }, "descriptions": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/MultilingualValue" } } } }, "enabled": { "type": "boolean" }, "options": { "type": "object", "required": [ "option" ], "properties": { "option": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValue" } } } }, "regions": { "type": "object", "required": [ "RegionRefList" ], "properties": { "RegionRefList": { "type": "array", "items": { "$ref": "#/components/schemas/Ref" } } } }, "type": { "$ref": "#/components/schemas/Ref" } } }, "ShippingMethodWrapper": { "type": "object", "required": [ "ShippingMethod" ], "properties": { "ShippingMethod": { "$ref": "#/components/schemas/ShippingMethod" } } }, "ShippingMethodType": { "description": "This class represents a shipping method type.", "type": "object", "required": [ "identifier", "name" ], "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "ShippingMethodTypeWrapper": { "type": "object", "required": [ "ShippingMethodType" ], "properties": { "ShippingMethodType": { "$ref": "#/components/schemas/ShippingMethodType" } } }, "ShippingMethodTypesList": { "description": "This class represents a list of shipping method types.", "type": "object", "required": [ "ShippingMethodTypes" ], "properties": { "ShippingMethodTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodType" } } } }, "ShippingMethodTypesListWrapper": { "type": "object", "required": [ "ShippingMethodTypesList" ], "properties": { "ShippingMethodTypesList": { "$ref": "#/components/schemas/ShippingMethodTypesList" } } }, "ShippingMethodRefList": { "description": "This class represents a list of shipping methods", "type": "object", "required": [ "ShippingMethodRefs" ], "properties": { "ShippingMethodRefs": { "type": "array", "items": { "$ref": "#/components/schemas/Ref" } } } }, "ShippingMethodRefListWrapper": { "type": "object", "required": [ "ShippingMethodRefList" ], "properties": { "ShippingMethodRefList": { "$ref": "#/components/schemas/ShippingMethodRefList" } } }, "ExampleSessionCreate": { "type": "object", "description": "Schema for creating a new collaboration session", "properties": { "ExampleSessionCreate": { "type": "object", "properties": { "Owner": { "$ref": "#/components/schemas/UserReference", "description": "Reference to the session owner" }, "ParticipantListCreate": { "$ref": "#/components/schemas/ParticipantListCreate", "description": "List of participants to add to the session" }, "subject": { "type": "string", "description": "Subject or title of the collaboration session" } }, "required": [ "Owner", "ParticipantListCreate", "subject" ] } }, "required": [ "ExampleSessionCreate" ], "additionalProperties": false }, "ExampleSessionUpdate": { "type": "object", "description": "Schema for updating a collaboration session", "properties": { "ExampleSessionUpdate": { "type": "object", "properties": { "hasPublicLink": { "type": "boolean", "description": "Whether the session should have a public access link enabled" } }, "required": [ "hasPublicLink" ] } }, "required": [ "ExampleSessionUpdate" ], "additionalProperties": false }, "InternalParticipantUpdate": { "type": "object", "description": "Schema for updating an internal participant", "properties": { "InternalParticipantUpdate": { "type": "object", "properties": { "scope": { "type": "string", "description": "Permission scope for the participant", "enum": [ "view", "edit", "admin" ] } }, "required": [ "scope" ] } }, "required": [ "InternalParticipantUpdate" ], "additionalProperties": false }, "ExternalParticipantUpdate": { "type": "object", "description": "Schema for updating an external participant", "properties": { "ExternalParticipantUpdate": { "type": "object", "properties": { "scope": { "type": "string", "description": "Permission scope for the participant", "enum": [ "view", "edit", "admin" ] } }, "required": [ "scope" ] } }, "required": [ "ExternalParticipantUpdate" ], "additionalProperties": false }, "InvitationCreate": { "type": "object", "description": "Schema for creating a new invitation", "properties": { "InvitationCreate": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address of the invitation recipient", "format": "email" }, "Sender": { "$ref": "#/components/schemas/UserReference", "description": "Reference to the user sending the invitation" }, "context": { "type": "object", "description": "Additional context information for the invitation", "properties": { "single_value": { "type": "string", "description": "A single context value" }, "simple_array": { "type": "array", "description": "An array of simple values", "items": { "type": "string" } }, "extended_array": { "type": "object", "description": "An object with key-value pairs", "additionalProperties": { "type": "string" } } }, "additionalProperties": true } }, "required": [ "email", "Sender", "context" ] } }, "required": [ "InvitationCreate" ], "additionalProperties": false }, "ParticipantListCreate": { "type": "object", "description": "Schema for creating a list of participants", "properties": { "ParticipantListCreate": { "type": "object", "properties": { "ParticipantCreate": { "type": "array", "description": "Array of participants to create", "items": { "oneOf": [ { "$ref": "#/components/schemas/InternalParticipantCreate" }, { "$ref": "#/components/schemas/ExternalParticipantCreate" } ] }, "minItems": 1 } }, "required": [ "ParticipantCreate" ] } }, "required": [ "ParticipantListCreate" ], "additionalProperties": false }, "InternalParticipantCreate": { "type": "object", "description": "Schema for creating an internal participant", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for internal participant creation", "enum": [ "application/vnd.ibexa.api.InternalParticipantCreate+json" ] }, "User": { "$ref": "#/components/schemas/UserReference", "description": "Reference to the user account" }, "scope": { "type": "string", "description": "Permission scope for the participant", "enum": [ "view", "edit", "admin" ] } }, "required": [ "_media-type", "User", "scope" ], "additionalProperties": false }, "ExternalParticipantCreate": { "type": "object", "description": "Schema for creating an external participant", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for external participant creation", "enum": [ "application/vnd.ibexa.api.ExternalParticipantCreate+json" ] }, "email": { "type": "string", "description": "Email address of the external participant", "format": "email" }, "scope": { "type": "string", "description": "Permission scope for the participant", "enum": [ "view", "edit", "admin" ] } }, "required": [ "_media-type", "email", "scope" ], "additionalProperties": false }, "UserReference": { "type": "object", "description": "Reference to a user resource", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for the user reference", "enum": [ "application/vnd.ibexa.api.User+json" ] }, "_href": { "type": "string", "description": "REST API URL reference to the user resource", "format": "uri", "pattern": "^/api/ibexa/v2/user/users/[0-9]+$" } }, "required": [ "_media-type", "_href" ], "additionalProperties": false }, "ExampleSessionWrapper": { "type": "object", "description": "Wrapper object containing a collaboration session", "properties": { "CollaborationSession": { "$ref": "#/components/schemas/CollaborationSession", "description": "The collaboration session object" } }, "required": [ "CollaborationSession" ], "additionalProperties": false }, "CollaborationSession": { "type": "object", "description": "A collaboration session representing a shared workspace for participants", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for the collaboration session" }, "id": { "type": "integer", "description": "Unique identifier of the collaboration session" }, "token": { "type": "string", "description": "Session access token for authentication and authorization" }, "ParticipantList": { "$ref": "#/components/schemas/ParticipantListObject", "description": "List of participants in the collaboration session" }, "Owner": { "$ref": "#/components/schemas/Owner", "description": "Owner of the collaboration session" }, "createdAt": { "type": "string", "description": "ISO 8601 timestamp when the session was created", "format": "date-time" }, "updatedAt": { "type": "string", "description": "ISO 8601 timestamp when the session was last updated", "format": "date-time" }, "subject": { "type": "string", "description": "Subject or title of the collaboration session" }, "isActive": { "type": "boolean", "description": "Whether the collaboration session is currently active" }, "hasPublicLink": { "type": "boolean", "description": "Whether the session has a public access link enabled" } }, "required": [ "_media-type", "id", "token", "ParticipantList", "Owner", "createdAt", "updatedAt", "subject" ], "additionalProperties": false }, "Owner": { "type": "object", "description": "Owner of a collaboration session", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for the owner" }, "_href": { "type": "string", "description": "REST API URL reference to the owner resource", "format": "uri" } }, "required": [ "_media-type", "_href" ], "additionalProperties": false }, "ExternalParticipantWrapper": { "type": "object", "description": "Wrapper object containing an external participant", "properties": { "Participant": { "$ref": "#/components/schemas/ExternalParticipant", "description": "The external participant object" } }, "required": [ "Participant" ], "additionalProperties": false }, "ExternalParticipant": { "type": "object", "description": "An external participant in a collaboration session (not a registered user)", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for the external participant" }, "id": { "type": "integer", "description": "Unique identifier of the participant" }, "name": { "type": "string", "description": "Display name of the external participant" }, "scope": { "type": "string", "description": "Permission scope for the participant (e.g., 'read', 'write', 'admin')" }, "email": { "type": "string", "description": "Email address of the external participant", "format": "email" }, "createdAt": { "type": "string", "description": "ISO 8601 timestamp when the participant was added", "format": "date-time" }, "updatedAt": { "type": "string", "description": "ISO 8601 timestamp when the participant was last updated", "format": "date-time" } }, "required": [ "_media-type", "id", "name", "scope", "email", "createdAt", "updatedAt" ], "additionalProperties": false }, "InternalParticipantWrapper": { "type": "object", "description": "Wrapper object containing an internal participant", "properties": { "Participant": { "$ref": "#/components/schemas/InternalParticipant", "description": "The internal participant object" } }, "required": [ "Participant" ], "additionalProperties": false }, "InternalParticipant": { "type": "object", "description": "An internal participant in a collaboration session (registered user)", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for the internal participant" }, "id": { "type": "integer", "description": "Unique identifier of the participant" }, "name": { "type": "string", "description": "Display name of the internal participant" }, "scope": { "type": "string", "description": "Permission scope for the participant (e.g., 'read', 'write', 'admin')" }, "User": { "$ref": "#/components/schemas/User", "description": "Reference to the associated user account" }, "createdAt": { "type": "string", "description": "ISO 8601 timestamp when the participant was added", "format": "date-time" }, "updatedAt": { "type": "string", "description": "ISO 8601 timestamp when the participant was last updated", "format": "date-time" } }, "required": [ "_media-type", "id", "name", "scope", "User", "createdAt", "updatedAt" ], "additionalProperties": false }, "ParticipantListWrapper": { "type": "object", "description": "Wrapper object containing a list of participants", "properties": { "ParticipantList": { "$ref": "#/components/schemas/ParticipantListObject", "description": "The participant list object" } }, "required": [ "ParticipantList" ], "additionalProperties": false }, "ParticipantListObject": { "type": "object", "description": "A list of participants in a collaboration session", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for the participant list" }, "Participants": { "type": "array", "description": "Array of participants in the collaboration session", "items": { "$ref": "#/components/schemas/ParticipantItem" } } }, "required": [ "_media-type", "Participants" ], "additionalProperties": false }, "ParticipantItem": { "type": "object", "description": "A participant item that can be either internal or external", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for the participant" }, "id": { "type": "integer", "description": "Unique identifier of the participant" }, "name": { "type": "string", "description": "Display name of the participant" }, "scope": { "type": "string", "description": "Permission scope for the participant (e.g., 'read', 'write', 'admin')" }, "User": { "$ref": "#/components/schemas/User", "description": "Reference to the associated user account (for internal participants only)" }, "email": { "type": "string", "description": "Email address of the participant (for external participants only)", "format": "email" }, "createdAt": { "type": "string", "description": "ISO 8601 timestamp when the participant was added", "format": "date-time" }, "updatedAt": { "type": "string", "description": "ISO 8601 timestamp when the participant was last updated", "format": "date-time" } }, "required": [ "_media-type", "id", "name", "scope", "createdAt", "updatedAt" ], "additionalProperties": false }, "InvitationWrapper": { "type": "object", "description": "Wrapper object containing an invitation", "properties": { "Invitation": { "$ref": "#/components/schemas/Invitation", "description": "The invitation object" } }, "required": [ "Invitation" ], "additionalProperties": false }, "Invitation": { "type": "object", "description": "An invitation to join a collaboration session", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for the invitation" }, "id": { "type": "integer", "description": "Unique identifier of the invitation" }, "status": { "type": "string", "description": "Current status of the invitation (e.g., 'pending', 'accepted', 'declined')", "enum": [ "pending", "accepted", "declined", "expired" ] }, "createdAt": { "type": "string", "description": "ISO 8601 timestamp when the invitation was created", "format": "date-time" }, "updatedAt": { "type": "string", "description": "ISO 8601 timestamp when the invitation was last updated", "format": "date-time" }, "context": { "oneOf": [ { "type": "array", "description": "Additional context data as an array" }, { "type": "object", "description": "Additional context data as an object" } ], "description": "Additional context information for the invitation" }, "Sender": { "$ref": "#/components/schemas/Sender", "description": "Reference to the user who sent the invitation" } }, "required": [ "_media-type", "id", "status", "createdAt", "updatedAt", "context", "Sender" ], "additionalProperties": false }, "Sender": { "type": "object", "description": "Reference to the sender of an invitation", "properties": { "_media-type": { "type": "string", "description": "Media type identifier for the sender reference" }, "_href": { "type": "string", "description": "REST API URL reference to the sender resource", "format": "uri" } }, "required": [ "_media-type", "_href" ], "additionalProperties": false }, "ActionType": { "type": "object", "required": [ "ActionType" ], "properties": { "ActionType": { "type": "object", "required": [ "_media-type", "identifier", "name", "inputIdentifier", "outputIdentifier", "options" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.ai.ActionType+json", "application/vnd.ibexa.api.ai.ActionType+xml" ] }, "identifier": { "type": "string" }, "name": { "type": "string" }, "inputIdentifier": { "type": "string" }, "outputIdentifier": { "type": "string" }, "options": { "type": "object", "additionalProperties": true } } } } }, "ActionTypeList": { "type": "object", "required": [ "_media-type", "_href", "ActionType" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.ai.ActionTypeList+json", "application/vnd.ibexa.api.ai.ActionTypeList+xml" ] }, "_href": { "type": "string", "enum": [ "/api/ibexa/v2/ai/action-types" ] }, "ActionType": { "type": "array", "items": { "$ref": "#/components/schemas/ActionType" } } } }, "ActionConfiguration": { "type": "object", "properties": { "ActionConfiguration": { "type": "object", "required": [ "_media-type", "identifier", "name", "description", "enabled", "ActionType", "actionTypeOptions", "actionHandlerIdentifier", "actionHandlerOptions", "createdAt", "updatedAt" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.ai.ActionConfiguration+json", "application/vnd.ibexa.api.ai.ActionConfiguration+xml" ] }, "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "ActionType": { "$ref": "#/components/schemas/ActionType" }, "actionTypeOptions": { "type": "object", "additionalProperties": true }, "actionHandlerIdentifier": { "type": "string" }, "actionHandlerOptions": { "type": "object", "additionalProperties": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } } } }, "ActionConfigurationList": { "type": "object", "required": [ "_media-type", "ActionConfiguration" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.ai.ActionConfigurationList+json", "application/vnd.ibexa.api.ai.ActionConfigurationList+xml" ] }, "_href": { "type": "string", "example": "/api/ibexa/v2/ai/actions" }, "ActionConfiguration": { "type": "array", "items": { "$ref": "#/components/schemas/ActionConfiguration" } } } }, "ActionConfigurationListInput": { "type": "object", "properties": { "query": { "type": "string" }, "action_type_identifier": { "type": "string" }, "enabled": { "type": "boolean" }, "limit": { "type": "integer" }, "page": { "type": "integer" } } }, "RuntimeContext": { "type": "object", "additionalProperties": true }, "Text": { "type": "object", "required": [ "_media-type", "text" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.ai.Text+json", "application/vnd.ibexa.api.ai.Text+xml" ] }, "text": { "type": "array", "items": { "type": "string" } } } }, "RefineText": { "type": "object", "required": [ "Text", "RuntimeContext" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.ai.RefineText+json", "application/vnd.ibexa.api.ai.RefineText+xml" ] }, "Text": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "array", "items": { "type": "string" } } } }, "RuntimeContext": { "$ref": "#/components/schemas/RuntimeContext" } } }, "GenerateAltText": { "type": "object", "required": [ "Image", "RuntimeContext" ], "properties": { "Image": { "type": "object", "required": [ "base64" ], "properties": { "base64": { "type": "string" } } }, "RuntimeContext": { "$ref": "#/components/schemas/RuntimeContext" } } }, "AltText": { "type": "object", "required": [ "_media-type", "Text" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.ai.AltText+json", "application/vnd.ibexa.api.ai.AltText+xml" ] }, "Text": { "type": "object", "required": [ "_media-type", "text" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.ai.Text+json", "application/vnd.ibexa.api.ai.Text+xml" ] }, "text": { "type": "array", "items": { "type": "string" } } } } } }, "DiscountList": { "type": "object", "required": [ "_media-type", "Discount" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.DiscountList+json" ] }, "Discount": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/Discount" } ] } } } }, "Discount": { "type": "object", "required": [ "id", "identifier", "name", "type", "label", "labelDescription", "priority", "isEnabled", "createdAt", "updatedAt", "startDate", "DiscountRule", "DiscountExpressionAware", "DiscountConditions", "DiscountTranslations" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.Discount+json" ] }, "id": { "type": "integer" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "required": true }, "label": { "type": "string", "nullable": true }, "labelDescription": { "type": "string", "nullable": true }, "priority": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "DiscountRule": { "$ref": "#/components/schemas/DiscountRule" }, "DiscountExpressionAware": { "$ref": "#/components/schemas/DiscountExpressionAware" }, "DiscountConditions": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountCondition" } }, "DiscountTranslations": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountTranslation" } } } }, "DiscountRule": { "type": "object", "required": [ "_media-type", "type", "expressionValues" ], "properties": { "_media-type": { "type": "string" }, "type": { "type": "string" }, "expressionValues": { "type": "object", "additionalProperties": true } } }, "DiscountExpressionAware": { "type": "object", "required": [ "_media-type", "expressionValues" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.DiscountExpressionAware+json" ] }, "expressionValues": { "type": "object", "additionalProperties": true } } }, "DiscountCondition": { "type": "object", "required": [ "_media-type", "identifier", "expressionValues" ], "properties": { "_media-type": { "type": "string" }, "identifier": { "type": "string" }, "expressionValues": { "type": "object", "additionalProperties": true } } }, "DiscountTranslation": { "type": "object", "required": [ "_media-type", "languageCode", "name", "description", "label", "labelDescription" ], "properties": { "_media-type": { "type": "string", "enum": [ "application/vnd.ibexa.api.DiscountTranslation+json" ] }, "languageCode": { "$ref": "#/components/schemas/Language" }, "name": { "type": "string" }, "description": { "type": "object", "nullable": true }, "label": { "type": "string", "nullable": true }, "labelDescription": { "type": "string", "nullable": true } } }, "DiscountCreate": { "type": "object", "required": [ "identifier", "type", "priority", "isEnabled", "userId", "rule", "translations" ], "properties": { "identifier": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "cart", "catalog" ] }, "priority": { "type": "integer", "minimum": 1, "maximum": 10 }, "isEnabled": { "type": "boolean" }, "userId": { "type": "integer" }, "rule": { "type": "object", "properties": { "type": { "type": "string", "required": true, "enum": [ "fixed_amount", "percentage" ] }, "amount": { "type": "string", "required": true } } }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "class": { "type": "string", "required": true, "description": "The fully qualified class name, must implement \\Ibexa\\Contracts\\Discounts\\Value\\DiscountConditionInterface" }, "parameters": { "type": "array", "required": true, "description": "A list of arguments for the given class constructor", "items": [] } } } }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "translations": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "languageCode", "name" ], "properties": { "languageCode": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "labelDescription": { "type": "string" } } } }, "context": { "type": "object", "additionalProperties": true } } }, "DiscountUpdate": { "type": "object", "required": [ "identifier" ], "properties": { "identifier": { "type": "string", "minLength": 1 }, "priority": { "type": "integer", "minimum": 1, "maximum": 10 }, "isEnabled": { "type": "boolean" }, "userId": { "type": "integer" }, "lastContributorId": { "type": "integer" }, "rule": { "type": "object", "required": [ "type", "amount" ], "properties": { "type": { "type": "string", "enum": [ "fixed_amount", "percentage" ] }, "amount": { "type": "string" } } }, "conditions": { "type": "array", "items": { "type": "object", "required": [ "class", "parameters" ], "properties": { "class": { "type": "string", "description": "The fully qualified class name, must implement \\Ibexa\\Contracts\\Discounts\\Value\\DiscountConditionInterface" }, "parameters": { "type": "array", "description": "A list of arguments for the given class constructor", "items": [] } } } }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "translations": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "languageCode", "name" ], "properties": { "languageCode": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "labelDescription": { "type": "string" } } } }, "context": { "type": "object", "additionalProperties": true } } }, "DiscountCode": { "type": "object", "required": [ "code" ], "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "created_at": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "timezone_type": { "type": "integer" }, "timezone": { "type": "string" } } } } }, "DiscountCodeWrapper": { "type": "object", "required": [ "DiscountCode" ], "properties": { "DiscountCode": { "$ref": "#/components/schemas/DiscountCode" } } }, "ShoppingList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { "description": "This class represents a shopping list in the Repository.", "type": "object", "required": [ "id", "identifier", "owner", "entries", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique shopping list ID.", "type": "integer" }, "identifier": { "description": "The unique identifier (UUID) of the shopping list.", "type": "string" }, "name": { "description": "The name of the shopping list (optional).", "type": "string", "nullable": true }, "isDefault": { "description": "Indicates if this is the user's default shopping list.", "type": "boolean" }, "owner": { "description": "Reference to the user who owns this shopping list.", "$ref": "#/components/schemas/Ref" }, "entries": { "description": "Array of shopping list entries.", "type": "array", "items": { "$ref": "#/components/schemas/ShoppingListEntry" } }, "createdAt": { "description": "The date and time when the shopping list was created.", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date and time when the shopping list was last updated.", "type": "string", "format": "date-time" } } } ] }, "ShoppingListWrapper": { "type": "object", "required": [ "ShoppingList" ], "properties": { "ShoppingList": { "$ref": "#/components/schemas/ShoppingList" } } }, "ShoppingListEntry": { "description": "This class represents an entry in a shopping list.", "type": "object", "required": [ "identifier", "product", "addedAt" ], "properties": { "identifier": { "description": "The unique identifier (UUID) of the entry.", "type": "string", "format": "uuid" }, "product": { "description": "Reference to the product with embedded details.", "type": "object", "required": [ "_href", "_media-type", "code", "name" ], "properties": { "_href": { "description": "URI to the product resource.", "type": "string" }, "_media-type": { "description": "Media type of the product resource.", "type": "string" }, "code": { "description": "Product code.", "type": "string" }, "name": { "description": "Product name.", "type": "string" } } }, "addedAt": { "description": "The date and time when the entry was added.", "type": "string", "format": "date-time" } } }, "ShoppingListCreate": { "description": "Creates a new shopping list.", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The name of the shopping list (required).", "type": "string" } } }, "ShoppingListCreateWrapper": { "type": "object", "required": [ "ShoppingListCreate" ], "properties": { "ShoppingListCreate": { "$ref": "#/components/schemas/ShoppingListCreate" } } }, "ShoppingListUpdate": { "description": "Updates an existing shopping list.", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The name of the shopping list (required).", "type": "string" } } }, "ShoppingListUpdateWrapper": { "type": "object", "required": [ "ShoppingListUpdate" ], "properties": { "ShoppingListUpdate": { "$ref": "#/components/schemas/ShoppingListUpdate" } } }, "ShoppingListEntriesAdd": { "description": "Adds one or more product entries to an existing shopping list.", "type": "object", "required": [ "entries" ], "properties": { "entries": { "description": "Array of entries to add (required, min 1).", "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/ShoppingListEntryAdd" } } } }, "ShoppingListEntriesAddWrapper": { "type": "object", "required": [ "ShoppingListEntriesAdd" ], "properties": { "ShoppingListEntriesAdd": { "$ref": "#/components/schemas/ShoppingListEntriesAdd" } } }, "ShoppingListEntriesRemove": { "description": "Removes one or more entries from a shopping list by their identifiers.", "type": "object", "required": [ "identifiers" ], "properties": { "identifiers": { "description": "Array of entry identifiers (UUIDs) to remove (required, min 1).", "type": "array", "minItems": 1, "items": { "type": "string", "format": "uuid" } } } }, "ShoppingListEntriesRemoveWrapper": { "type": "object", "required": [ "ShoppingListEntriesRemove" ], "properties": { "ShoppingListEntriesRemove": { "$ref": "#/components/schemas/ShoppingListEntriesRemove" } } }, "ShoppingListEntryAdd": { "description": "Represents a single entry to add to a shopping list.", "type": "object", "required": [ "productCode" ], "properties": { "productCode": { "description": "Product code (required).", "type": "string" } } }, "ShoppingListCollection": { "description": "This class represents a collection of shopping lists.", "type": "object", "required": [ "totalCount", "count", "ShoppingList" ], "properties": { "totalCount": { "description": "Total number of shopping lists.", "type": "integer" }, "count": { "description": "Number of shopping lists in this response.", "type": "integer" }, "ShoppingList": { "description": "Array of shopping lists.", "type": "array", "items": { "$ref": "#/components/schemas/ShoppingList" } } } }, "ShoppingListCollectionWrapper": { "type": "object", "required": [ "ShoppingListCollection" ], "properties": { "ShoppingListCollection": { "$ref": "#/components/schemas/ShoppingListCollection" } } } }, "responses": [], "parameters": [], "examples": [], "requestBodies": [], "headers": [], "securitySchemes": [] }, "security": [], "tags": [ { "name": "Section" }, { "name": "Objects" }, { "name": "Type Groups" }, { "name": "Type" }, { "name": "User" }, { "name": "User Group" }, { "name": "User Role" }, { "name": "User Policy" }, { "name": "Language" }, { "name": "Location" }, { "name": "Object State Groups" }, { "name": "Trash" }, { "name": "Url Wildcard" }, { "name": "Url Alias" }, { "name": "Views", "description": "Controller for Repository Views (Search, mostly)." }, { "name": "User Session" }, { "name": "Bookmark" }, { "name": "User Token" }, { "name": "Calendar" }, { "name": "Product Attribute" }, { "name": "Product Attribute Type" }, { "name": "Product Attribute Group" }, { "name": "Product Catalog" }, { "name": "Product Currency" }, { "name": "Product Customer Group" }, { "name": "Product" }, { "name": "Product Type" }, { "name": "Product Variant" }, { "name": "Product Region" }, { "name": "Product Vat" }, { "name": "Taxonomy" }, { "name": "Segmentation" }, { "name": "Corporate Account" }, { "name": "Activity Log" }, { "name": "Cart" }, { "name": "Shopping List" }, { "name": "Orders" }, { "name": "Payments" }, { "name": "Shipping" }, { "name": "Collaboration Sessions" }, { "name": "Connector AI" }, { "name": "Discounts" } ], "webhooks": [] }